Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Contextsensitivehelp API

6 actions 6 updates phrasing extends openapi/adobe-suite-contextsensitivehelp-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['/contextsensitivehelp/{id}'].get
$.paths['/contextsensitivehelp'].get
$.paths['/contextsensitivehelp/count'].get
$.paths['/contextsensitivehelp/search'].get
$.paths['/contextsensitivehelp/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 Contextsensitivehelp API
  version: 1.0.0
extends: openapi/adobe-suite-contextsensitivehelp-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['/contextsensitivehelp/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one context-sensitive help entry
      effect: read
      questions:
      - How do I look up a single Workfront context-sensitive help entry by ID?
      - Can I choose which fields return for one help entry?
      instructions:
      - text: Get context-sensitive help entry {id}.
        slots:
          id: path.id
      - text: Fetch help entry {id} with only the fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contextsensitivehelp'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several help entries by ID
      effect: read
      questions:
      - Can I fetch a batch of context-sensitive help entries by their IDs?
      - What's the way to load multiple help entries together?
      instructions:
      - text: Get the context-sensitive help entries {ids}.
        slots:
          ids: query.id
      - text: Bulk-fetch help entries {ids} returning {fields}.
        slots:
          ids: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contextsensitivehelp/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count context-sensitive help entries
      effect: read
      questions:
      - How many context-sensitive help entries are there?
      - Can I count only help entries matching a filter?
      instructions:
      - text: Count all context-sensitive help entries.
      - text: Tell me how many help entries match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contextsensitivehelp/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search context-sensitive help entries
      effect: read
      questions:
      - Which help entries match certain conditions?
      - Can a context-sensitive help search be sorted or paged?
      instructions:
      - text: Search context-sensitive help matching {filters}.
        slots:
          filters: query.filters
      - text: Find help entries where {filters}, returning {fields} with list options {listOptions}.
        slots:
          filters: query.filters
          fields: query.fields
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/contextsensitivehelp/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on context-sensitive help
      effect: read
      questions:
      - Can I produce an aggregated report of context-sensitive help entries?
      - What report data can I pull on help entries filtered by conditions?
      instructions:
      - text: Run a context-sensitive help report filtered by {filters}.
        slots:
          filters: query.filters
      - text: Build a help entries report with list options {listOptions}.
        slots:
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'