Atlassian · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/atlassian-issue-type-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/issuetype/{issueTypeId}/properties'].get

$.paths['/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}'].get

$.paths['/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}'].put

$.paths['/rest/api/3/issuetype/{issueTypeId}/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 Type…
  version: 1.0.0
extends: openapi/atlassian-issue-type-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/issuetype/{issueTypeId}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List property keys stored on an issue type
      effect: read
      questions:
      - What custom data keys has my app stored on this Jira issue type?
      - Which entity properties exist for an issue type?
      instructions:
      - text: List the property keys on issue type {issueTypeId}.
        slots:
          issueTypeId: path.issueTypeId
      - text: Show every stored property key for issue type {issueTypeId}.
        slots:
          issueTypeId: path.issueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an issue type property's value
      effect: read
      questions:
      - How do I read data my app saved against an issue type?
      - What value is stored under a given issue type property key?
      instructions:
      - text: Get property {propertyKey} of issue type {issueTypeId}.
        slots:
          propertyKey: path.propertyKey
          issueTypeId: path.issueTypeId
      - text: Read the value stored at {propertyKey} on issue type {issueTypeId}.
        slots:
          propertyKey: path.propertyKey
          issueTypeId: path.issueTypeId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set an issue type property
      effect: write
      questions:
      - How do I store custom data against a Jira issue type?
      - Does setting an issue type property create it if it doesn't exist?
      instructions:
      - text: Set property {propertyKey} on issue type {issueTypeId}.
        slots:
          propertyKey: path.propertyKey
          issueTypeId: path.issueTypeId
      - text: Create or overwrite issue type {issueTypeId} property {propertyKey} with this JSON.
        slots:
          issueTypeId: path.issueTypeId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/issuetype/{issueTypeId}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an issue type property
      effect: destructive
      questions:
      - How do I remove app data stored on an issue type?
      - Who can delete an issue type property?
      instructions:
      - text: Delete property {propertyKey} from issue type {issueTypeId}.
        slots:
          propertyKey: path.propertyKey
          issueTypeId: path.issueTypeId
      - text: Remove issue type {issueTypeId} property {propertyKey}.
        slots:
          issueTypeId: path.issueTypeId
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'