# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Software Cloud Epic API
  version: 1.0.0
extends: openapi/jira-epic-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: 9
- target: $.paths['/rest/agile/1.0/epic/none/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues not in any epic
      effect: read
      questions:
      - Which issues don't belong to any epic yet?
      - Can I filter the issues without an epic using JQL?
      instructions:
      - text: List issues that aren't in an epic.
      - text: Show epic-less issues matching {jql}.
        slots:
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/epic/none/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove issues from their epics
      effect: write
      questions:
      - How do I take issues out of whatever epic they're in?
      - How many issues can I remove from epics in one call?
      instructions:
      - text: Remove issues {issues} from their epics.
        slots:
          issues: requestBody.issues
      - text: Detach {issues} so they belong to no epic.
        slots:
          issues: requestBody.issues
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/epic/none/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues without an epic, token paged
      effect: read
      questions:
      - Is there a token-paged way to list issues that have no epic?
      - Can I get epic-less issues with reconciled results using nextPageToken?
      instructions:
      - text: List issues with no epic via the enhanced endpoint.
      - text: Get the next page of epic-less issues using token {nextPageToken}.
        slots:
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/epic/{epicIdOrKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an epic
      effect: read
      questions:
      - How do I look up an epic's name, summary and done status?
      - Can I fetch an epic by its key?
      instructions:
      - text: Show epic {epicIdOrKey}.
        slots:
          epicIdOrKey: path.epicIdOrKey
      - text: Check whether epic {epicIdOrKey} is marked done.
        slots:
          epicIdOrKey: path.epicIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/epic/{epicIdOrKey}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an epic's name, summary, color or status
      effect: write
      questions:
      - How do I rename an epic or change its color?
      - Can I mark an epic as done through the agile API?
      instructions:
      - text: Rename epic {epicIdOrKey} to {name}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          name: requestBody.name
      - text: Set the color of epic {epicIdOrKey} to {color}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          color: requestBody.color
      - text: Mark epic {epicIdOrKey} done as {done}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          done: requestBody.done
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/epic/{epicIdOrKey}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List issues in an epic
      effect: read
      questions:
      - Which issues belong to a given epic?
      - Can I filter an epic's child issues with JQL?
      instructions:
      - text: List the issues in epic {epicIdOrKey}.
        slots:
          epicIdOrKey: path.epicIdOrKey
      - text: Show issues in epic {epicIdOrKey} matching {jql}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          jql: query.jql
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/epic/{epicIdOrKey}/issue'].post
  update:
    x-apievangelist-phrasing:
      intent: Move issues into an epic
      effect: write
      questions:
      - How do I add existing issues to an epic?
      - If an issue is already in another epic, what happens when I move it?
      instructions:
      - text: Move issues {issues} into epic {epicIdOrKey}.
        slots:
          issues: requestBody.issues
          epicIdOrKey: path.epicIdOrKey
      - text: Add {issues} to epic {epicIdOrKey}.
        slots:
          issues: requestBody.issues
          epicIdOrKey: path.epicIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/software/1.0/epic/{epicIdOrKey}/issue'].get
  update:
    x-apievangelist-phrasing:
      intent: List an epic's issues with token paging
      effect: read
      questions:
      - Is there an enhanced epic issues listing that pages with nextPageToken?
      - Can I get an epic's issues with reconciled search results?
      instructions:
      - text: List issues in epic {epicIdOrKey} using the enhanced token-paged endpoint.
        slots:
          epicIdOrKey: path.epicIdOrKey
      - text: Get the next page of epic {epicIdOrKey} issues with token {nextPageToken}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          nextPageToken: query.nextPageToken
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/epic/{epicIdOrKey}/rank'].put
  update:
    x-apievangelist-phrasing:
      intent: Rank an epic before or after another
      effect: write
      questions:
      - How do I reorder epics on my board?
      - Can I move one epic above another in rank?
      instructions:
      - text: Rank epic {epicIdOrKey} before epic {rankBeforeEpic}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          rankBeforeEpic: requestBody.rankBeforeEpic
      - text: Move epic {epicIdOrKey} after {rankAfterEpic}.
        slots:
          epicIdOrKey: path.epicIdOrKey
          rankAfterEpic: requestBody.rankAfterEpic
      method: generated
      generated: '2026-09-26'