Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Parametergroup API

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

$.info
$.paths['/parametergroup/{id}'].get
$.paths['/parametergroup/{id}'].put
$.paths['/parametergroup/{id}'].delete
$.paths['/parametergroup'].get
$.paths['/parametergroup'].put
$.paths['/parametergroup'].post
$.paths['/parametergroup'].delete
$.paths['/parametergroup/count'].get
$.paths['/parametergroup/search'].get
$.paths['/parametergroup/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 Parametergroup API
  version: 1.0.0
extends: openapi/adobe-suite-parametergroup-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['/parametergroup/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one parameter group
      effect: read
      questions:
      - How do I read a single custom field parameter group in Workfront?
      - Can I choose fields when fetching one parameter group?
      instructions:
      - text: Show parameter group {id}.
        slots:
          id: path.id
      - text: Get parameter group {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a parameter group
      effect: write
      questions:
      - Can I rename or change an existing parameter group?
      - How do I edit one parameter group by ID?
      instructions:
      - text: Update parameter group {id}.
        slots:
          id: path.id
      - text: Edit parameter group {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a parameter group
      effect: destructive
      questions:
      - How do I delete a parameter group?
      - Can I force-delete a parameter group that is still referenced?
      instructions:
      - text: Delete parameter group {id}.
        slots:
          id: path.id
      - text: Delete parameter group {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several parameter groups by ID
      effect: read
      questions:
      - Can I load a batch of parameter groups by their IDs?
      - Is there a bulk get for parameter groups?
      instructions:
      - text: Fetch parameter groups {id}.
        slots:
          id: query.id
      - text: Bulk-load parameter groups {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk update parameter groups
      effect: write
      questions:
      - How do I edit many parameter groups in one request?
      - Can I apply the same change across several parameter groups?
      instructions:
      - text: Bulk-edit parameter groups.
      - text: Apply a batch update to parameter groups and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a parameter group
      effect: write
      questions:
      - How do I create a new parameter group for custom fields?
      - Can I add a parameter group through the API?
      instructions:
      - text: Create a parameter group.
      - text: Add a new parameter group and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete parameter groups
      effect: destructive
      questions:
      - Can I delete several parameter groups at once?
      - How do I remove a batch of parameter groups by ID?
      instructions:
      - text: Delete parameter groups {id}.
        slots:
          id: query.id
      - text: Bulk-delete parameter groups {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count parameter groups
      effect: read
      questions:
      - How many parameter groups match a filter?
      - Can I get only a count of parameter groups?
      instructions:
      - text: Count parameter groups matching {filters}.
        slots:
          filters: query.filters
      - text: Tell me how many parameter groups exist.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search parameter groups
      effect: read
      questions:
      - What's the way to search parameter groups by name or other fields?
      - Can I page through parameter group search results?
      instructions:
      - text: Search parameter groups where {filters}.
        slots:
          filters: query.filters
      - text: Find parameter groups matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/parametergroup/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on parameter groups
      effect: read
      questions:
      - Can I produce a grouped report over parameter groups?
      - How do I aggregate parameter groups by a field?
      instructions:
      - text: Run a parameter group report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a parameter group report with options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'