Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Financialdata API

6 actions 6 updates phrasing extends openapi/adobe-suite-financial-data-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['/financialdata/{id}'].get
$.paths['/financialdata'].get
$.paths['/financialdata/count'].get
$.paths['/financialdata/search'].get
$.paths['/financialdata/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 Financialdata API
  version: 1.0.0
extends: openapi/adobe-suite-financial-data-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/financialdata/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one financial data record
      effect: read
      questions:
      - What planned and actual figures does a specific financial data record hold?
      - Can I retrieve one financial data entry by ID?
      instructions:
      - text: Get financial data record {id}.
        slots:
          id: path.id
      - text: Show financial data {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/financialdata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several financial data records by ID
      effect: read
      questions:
      - Can I fetch multiple financial data records in one call?
      - How do I look up a batch of financial data entries?
      instructions:
      - text: Get financial data records {id}.
        slots:
          id: query.id
      - text: Fetch financial data {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/financialdata/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count financial data records
      effect: read
      questions:
      - How many financial data records are there?
      - Can I count financial data rows matching a filter?
      instructions:
      - text: Count the financial data records.
      - text: Count financial data matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/financialdata/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search financial data
      effect: read
      questions:
      - How do I find financial data for a given project or period?
      - Can I search and page financial data records?
      instructions:
      - text: Search financial data matching {filters}.
        slots:
          filters: query.filters
      - text: Find financial data matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/financialdata/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on financial data
      effect: read
      questions:
      - Can I get aggregated totals of financial data grouped by project?
      - What financial report can I produce from project financial data?
      instructions:
      - text: Run a financial data report.
      - text: Report on financial data filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-10-01'