Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Burndownevent API

6 actions 6 updates phrasing extends openapi/adobe-suite-burndownevent-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['/burndownevent/{id}'].get
$.paths['/burndownevent'].get
$.paths['/burndownevent/count'].get
$.paths['/burndownevent/search'].get
$.paths['/burndownevent/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 Burndownevent API
  version: 1.0.0
extends: openapi/adobe-suite-burndownevent-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['/burndownevent/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single burndown event
      effect: read
      questions:
      - How do I look up one agile burndown event by ID?
      - Can I choose which fields come back for a burndown event?
      instructions:
      - text: Show me burndown event {id}.
        slots:
          id: path.id
      - text: Fetch burndown event {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/burndownevent'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several burndown events by ID
      effect: read
      questions:
      - Can I fetch multiple burndown events in one call?
      - What's the quickest way to load a known set of burndown events?
      instructions:
      - text: Get burndown events {id}.
        slots:
          id: query.id
      - text: Bulk fetch burndown events {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/burndownevent/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count burndown events
      effect: read
      questions:
      - How many burndown events have been recorded?
      - Can I count burndown events matching a filter?
      instructions:
      - text: Count all burndown events.
      - text: Count burndown events matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/burndownevent/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search burndown events with filters
      effect: read
      questions:
      - How do I find burndown events for a particular iteration?
      - Can I page through burndown event search results?
      instructions:
      - text: Search burndown events where {filters}.
        slots:
          filters: query.filters
      - text: Find burndown events matching {filters} and return {fields}.
        slots:
          filters: query.filters
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/burndownevent/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on burndown events
      effect: read
      questions:
      - Can I get aggregated report data about burndown events?
      - What does a filtered burndown event report return?
      instructions:
      - text: Run a burndown event report.
      - text: Report on burndown events filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'