Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Schedule API

17 actions 17 updates phrasing extends openapi/adobe-suite-schedule-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/schedule/{id}'].get
$.paths['/schedule/{id}'].put
$.paths['/schedule/{id}'].delete
$.paths['/schedule'].get
$.paths['/schedule'].put
$.paths['/schedule'].post
$.paths['/schedule'].delete
$.paths['/schedule/replace'].put
$.paths['/schedule/count'].get
$.paths['/schedule/search'].get
$.paths['/schedule/report'].get
$.paths['/schedule/getEarliestWorkTimeOfDay'].put
$.paths['/schedule/getLatestWorkTimeOfDay'].put
$.paths['/schedule/getNextCompletionDate'].put
$.paths['/schedule/getNextStartDate'].put

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 Schedule API
  version: 1.0.0
extends: openapi/adobe-suite-schedule-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: 16
- target: $.paths['/schedule/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Workfront work schedule
      effect: read
      questions:
      - How do I look up a single work schedule by ID?
      - Can I fetch only selected fields of one schedule?
      instructions:
      - text: Show me schedule {id}.
        slots:
          id: path.id
      - text: Get the {fields} of work schedule {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one work schedule
      effect: write
      questions:
      - Can I change the working days or hours on one existing schedule?
      - What edits a single Workfront schedule in place?
      instructions:
      - text: Edit work schedule {id} with my changes.
        slots:
          id: path.id
      - text: Update schedule {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one work schedule
      effect: destructive
      questions:
      - How do I remove a single work schedule?
      - Is there a force option when a schedule is still assigned to users?
      instructions:
      - text: Delete schedule {id}.
        slots:
          id: path.id
      - text: Force-delete work schedule {id} with force set to {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several schedules by ID
      effect: read
      questions:
      - Can I load multiple work schedules at once from a list of IDs?
      - What returns a batch of schedules I already know the IDs of?
      instructions:
      - text: Fetch schedules {id}.
        slots:
          id: query.id
      - text: Bulk-load work schedules {id} with only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many work schedules at once
      effect: write
      questions:
      - Can I edit a batch of work schedules in one request?
      - Which call bulk-updates several Workfront schedules together?
      instructions:
      - text: Bulk-edit the work schedules in my payload.
      - text: Apply these changes to several schedules and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or copy a work schedule
      effect: write
      questions:
      - How do I create a new work schedule for a team or region?
      - Can I base a new schedule on a copy of an existing one?
      instructions:
      - text: Create a new work schedule from my definition.
      - text: Copy schedule {copySourceID} into a new one.
        slots:
          copySourceID: query.copySourceID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several work schedules
      effect: destructive
      questions:
      - Can I remove multiple work schedules in one call?
      - What bulk-deletes schedules by a list of IDs?
      instructions:
      - text: Delete work schedules {id}.
        slots:
          id: query.id
      - text: Bulk force-delete schedules {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/replace'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace schedules with another schedule
      effect: write
      questions:
      - How do I swap old work schedules out for a single replacement schedule?
      - Can I reassign everything using some schedules onto another one?
      instructions:
      - text: Replace schedules {id} with schedule {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      - text: Move everything on work schedules {id} over to {replacementID}.
        slots:
          id: query.id
          replacementID: query.replacementID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count work schedules
      effect: read
      questions:
      - How many work schedules are defined in Workfront?
      - Can I count only schedules matching a filter?
      instructions:
      - text: Count all work schedules.
      - text: Tell me how many schedules match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search work schedules
      effect: read
      questions:
      - How do I find work schedules by name or time zone?
      - Can I sort and page schedule search results?
      instructions:
      - text: Search work schedules matching {filters}.
        slots:
          filters: query.filters
      - text: Find schedules where {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report over schedules
      effect: read
      questions:
      - Can I get grouped totals across work schedules?
      - What produces an aggregated summary of schedules instead of records?
      instructions:
      - text: Summarize work schedules grouped by {listOptions}.
        slots:
          listOptions: query.listOptions
      - text: Produce aggregate schedule totals for {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/getEarliestWorkTimeOfDay'].put
  update:
    x-apievangelist-phrasing:
      intent: Find when the workday starts on a date
      effect: read
      questions:
      - What time does the working day start on a given date for a schedule?
      - Can I check the earliest work time on a specific day?
      instructions:
      - text: Get the earliest work time on {date} for schedule {ID}.
        slots:
          date: query.date
          ID: query.ID
      - text: Tell me when work starts on {date} under schedule {ID}.
        slots:
          date: query.date
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/getLatestWorkTimeOfDay'].put
  update:
    x-apievangelist-phrasing:
      intent: Find when the workday ends on a date
      effect: read
      questions:
      - When does the last working hour finish on a particular day under this schedule?
      - Can I check the latest work time on a specific day?
      instructions:
      - text: Get the latest work time on {date} for schedule {ID}.
        slots:
          date: query.date
          ID: query.ID
      - text: Tell me when work finishes on {date} under schedule {ID}.
        slots:
          date: query.date
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/getNextCompletionDate'].put
  update:
    x-apievangelist-phrasing:
      intent: Calculate a completion date from work minutes
      effect: read
      questions:
      - If work starts on a date and needs so many minutes, when will it finish on this schedule?
      - Can I compute a finish date that skips non-working time?
      instructions:
      - text: Compute the completion date for {costInMinutes} minutes of work starting {date} on schedule {ID}.
        slots:
          costInMinutes: query.costInMinutes
          date: query.date
          ID: query.ID
      - text: Work out the finish date for a {costInMinutes}-minute task beginning {date} on schedule {ID}.
        slots:
          costInMinutes: query.costInMinutes
          date: query.date
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/getNextStartDate'].put
  update:
    x-apievangelist-phrasing:
      intent: Find the next working start time after a date
      effect: read
      questions:
      - What is the next moment work can start after a given date on this schedule?
      - Can I find the next working start if a date falls on a weekend or holiday?
      instructions:
      - text: Get the next start date after {date} on schedule {ID}.
        slots:
          date: query.date
          ID: query.ID
      - text: Find the first working time following {date} for schedule {ID}.
        slots:
          date: query.date
          ID: query.ID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/schedule/defaultSchedule'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default work schedule
      effect: read
      questions:
      - Which work schedule is the default for our Workfront instance?
      - Can I look up the system default schedule?
      instructions:
      - text: Show me the default work schedule.
      - text: Get the instance-wide default schedule.
      method: generated
      generated: '2026-09-26'