# 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 Milestone API
  version: 1.0.0
extends: openapi/adobe-suite-milestone-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['/milestone/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Workfront milestone
      effect: read
      questions:
      - How do I look up a single milestone by its ID?
      - Can I fetch only certain fields of one milestone?
      instructions:
      - text: Show me milestone {id}.
        slots:
          id: path.id
      - text: Get the {fields} of milestone {id}.
        slots:
          fields: query.fields
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one milestone
      effect: write
      questions:
      - Can I rename or recolor an existing milestone?
      - What edits a single milestone in place?
      instructions:
      - text: Edit milestone {id} with my changes.
        slots:
          id: path.id
      - text: Update milestone {id} and return {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one milestone
      effect: destructive
      questions:
      - How do I remove a single milestone?
      - Is there a force flag for deleting a milestone that tasks reference?
      instructions:
      - text: Delete milestone {id}.
        slots:
          id: path.id
      - text: Force-delete milestone {id} with force {force}.
        slots:
          id: path.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone'].get
  update:
    x-apievangelist-phrasing:
      intent: Get several milestones by ID
      effect: read
      questions:
      - Can I load multiple milestones at once from their IDs?
      - What returns a batch of milestones I already have IDs for?
      instructions:
      - text: Fetch milestones {id}.
        slots:
          id: query.id
      - text: Bulk-load milestones {id} with only {fields}.
        slots:
          id: query.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many milestones at once
      effect: write
      questions:
      - Can I change several milestones in one request?
      - Which call bulk-updates milestones together?
      instructions:
      - text: Bulk-edit the milestones in my payload.
      - text: Apply these edits to several milestones and return {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a milestone
      effect: write
      questions:
      - How do I add a new milestone to use in milestone paths?
      - What creates a milestone that tasks can be tagged with?
      instructions:
      - text: Create a new milestone from my definition.
      - text: Add a milestone and give me back its {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several milestones
      effect: destructive
      questions:
      - Can I remove multiple milestones in one call?
      - What bulk-deletes milestones by a list of IDs?
      instructions:
      - text: Delete milestones {id}.
        slots:
          id: query.id
      - text: Bulk force-delete milestones {id} with force {force}.
        slots:
          id: query.id
          force: query.force
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone/count'].get
  update:
    x-apievangelist-phrasing:
      intent: Count milestones
      effect: read
      questions:
      - How many milestones are defined in Workfront?
      - Can I count only milestones matching a filter?
      instructions:
      - text: Count all milestones.
      - text: Tell me how many milestones match {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search milestones
      effect: read
      questions:
      - How do I find milestones by name or milestone path?
      - Can I sort and page milestone search results?
      instructions:
      - text: Search milestones matching {filters}.
        slots:
          filters: query.filters
      - text: Find milestones where {filters} using list options {listOptions}.
        slots:
          filters: query.filters
          listOptions: query.listOptions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/milestone/report'].get
  update:
    x-apievangelist-phrasing:
      intent: Run an aggregate report over milestones
      effect: read
      questions:
      - Can I get grouped totals across milestones?
      - What produces an aggregated summary of milestones rather than records?
      instructions:
      - text: Summarize milestones grouped by {listOptions}.
        slots:
          listOptions: query.listOptions
      - text: Produce aggregate milestone totals for {filters}.
        slots:
          filters: query.filters
      method: generated
      generated: '2026-09-26'