Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Initiative API

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

$.info

$.paths['/initiative/{id}'].get

$.paths['/initiative'].get

$.paths['/initiative/count'].get

$.paths['/initiative/search'].get

$.paths['/initiative/report'].get

OpenAPI Overlay

# 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 Initiative API
  version: 1.0.0
extends: openapi/adobe-suite-initiative-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: 5
- target: $.paths['/initiative/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one initiative
      effect: read
      questions:
      - How do I look up a single Workfront initiative by ID?
      - Can I return only certain fields for one initiative?
      instructions:
      - text: Get initiative {id}.
        slots:
          id: path.id
      - text: Fetch initiative {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/initiative'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several initiatives by ID
      effect: read
      questions:
      - Can I fetch multiple initiatives at once using their IDs?
      - What's the way to pull a known set of initiatives in one call?
      instructions:
      - text: Get initiatives {ids}.
        slots:
          ids: query.id
      - text: Bulk-fetch initiatives {ids} with fields {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/initiative/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count initiatives
      effect: read
      questions:
      - How many initiatives are there in our planning?
      - Can I count only initiatives matching a filter?
      instructions:
      - text: Count all initiatives.
      - text: Count initiatives matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/initiative/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search initiatives
      effect: read
      questions:
      - Which initiatives match a name or status I'm looking for?
      - Can I sort and page initiative search results?
      instructions:
      - text: Search initiatives where {filters}.
        slots:
          filters: query.filters
      - text: Search initiatives for {filters} with {listOptions} and fields {fields}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/initiative/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report on initiatives
      effect: read
      questions:
      - Can I get a grouped summary report of initiatives?
      - What's the way to aggregate initiatives by some field?
      instructions:
      - text: Run an initiative report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build an initiative report for {filters} with {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'