# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Adobe Workfront Favorite API
  version: 1.0.0
extends: openapi/adobe-suite-favorite-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: 8
- target: $.paths['/favorite/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one favorite
      effect: read
      questions:
      - How do I see a single item I marked as a favorite in Workfront?
      - Can I choose which fields come back for one favorite?
      instructions:
      - text: Show favorite {id}.
        slots:
          id: path.id
      - text: Get favorite {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one favorite
      effect: destructive
      questions:
      - Can I unfavorite a single item?
      - Is there a force flag when deleting one favorite?
      instructions:
      - text: Delete favorite {id}.
        slots:
          id: path.id
      - text: Remove favorite {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several favorites by ID
      effect: read
      questions:
      - Can I retrieve multiple favorites in one call by their IDs?
      - Which call returns a batch of known favorites?
      instructions:
      - text: Fetch favorites {id}.
        slots:
          id: query.id
      - text: Get the favorites {id} showing only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an item to favorites
      effect: write
      questions:
      - How do I mark a project or task as a favorite?
      - What do I send to create a favorite?
      instructions:
      - text: Add the item I name to my favorites.
      - text: Create a favorite and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove many favorites at once
      effect: destructive
      questions:
      - Can I bulk remove favorites by listing their IDs?
      - What clears several favorites in a single call?
      instructions:
      - text: Bulk delete favorites {id}.
        slots:
          id: query.id
      - text: Remove every favorite in {id} using force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count favorites
      effect: read
      questions:
      - How many favorites match a given filter?
      - Can I get just the total number of favorites?
      instructions:
      - text: Count favorites where {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many favorites are saved.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search favorites
      effect: read
      questions:
      - What's the way to find favorites by object type or owner?
      - Can I search favorites with paging and sorting?
      instructions:
      - text: Search favorites matching {filters}.
        slots:
          filters: query.filters
      - text: Find favorites where {filters} and list {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/favorite/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on favorites
      effect: read
      questions:
      - Can I get grouped totals of favorites as a report?
      - Which call gives a report-style summary of favorites?
      instructions:
      - text: Run a favorites report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Summarize favorites as a report with {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'