Jira · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Jira Cloud platform REST App properties API

9 actions 9 updates phrasing extends openapi/jira-app-properties-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Jira's API. It is a proposal applied on top of the contract, not a document Jira publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.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'].get
$.paths['/rest/forge/1/app/properties/{propertyKey}'].get
$.paths['/rest/forge/1/app/properties/{propertyKey}'].put
$.paths['/rest/forge/1/app/properties/{propertyKey}'].delete

OpenAPI Overlay

Raw ↑ 
# 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 App properties API
  version: 1.0.0
extends: openapi/jira-app-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: 8
- 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 properties has my Connect app stored in Jira?
      - Can a Forge app read the properties of its linked Connect app?
      instructions:
      - text: List all properties stored for Connect app {addonKey}.
        slots:
          addonKey: path.addonKey
      - text: Show the property keys my Connect app {addonKey} has saved.
        slots:
          addonKey: path.addonKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Connect app property
      effect: read
      questions:
      - What value is stored under a specific key for my Connect app?
      - How can a migrating Forge app fetch the Connect client key?
      instructions:
      - text: Get property {propertyKey} of Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      - text: Read the {propertyKey} value saved by Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/atlassian-connect/1/addons/{addonKey}/properties/{propertyKey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a Connect app property
      effect: write
      questions:
      - How does a Connect app store its own custom data in Jira?
      - What is the size limit for a Connect app property value?
      instructions:
      - text: Set Connect app {addonKey} property {propertyKey} to this JSON.
        slots:
          addonKey: path.addonKey
          propertyKey: path.propertyKey
      - text: Save these settings as {propertyKey} for Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      method: generated
      generated: '2026-09-26'
- 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 remove a stored property from my Connect app?
      - Can only the owning Connect app delete its properties?
      instructions:
      - text: Delete property {propertyKey} from Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      - text: Clear the {propertyKey} setting stored by Connect app {addonKey}.
        slots:
          propertyKey: path.propertyKey
          addonKey: path.addonKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/forge/1/app/properties'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Forge app's property keys
      effect: read
      questions:
      - Which property keys has my Forge app saved in Jira?
      - Can a Forge app enumerate its own stored properties?
      instructions:
      - text: List all property keys for this Forge app.
      - text: Show every key my Forge app has stored as an app property.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/forge/1/app/properties/{propertyKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Forge app property value
      effect: read
      questions:
      - What value does my Forge app have under a given property key?
      - How does a Forge app read back one of its app properties?
      instructions:
      - text: Get Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Read the value my Forge app stored as {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- 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 save a value it can later use in Jira expressions?
      - Can Forge app properties drive display conditions?
      instructions:
      - text: Set Forge app property {propertyKey} to this JSON value.
        slots:
          propertyKey: path.propertyKey
      - text: Store this flag as Forge app property {propertyKey} so expressions can read it.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/forge/1/app/properties/{propertyKey}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Forge app property
      effect: destructive
      questions:
      - How does a Forge app remove one of its stored properties?
      - Do I need a special OAuth scope to delete a Forge app property?
      instructions:
      - text: Delete Forge app property {propertyKey}.
        slots:
          propertyKey: path.propertyKey
      - text: Remove the {propertyKey} value my Forge app saved.
        slots:
          propertyKey: path.propertyKey
      method: generated
      generated: '2026-09-26'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/jira-app-properties-api-phrasing-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.