Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Issue Comments API

7 actions 7 updates phrasing extends openapi/atlassian-issue-comments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Atlassian's API. It is a proposal applied on top of the contract, not a document Atlassian publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/rest/api/3/comment/list'].post
$.paths['/rest/api/3/issue/{issueIdOrKey}/comment'].get
$.paths['/rest/api/3/issue/{issueIdOrKey}/comment'].post
$.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].get
$.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].put
$.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].delete

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 Atlassian The Jira Cloud platform REST Issue Comments API
  version: 1.0.0
extends: openapi/atlassian-issue-comments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/rest/api/3/comment/list'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch Jira comments by a list of ids
      effect: read
      questions:
      - Can I fetch a batch of Jira comments when I already know their ids?
      - How do I look up several comments from different issues in one call?
      instructions:
      - text: Get the Jira comments with ids {ids}.
        slots:
          ids: requestBody.ids
      - text: Fetch comments {ids} with {expand} expanded.
        slots:
          ids: requestBody.ids
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment'].get
  update:
    x-apievangelist-phrasing:
      intent: List the comments on a Jira issue
      effect: read
      questions:
      - What comments have been left on this Jira issue?
      - Can I list an issue's comments newest first?
      instructions:
      - text: List the comments on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Show comments on {issueIdOrKey} ordered by {orderBy}.
        slots:
          issueIdOrKey: path.issueIdOrKey
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to a Jira issue
      effect: write
      questions:
      - How do I post a comment on a Jira issue?
      - Can I restrict a new comment so only one role or group can see it?
      instructions:
      - text: Comment {body} on issue {issueIdOrKey}.
        slots:
          body: requestBody.body
          issueIdOrKey: path.issueIdOrKey
      - text: Add an internal comment {body} to {issueIdOrKey} visible only to {visibility}.
        slots:
          body: requestBody.body
          issueIdOrKey: path.issueIdOrKey
          visibility: requestBody.visibility
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one comment on a Jira issue
      effect: read
      questions:
      - How do I read a single comment on a Jira issue by its id?
      - Who wrote a specific issue comment and when?
      instructions:
      - text: Get comment {id} on issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Show me Jira comment {id} from {issueIdOrKey} with {expand} expanded.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on a Jira issue
      effect: write
      questions:
      - How do I edit a comment I already posted on a Jira issue?
      - Can I update a comment without notifying watchers?
      instructions:
      - text: Change comment {id} on {issueIdOrKey} to say {body}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          body: requestBody.body
      - text: Edit comment {id} on issue {issueIdOrKey} with notifications set to {notifyUsers}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
          notifyUsers: query.notifyUsers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/comment/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a comment from a Jira issue
      effect: destructive
      questions:
      - How do I delete a comment from a Jira issue?
      - What permissions are needed to remove someone else's comment?
      instructions:
      - text: Delete comment {id} from issue {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      - text: Remove Jira comment {id} on {issueIdOrKey}.
        slots:
          id: path.id
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'