Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Endorsementshare API

9 actions 9 updates phrasing extends openapi/adobe-suite-endorsementshare-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Adobe Suite's API. It is a proposal applied on top of the contract, not a document Adobe Suite publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info
$.paths['/endorsementshare/{id}'].get
$.paths['/endorsementshare/{id}'].delete
$.paths['/endorsementshare'].get
$.paths['/endorsementshare'].post
$.paths['/endorsementshare'].delete
$.paths['/endorsementshare/count'].get
$.paths['/endorsementshare/search'].get
$.paths['/endorsementshare/report'].get

OpenAPI Overlay

Raw ↑
# 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 Endorsementshare API
  version: 1.0.0
extends: openapi/adobe-suite-endorsementshare-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['/endorsementshare/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an endorsement share
      effect: read
      questions:
      - Who was an endorsement shared with in Workfront?
      - Can I fetch selected fields of one endorsement share?
      instructions:
      - text: Show endorsement share {id}.
        slots:
          id: path.id
      - text: Get fields {fields} of endorsement share {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an endorsement share
      effect: destructive
      questions:
      - How do I remove a single endorsement share?
      - Can I force-delete one endorsement share?
      instructions:
      - text: Delete endorsement share {id}.
        slots:
          id: path.id
      - text: Force-delete endorsement share {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several endorsement shares by ID
      effect: read
      questions:
      - Can I load multiple endorsement shares at once by ID?
      - What's the batch lookup for endorsement shares?
      instructions:
      - text: Get endorsement shares {id}.
        slots:
          id: query.id
      - text: Fetch fields {fields} for endorsement shares {id}.
        slots:
          fields: query.fields
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare'].post
  update:
    x-apievangelist-phrasing:
      intent: Share an endorsement
      effect: write
      questions:
      - How do I share an endorsement with someone in Workfront?
      - Can I create an endorsement share and choose the fields returned?
      instructions:
      - text: Create a new endorsement share.
      - text: Add an endorsement share and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete endorsement shares
      effect: destructive
      questions:
      - Can I remove many endorsement shares in one call?
      - What happens with force when bulk deleting endorsement shares?
      instructions:
      - text: Delete endorsement shares {id}.
        slots:
          id: query.id
      - text: Bulk delete endorsement shares {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count endorsement shares
      effect: read
      questions:
      - How many endorsement shares exist?
      - Can I count endorsement shares that match a filter?
      instructions:
      - text: Count all endorsement shares.
      - text: Count endorsement shares matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search endorsement shares
      effect: read
      questions:
      - Which endorsement shares match certain conditions?
      - Can I search endorsement shares and page through results?
      instructions:
      - text: Search endorsement shares where {filters}.
        slots:
          filters: query.filters
      - text: Find endorsement shares matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/endorsementshare/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on endorsement shares
      effect: read
      questions:
      - Can I get a grouped report of endorsement shares?
      - What does an endorsement share report summarize?
      instructions:
      - text: Run an endorsement share report for {filters}.
        slots:
          filters: query.filters
      - text: Build a report over endorsement shares using {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'