Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Uitemplate API

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

$.info
$.paths['/uitemplate/{id}'].get
$.paths['/uitemplate/{id}'].delete
$.paths['/uitemplate'].get
$.paths['/uitemplate'].delete
$.paths['/uitemplate/count'].get
$.paths['/uitemplate/search'].get
$.paths['/uitemplate/report'].get
$.paths['/uitemplate/migrateCustomersAllLayoutTemplates'].put
$.paths['/uitemplate/migrateLayoutTemplates'].put

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 Uitemplate API
  version: 1.0.0
extends: openapi/adobe-suite-uitemplate-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: 9
- target: $.paths['/uitemplate/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one layout template
      effect: read
      questions:
      - What does a specific layout template contain?
      - Can I retrieve a single UI template by ID?
      instructions:
      - text: Get layout template {id}.
        slots:
          id: path.id
      - text: Show UI template {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a layout template
      effect: destructive
      questions:
      - How do I delete one UI layout template?
      - Can I force delete a template still assigned to users?
      instructions:
      - text: Delete UI template {id}.
        slots:
          id: path.id
      - text: Force delete layout template {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several layout templates by ID
      effect: read
      questions:
      - Can I fetch multiple UI templates in one request?
      - How do I look up a batch of layout templates by their IDs?
      instructions:
      - text: Get UI templates {id}.
        slots:
          id: query.id
      - text: Fetch layout templates {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several layout templates
      effect: destructive
      questions:
      - Can I bulk delete UI templates?
      - How do I remove many layout templates by ID at once?
      instructions:
      - text: Delete UI templates {id}.
        slots:
          id: query.id
      - text: Bulk delete layout templates {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count layout templates
      effect: read
      questions:
      - How many UI templates are defined?
      - Can I count layout templates matching a filter?
      instructions:
      - text: Count the UI templates.
      - text: Count layout templates matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search layout templates
      effect: read
      questions:
      - How do I find UI templates by name?
      - Can I search and sort layout templates?
      instructions:
      - text: Search UI templates matching {filters}.
        slots:
          filters: query.filters
      - text: Find layout templates matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on layout templates
      effect: read
      questions:
      - Can I get an aggregated report of UI templates?
      - What grouped view of layout templates can I produce?
      instructions:
      - text: Run a UI template report.
      - text: Report on layout templates filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate/migrateCustomersAllLayoutTemplates'].put
  update:
    x-apievangelist-phrasing:
      intent: Migrate all legacy layout templates
      effect: write
      questions:
      - How do I migrate every legacy layout template to the new experience?
      - Can I convert all of my organization's layout templates at once?
      instructions:
      - text: Migrate all layout templates.
      - text: Migrate all layout templates with overrideIfExists {overrideIfExists}.
        slots:
          overrideIfExists: query.overrideIfExists
      method: generated
      generated: '2026-09-26'
- target: $.paths['/uitemplate/migrateLayoutTemplates'].put
  update:
    x-apievangelist-phrasing:
      intent: Migrate selected layout templates
      effect: write
      questions:
      - Can I migrate only certain layout templates to UI templates?
      - Does migrating specific templates overwrite ones already converted?
      instructions:
      - text: Migrate layout templates {layoutTemplateIDs}.
        slots:
          layoutTemplateIDs: query.layoutTemplateIDs
      - text: 'Migrate templates {layoutTemplateIDs} and override existing ones: {overrideIfExists}.'
        slots:
          layoutTemplateIDs: query.layoutTemplateIDs
          overrideIfExists: query.overrideIfExists
      method: generated
      generated: '2026-09-26'