Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST App Properties API

7 actions 7 updates phrasing extends openapi/atlassian-app-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 7

$.info

$.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties'].get

$.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].get

$.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].put

$.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].delete

$.paths['/rest/forge/1/app/properties/{propertyKey}'].put

$.paths['/rest/forge/1/app/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 App Properties API
  version: 1.0.0
extends: openapi/atlassian-app-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: 6
- target: $.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Connect app's properties
      effect: read
      questions:
      - What custom data has my Connect app stored in Jira?
      - Can I list every property key saved for my app?
      instructions:
      - text: List all properties stored for Connect app {addonKey}.
        slots:
          addonKey: path.addonKey
      - text: Show the property keys saved by app {addonKey}.
        slots:
          addonKey: path.addonKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Connect app property
      effect: read
      questions:
      - How do I read back a value my Connect app stored?
      - Can I fetch a single app property by its key?
      instructions:
      - text: Get property {propertyKey} of Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      - text: Read the stored value of {propertyKey} for app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a Connect app property
      effect: write
      questions:
      - Where can my Connect app store its own configuration data in Jira?
      - What format must a Connect app property value be?
      instructions:
      - text: Save property {propertyKey} for Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      - text: Store a JSON value under {propertyKey} for app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Connect app property
      effect: destructive
      questions:
      - How do I clear a value my Connect app no longer needs?
      - Can a Connect app remove one of its stored properties?
      instructions:
      - text: Delete property {propertyKey} of Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      - text: Remove the stored {propertyKey} value from app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/forge/1/app/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a Forge app property
      effect: write
      questions:
      - How does a Forge app store a value it can read in Jira expressions?
      - Can my Forge app save its own properties?
      instructions:
      - text: Set Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Store a value under {propertyKey} for my Forge app.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/forge/1/app/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Forge app property
      effect: destructive
      questions:
      - How do I remove a property my Forge app stored?
      - Can only Forge apps delete Forge app properties?
      instructions:
      - text: Delete Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Remove the {propertyKey} value from my Forge app.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-10-01'