# 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 Properties API
  version: 1.0.0
extends: openapi/atlassian-issue-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: 8
- target: $.paths['/rest/api/3/issue/properties'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the same properties on many issues
      effect: write
      questions:
      - Can I apply the same list of custom properties to thousands of issues at once?
      - How many issues and properties does a bulk property-list update allow?
      instructions:
      - text: Set properties {properties} on issues {entitiesIds}.
        slots:
          properties: requestBody.properties
          entitiesIds: requestBody.entitiesIds
      - text: Apply the same property list {properties} to every issue in {entitiesIds}.
        slots:
          properties: requestBody.properties
          entitiesIds: requestBody.entitiesIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/properties/multi'].post
  update:
    x-apievangelist-phrasing:
      intent: Set different properties on each of many issues
      effect: write
      questions:
      - Can I set a different property value per issue in a single request?
      - What is the cap on issues when setting per-issue properties in bulk?
      instructions:
      - text: 'Set these per-issue properties in one request: {issues}.'
        slots:
          issues: requestBody.issues
      - text: Update each issue with its own property values from {issues}.
        slots:
          issues: requestBody.issues
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set one property's value across filtered issues
      effect: write
      questions:
      - Can I set one property on all issues that match a filter?
      - Is it possible to compute a property value with a Jira expression during a bulk set?
      instructions:
      - text: Set property {propertyKey} to {value} on issues matching {filter}.
        slots:
          propertyKey: path.propertyKey
          value: requestBody.value
          filter: requestBody.filter
      - text: Bulk set {propertyKey} using the expression {expression}.
        slots:
          propertyKey: path.propertyKey
          expression: requestBody.expression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property from many issues
      effect: destructive
      questions:
      - How do I remove one property from lots of issues at once?
      - Can I bulk delete a property only where it has a particular current value?
      instructions:
      - text: Delete property {propertyKey} from issues {entityIds}.
        slots:
          propertyKey: path.propertyKey
          entityIds: requestBody.entityIds
      - text: Remove {propertyKey} from every issue where its value is {currentValue}.
        slots:
          propertyKey: path.propertyKey
          currentValue: requestBody.currentValue
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List the property keys on an issue
      effect: read
      questions:
      - What custom properties are stored on a given ticket?
      - Which property keys has an app saved against an issue?
      instructions:
      - text: List the property keys on issue {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      - text: Show which properties are stored on ticket {issueIdOrKey}.
        slots:
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the value of an issue property
      effect: read
      questions:
      - What value is stored in a specific property on a ticket?
      - Can I read one app's custom data from an issue?
      instructions:
      - text: Get property {propertyKey} from issue {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
      - text: Show the stored value of {propertyKey} on ticket {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a property on a single issue
      effect: write
      questions:
      - How do I store custom JSON data against one ticket?
      - What is the maximum size of a property value on an issue?
      instructions:
      - text: Set property {propertyKey} on issue {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
      - text: Save custom JSON data under {propertyKey} on ticket {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issue/{issueIdOrKey}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a property from a single issue
      effect: destructive
      questions:
      - How do I remove one stored property from a ticket?
      - What permissions do I need to delete an issue's property?
      instructions:
      - text: Delete property {propertyKey} from issue {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
      - text: Remove the {propertyKey} data stored on ticket {issueIdOrKey}.
        slots:
          propertyKey: path.propertyKey
          issueIdOrKey: path.issueIdOrKey
      method: generated
      generated: '2026-10-01'