# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Account Favorites API
  version: 1.0.0
extends: openapi/harness-account-favorites-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v1/favorites'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a resource as a user's favorite
      effect: write
      questions:
      - How do I star a pipeline or project as a favorite for a user?
      - Can I save a favorite resource for a specific module?
      instructions:
      - text: Favorite {resource_type} {resource} for user {user}.
        slots:
          resource_type: requestBody.resource_type
          resource: requestBody.resource_id
          user: requestBody.user_id
      - text: Add {resource} in module {module} to user {user}'s favorites.
        slots:
          resource: requestBody.resource_id
          module: requestBody.module
          user: requestBody.user_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/favorites/{user-id}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's favorite resources
      effect: read
      questions:
      - Which resources has a user marked as favorites?
      - Can I list only one type of favorite, like pipelines?
      instructions:
      - text: List the favorites of user {user}.
        slots:
          user: path.user-id
      - text: Show user {user}'s favorite {resource_type} resources.
        slots:
          user: path.user-id
          resource_type: query.resource_type
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/favorites/{user-id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a resource from a user's favorites
      effect: destructive
      questions:
      - How do I unfavorite a resource for a user?
      - Can I clear a user's favorite of a given type?
      instructions:
      - text: Remove {resource} from user {user}'s favorites.
        slots:
          resource: query.resource_id
          user: path.user-id
      - text: Unfavorite {resource_type} {resource} for user {user}.
        slots:
          resource_type: query.resource_type
          resource: query.resource_id
          user: path.user-id
      method: generated
      generated: '2026-09-26'