# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Jira Cloud platform REST Issue comment properties API
  version: 1.0.0
extends: openapi/jira-issue-comment-properties-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/api/3/comment/{commentId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List property keys on a comment
      effect: read
      questions:
      - What custom property keys are stored on an issue comment?
      - Which apps have attached data to a particular comment?
      instructions:
      - text: List the property keys on comment {commentId}.
        slots:
          commentId: path.commentId
      - text: Show every entity property key saved against comment {commentId}.
        slots:
          commentId: path.commentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/comment/{commentId}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a comment property value
      effect: read
      questions:
      - What value is stored under a given key on an issue comment?
      - Can I read a comment's custom property without being signed in?
      instructions:
      - text: Get property {propertyKey} of comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      - text: Read the {propertyKey} data stored on comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      method: generated
      generated: '2026-09-26'
- 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 against an issue comment?
      - Can I set properties on comments written by other people?
      instructions:
      - text: Set property {propertyKey} on comment {commentId} to this JSON.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      - text: Tag comment {commentId} with metadata under the key {propertyKey}.
        slots:
          commentId: path.commentId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- 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 a custom property from an issue comment?
      - Do I need Edit All Comments to delete a property from someone else's comment?
      instructions:
      - text: Delete property {propertyKey} from comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      - text: Clear the {propertyKey} metadata on comment {commentId}.
        slots:
          propertyKey: path.propertyKey
          commentId: path.commentId
      method: generated
      generated: '2026-09-26'