Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST JQL Functions (Apps)…

3 actions 3 updates phrasing extends openapi/atlassian-jql-functions-apps-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 3

$.info

$.paths['/rest/api/3/jql/function/computation'].get

$.paths['/rest/api/3/jql/function/computation'].post

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 JQL Functions (Apps)…
  version: 1.0.0
extends: openapi/atlassian-jql-functions-apps-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: 2
- target: $.paths['/rest/api/3/jql/function/computation'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's JQL function precomputations
      effect: read
      questions:
      - What precomputed values does my app's custom JQL function have, and when were they last used?
      - Can I list precomputations for only one function key?
      instructions:
      - text: List the precomputations for JQL function {functionKey}.
        slots:
          functionKey: query.functionKey
      - text: Show my custom JQL function precomputations ordered by {orderBy}.
        slots:
          orderBy: query.orderBy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/jql/function/computation'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an app's JQL function precomputations
      effect: write
      questions:
      - How does a Forge or Connect app refresh the precomputed value of its JQL function?
      - Can I update several JQL function precomputations at once?
      instructions:
      - text: Update the JQL function precomputations with {values}.
        slots:
          values: requestBody.values
      - text: Replace the precomputed JQL fragments for my app's functions with {values}.
        slots:
          values: requestBody.values
      method: generated
      generated: '2026-10-01'