Adobe Suite · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Adobe Workfront Iteration API

13 actions 13 updates phrasing extends openapi/adobe-suite-iteration-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 13

$.info
$.paths['/iteration/{id}'].get
$.paths['/iteration/{id}'].put
$.paths['/iteration/{id}'].delete
$.paths['/iteration'].get
$.paths['/iteration'].put
$.paths['/iteration'].post
$.paths['/iteration'].delete
$.paths['/iteration/count'].get
$.paths['/iteration/search'].get
$.paths['/iteration/report'].get
$.paths['/iteration/moveIssues'].put
$.paths['/iteration/moveStories'].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 Iteration API
  version: 1.0.0
extends: openapi/adobe-suite-iteration-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: 12
- target: $.paths['/iteration/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one agile iteration
      effect: read
      questions:
      - What are the details of a single Workfront iteration?
      - Can I fetch one sprint by ID with only certain fields?
      instructions:
      - text: Show iteration {id}.
        slots:
          id: path.id
      - text: Get iteration {id} returning {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an iteration
      effect: write
      questions:
      - How do I change the dates or goal of one iteration?
      - Can I update a single sprint?
      instructions:
      - text: Update iteration {id} with my changes.
        slots:
          id: path.id
      - text: Edit sprint {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an iteration
      effect: destructive
      questions:
      - Can I delete a sprint I created by mistake?
      - Is there a force flag for deleting one iteration?
      instructions:
      - text: Delete iteration {id}.
        slots:
          id: path.id
      - text: Force delete sprint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch several iterations by ID
      effect: read
      questions:
      - Can I pull multiple iterations at once using their IDs?
      - What fields can I choose when fetching a batch of sprints?
      instructions:
      - text: Get iterations {id}.
        slots:
          id: query.id
      - text: Fetch sprints {id} with fields {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk edit iterations
      effect: write
      questions:
      - Can I update several iterations in one request?
      - Is there a bulk edit for sprints?
      instructions:
      - text: Bulk edit these iterations with my changes.
      - text: Apply updates to several sprints and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an iteration
      effect: write
      questions:
      - How do I create a new sprint for an agile team?
      - Can I add an iteration through the API?
      instructions:
      - text: Create a new iteration with the details I give you.
      - text: Add a sprint and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several iterations
      effect: destructive
      questions:
      - Can I bulk delete old sprints?
      - How do I remove multiple iterations in a single call?
      instructions:
      - text: Delete iterations {id}.
        slots:
          id: query.id
      - text: Force delete sprints {id}.
        slots:
          id: query.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count iterations
      effect: read
      questions:
      - How many iterations do we have?
      - Can I count sprints that match a filter?
      instructions:
      - text: Count all iterations.
      - text: Count sprints matching {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search iterations
      effect: read
      questions:
      - Which iterations are active for a given team?
      - Can I search sprints with filter conditions and list options?
      instructions:
      - text: Search iterations where {filters}.
        slots:
          filters: query.filters
      - text: Find sprints matching {filters} with list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a report over iterations
      effect: read
      questions:
      - Can I get summarized report data about our iterations?
      - What does an iteration report return?
      instructions:
      - text: Run an iteration report.
      - text: Report on sprints filtered by {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/moveIssues'].put
  update:
    x-apievangelist-phrasing:
      intent: Move issues into an iteration
      effect: write
      questions:
      - Can I move issues into a different sprint?
      - How do I shift a set of issues to another iteration for a team?
      instructions:
      - text: Move issues {issueIDs} into iteration {iterationID}.
        slots:
          issueIDs: query.issueIDs
          iterationID: query.iterationID
      - text: Move issues {issueIDs} to iteration {iterationID} for team {teamID}.
        slots:
          issueIDs: query.issueIDs
          iterationID: query.iterationID
          teamID: query.teamID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/iteration/moveStories'].put
  update:
    x-apievangelist-phrasing:
      intent: Move stories into an iteration
      effect: write
      questions:
      - Can I move user stories from one sprint to another?
      - How do I pull stories into an iteration for a team?
      instructions:
      - text: Move stories {storyIDs} into iteration {iterationID}.
        slots:
          storyIDs: query.storyIDs
          iterationID: query.iterationID
      - text: Move stories {storyIDs} to iteration {iterationID} for team {teamID}.
        slots:
          storyIDs: query.storyIDs
          iterationID: query.iterationID
          teamID: query.teamID
      method: generated
      generated: '2026-09-26'