# 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 Issue API
  version: 1.0.0
extends: openapi/jira-issue-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: 4
- target: $.paths['/rest/agile/1.0/issue/rank'].put
  update:
    x-apievangelist-phrasing:
      intent: Rank issues before or after another issue
      effect: write
      questions:
      - How do I reorder issues on a board's backlog?
      - Can I move up to 50 issues above a specific issue in rank at once?
      instructions:
      - text: Rank issues {issues} before issue {rankBeforeIssue}.
        slots:
          issues: requestBody.issues
          rankBeforeIssue: requestBody.rankBeforeIssue
      - text: Move issues {issues} so they rank right after {rankAfterIssue}.
        slots:
          issues: requestBody.issues
          rankAfterIssue: requestBody.rankAfterIssue
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/issue/{issueIdOrKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue with agile fields
      effect: read
      questions:
      - Which sprint and epic is an issue in, and is it flagged?
      - Can I get an issue including closed sprints from the agile API?
      instructions:
      - text: Get issue {issueIdOrKey} with its sprint and epic fields.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Show agile details like closed sprints for issue {issueIdOrKey}, fields {fields}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/issue/{issueIdOrKey}/estimation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue's estimate on a board
      effect: read
      questions:
      - What is the story point estimate of an issue on a particular board?
      - Which field does a board use to hold an issue's estimate?
      instructions:
      - text: Get the estimate of issue {issueIdOrKey} on board {boardId}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          boardId: query.boardId
      - text: Show which estimation field board {boardId} uses for {issueIdOrKey} and its value.
        slots:
          boardId: query.boardId
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/agile/1.0/issue/{issueIdOrKey}/estimation'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an issue's estimate for a board
      effect: write
      questions:
      - How do I set story points on an issue for a specific board?
      - Can I enter an original time estimate like 2d or 3h?
      instructions:
      - text: Estimate issue {issueIdOrKey} at {value} on board {boardId}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          value: requestBody.value
          boardId: query.boardId
      - text: Set the board {boardId} estimate for {issueIdOrKey} to {value}.
        slots:
          boardId: query.boardId
          issueIdOrKey: path.issueIdOrKey
          value: requestBody.value
      method: generated
      generated: '2026-09-26'