# 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 Endorsement API
  version: 1.0.0
extends: openapi/adobe-suite-endorsement-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: 10
- target: $.paths['/endorsement/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endorsement by ID
      effect: read
      questions:
      - Who gave a particular endorsement in Workfront and what did it say?
      - Can I choose which fields to return for one endorsement?
      instructions:
      - text: Show me endorsement {id}.
        slots:
          id: path.id
      - text: Get endorsement {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endorsement
      effect: destructive
      questions:
      - How do I remove an endorsement I gave by mistake?
      - Does force matter when deleting one endorsement?
      instructions:
      - text: Delete endorsement {id}.
        slots:
          id: path.id
      - text: Force-delete endorsement {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several endorsements by their IDs
      effect: read
      questions:
      - Can I load several endorsements in one request?
      - What's the call for fetching endorsements from a list of IDs?
      instructions:
      - text: Get endorsements {id}.
        slots:
          id: query.id
      - text: Load endorsements {id} together, returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement'].post
  update:
    x-apievangelist-phrasing:
      intent: Endorse a colleague
      effect: write
      questions:
      - How do I give a teammate an endorsement for their work?
      - Can I create an endorsement through the API?
      instructions:
      - text: Create an endorsement for this colleague with my message.
      - text: Add a new endorsement and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several endorsements at once
      effect: destructive
      questions:
      - Can I remove a batch of endorsements together?
      - What does force do on a bulk endorsement delete?
      instructions:
      - text: Delete endorsements {id} in bulk.
        slots:
          id: query.id
      - text: Force-remove endorsements {id}, force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count endorsements
      effect: read
      questions:
      - How many endorsements have been given in total?
      - Can I count endorsements received by one person?
      instructions:
      - text: Count all endorsements.
      - text: Count endorsements matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search endorsements
      effect: read
      questions:
      - How do I find endorsements given to a particular user?
      - Can I page through endorsement search results?
      instructions:
      - text: Search endorsements where {filters}.
        slots:
          filters: query.filters
      - text: Find endorsements matching {filters}, returning {fields} with list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over endorsements
      effect: read
      questions:
      - Can I get endorsement counts grouped by recipient?
      - Which call gives aggregated report output for endorsements?
      instructions:
      - text: Run an endorsement report for {filters}.
        slots:
          filters: query.filters
      - text: Build an endorsements report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement/like'].put
  update:
    x-apievangelist-phrasing:
      intent: Like an endorsement
      effect: write
      questions:
      - Can I like an endorsement someone else gave?
      - How do I add my like to a colleague's endorsement?
      instructions:
      - text: Like endorsement {ID}.
        slots:
          ID: query.ID
      - text: Add my like to endorsement {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsement/unlike'].put
  update:
    x-apievangelist-phrasing:
      intent: Remove my like from an endorsement
      effect: write
      questions:
      - Can I take back a like I put on an endorsement?
      - What undoes liking an endorsement?
      instructions:
      - text: Unlike endorsement {ID}.
        slots:
          ID: query.ID
      - text: Remove my like from endorsement {ID}.
        slots:
          ID: query.ID
      method: generated
      generated: '2026-09-26'