Atlassian · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/atlassian-issue-comment-properties-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 5

$.info

$.paths['/rest/api/3/comment/{commentId}/properties'].get

$.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].get

$.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].put

$.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].delete

OpenAPI Overlay

# 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 Comment…
  version: 1.0.0
extends: openapi/atlassian-issue-comment-properties-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: 4
- target: $.paths['/rest/api/3/comment/{commentId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List the property keys on a comment
      effect: read
      questions:
      - What custom properties are stored on a particular issue comment?
      - Which property keys has an app attached to a comment?
      instructions:
      - text: List the property keys on comment {commentId}.
        slots:
          commentId: path.commentId
      - text: Show which properties are stored on comment {commentId}.
        slots:
          commentId: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the value of a comment property
      effect: read
      questions:
      - What value is saved in a specific property on a comment?
      - Can I read app data stored on an issue comment?
      instructions:
      - text: Get property {propertyKey} from comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      - text: Show the value of {propertyKey} on comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a property on a comment
      effect: write
      questions:
      - How do I store custom JSON data on an issue comment?
      - Can I overwrite a property that already exists on a comment?
      instructions:
      - text: Set property {propertyKey} on comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      - text: Save custom data under {propertyKey} on comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property from a comment
      effect: destructive
      questions:
      - How do I remove stored data from an issue comment?
      - Can I delete a property from someone else's comment?
      instructions:
      - text: Delete property {propertyKey} from comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      - text: Remove the {propertyKey} data stored on comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      method: generated
      generated: '2026-10-01'