Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Customquarter API

11 actions 11 updates phrasing extends openapi/adobe-suite-customquarter-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['/customquarter/{id}'].get
$.paths['/customquarter/{id}'].put
$.paths['/customquarter/{id}'].delete
$.paths['/customquarter'].get
$.paths['/customquarter'].put
$.paths['/customquarter'].post
$.paths['/customquarter'].delete
$.paths['/customquarter/count'].get
$.paths['/customquarter/search'].get
$.paths['/customquarter/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 Customquarter API
  version: 1.0.0
extends: openapi/adobe-suite-customquarter-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['/customquarter/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one custom fiscal quarter
      effect: read
      questions:
      - What are the start and end dates of a specific custom quarter?
      - Can I look up a single custom quarter by ID?
      instructions:
      - text: Get custom quarter {id}.
        slots:
          id: path.id
      - text: Show custom quarter {id} with fields {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a custom quarter
      effect: write
      questions:
      - How do I change the dates of one custom quarter?
      - Can I edit a single fiscal quarter definition?
      instructions:
      - text: Update custom quarter {id}.
        slots:
          id: path.id
      - text: Edit custom quarter {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom quarter
      effect: destructive
      questions:
      - How do I remove one custom quarter definition?
      - Can I force delete a custom quarter?
      instructions:
      - text: Delete custom quarter {id}.
        slots:
          id: path.id
      - text: Force delete custom quarter {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several custom quarters by ID
      effect: read
      questions:
      - Can I fetch multiple custom quarters in one call?
      - How do I look up a batch of fiscal quarters by their IDs?
      instructions:
      - text: Get custom quarters {id}.
        slots:
          id: query.id
      - text: Fetch the quarters {id} returning {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many custom quarters at once
      effect: write
      questions:
      - Can I bulk edit several custom quarters together?
      - How do I shift a whole year of fiscal quarters in one request?
      instructions:
      - text: Bulk update the custom quarters.
      - text: Bulk edit custom quarters and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom quarter
      effect: write
      questions:
      - How do I define a custom fiscal quarter for reporting?
      - Can my organization set up quarters that do not follow the calendar?
      instructions:
      - text: Create a new custom quarter.
      - text: Add a custom fiscal quarter and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several custom quarters
      effect: destructive
      questions:
      - Can I delete multiple custom quarters in one call?
      - How do I clear out old fiscal quarter definitions in bulk?
      instructions:
      - text: Delete custom quarters {id}.
        slots:
          id: query.id
      - text: Bulk delete quarters {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count custom quarters
      effect: read
      questions:
      - How many custom quarters are defined?
      - Can I count only the quarters matching a filter?
      instructions:
      - text: Count the custom quarters.
      - text: Count custom quarters matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search custom quarters
      effect: read
      questions:
      - How do I find custom quarters within a certain date range?
      - Can I search and sort fiscal quarter definitions?
      instructions:
      - text: Search custom quarters matching {filters}.
        slots:
          filters: query.filters
      - text: Find quarters matching {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/customquarter/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report on custom quarters
      effect: read
      questions:
      - Can I get an aggregated report of custom quarters?
      - What grouped totals can I produce for fiscal quarters?
      instructions:
      - text: Run a custom quarter report.
      - text: Report on custom quarters filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'