# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Issue Comments API
  version: 1.0.0
extends: openapi/jira-issue-comments-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: 8
- target: $.paths['/issue/{issueIdOrKey}/comment'].get
  update:
    x-apievangelist-phrasing:
      intent: List an issue's comments via the unversioned path
      effect: read
      questions:
      - Is there a legacy unversioned path for reading an issue's comments?
      - Can the older comment listing outside /rest/api/3 sort comments by created date?
      instructions:
      - text: Using the unversioned /issue path, list comments on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Via the legacy unversioned comment path, get comments on {issueIdOrKey} ordered by {orderBy}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/issue/{issueIdOrKey}/comment'].post
  update:
    x-apievangelist-phrasing:
      intent: Comment on an issue via the unversioned path
      effect: write
      questions:
      - Can I post an ADF comment through the older unversioned issue comment path?
      - Does the legacy unversioned add-comment endpoint support visibility restrictions?
      instructions:
      - text: Using the unversioned /issue path, add comment {body} to issue {issueIdOrKey}.
        slots:
          body: requestBody.body
          issueIdOrKey: path.issueIdOrKey
      - text: Via the legacy unversioned path, comment {body} on {issueIdOrKey} visible only to {visibility}.
        slots:
          body: requestBody.body
          issueIdOrKey: path.issueIdOrKey
          visibility: requestBody.visibility
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/comment/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several comments by their IDs
      effect: read
      questions:
      - Can I fetch a batch of comments across issues when I already know their IDs?
      - Which comments from a list of IDs am I allowed to see?
      instructions:
      - text: Get comments with IDs {ids}.
        slots:
          ids: requestBody.ids
      - text: Fetch comments {ids} expanded with {expand}.
        slots:
          ids: requestBody.ids
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment'].get
  update:
    x-apievangelist-phrasing:
      intent: List the comments on an issue
      effect: read
      questions:
      - How do I read all the comments on an issue?
      - Can I page through an issue's comments newest first?
      instructions:
      - text: List comments on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Show {maxResults} comments from issue {issueIdOrKey} ordered by {orderBy}.
        slots:
          maxResults: query.maxResults
          issueIdOrKey: path.issueIdOrKey
          orderBy: query.orderBy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an issue
      effect: write
      questions:
      - How do I post a comment on an issue?
      - Can I restrict a new comment so only a certain group or role sees it?
      - Is it possible to add an internal-only comment on a service desk request?
      instructions:
      - text: Comment {body} on issue {issueIdOrKey}.
        slots:
          body: requestBody.body
          issueIdOrKey: path.issueIdOrKey
      - text: Add comment {body} to {issueIdOrKey} visible only to {visibility}.
        slots:
          body: requestBody.body
          issueIdOrKey: path.issueIdOrKey
          visibility: requestBody.visibility
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single comment on an issue
      effect: read
      questions:
      - How do I retrieve one specific comment on an issue?
      - Can I get the rendered HTML of a single comment?
      instructions:
      - text: Get comment {id} on issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Show comment {id} from {issueIdOrKey} expanded with {expand}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing comment
      effect: write
      questions:
      - Can I edit a comment I already posted on an issue?
      - Is there a way to update a comment without notifying watchers?
      instructions:
      - text: Change comment {id} on issue {issueIdOrKey} to say {body}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          body: requestBody.body
      - text: Edit comment {id} on {issueIdOrKey} to {body} with notify users set to {notifyUsers}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          body: requestBody.body
          notifyUsers: query.notifyUsers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from an issue
      effect: destructive
      questions:
      - How do I delete a comment on an issue?
      - What permissions are needed to remove someone else's comment?
      instructions:
      - text: Delete comment {id} on issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Remove comment {id} from {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-09-26'