Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Avatar API

8 actions 8 updates phrasing extends openapi/adobe-suite-avatar-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 8

$.info
$.paths['/avatar/{id}'].get
$.paths['/avatar/{id}'].put
$.paths['/avatar/{id}'].delete
$.paths['/avatar'].get
$.paths['/avatar'].put
$.paths['/avatar'].post
$.paths['/avatar'].delete

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 Avatar API
  version: 1.0.0
extends: openapi/adobe-suite-avatar-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: 7
- target: $.paths['/avatar/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one avatar
      effect: read
      questions:
      - How do I fetch a single avatar record in Workfront?
      - Can I pick fields when reading one avatar?
      instructions:
      - text: Show avatar {id}.
        slots:
          id: path.id
      - text: Get avatar {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/avatar/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an avatar
      effect: write
      questions:
      - Can I change an existing avatar?
      - How do I edit one avatar by ID?
      instructions:
      - text: Update avatar {id}.
        slots:
          id: path.id
      - text: Edit avatar {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/avatar/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an avatar
      effect: destructive
      questions:
      - How do I delete an avatar?
      - Can I force-delete an avatar record?
      instructions:
      - text: Delete avatar {id}.
        slots:
          id: path.id
      - text: Delete avatar {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/avatar'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several avatars by ID
      effect: read
      questions:
      - Can I load multiple avatars at once by their IDs?
      - Is there a bulk get for avatars?
      instructions:
      - text: Fetch avatars {id}.
        slots:
          id: query.id
      - text: Bulk-load avatars {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/avatar'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update avatars
      effect: write
      questions:
      - How do I edit many avatars in one request?
      - Can I apply a batch change to avatars?
      instructions:
      - text: Bulk-edit avatars.
      - text: Apply a batch update to avatars and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/avatar'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an avatar
      effect: write
      questions:
      - How do I create a new avatar?
      - Can I add an avatar record through the API?
      instructions:
      - text: Create an avatar.
      - text: Add a new avatar and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/avatar'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete avatars
      effect: destructive
      questions:
      - Can I delete several avatars at once?
      - How do I remove a batch of avatars by ID?
      instructions:
      - text: Delete avatars {id}.
        slots:
          id: query.id
      - text: Bulk-delete avatars {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'