Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST Jira Expressions API

3 actions 3 updates phrasing extends openapi/atlassian-jira-expressions-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/expression/analyse'].post
$.paths['/rest/api/3/expression/eval'].post

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 Atlassian The Jira Cloud platform REST Jira Expressions API
  version: 1.0.0
extends: openapi/atlassian-jira-expressions-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/expression/analyse'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate and type-check Jira expressions
      effect: read
      questions:
      - How do I check whether a Jira expression is syntactically valid before using it?
      - Can Jira type-check my expressions against context variables?
      instructions:
      - text: Validate these Jira expressions {expressions}.
        slots:
          expressions: requestBody.expressions
      - text: Analyse expressions {expressions} with check mode {check}.
        slots:
          expressions: requestBody.expressions
          check: query.check
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/expression/eval'].post
  update:
    x-apievangelist-phrasing:
      intent: Evaluate a Jira expression
      effect: read
      questions:
      - How do I run a Jira expression and get its result?
      - Can I evaluate an expression in the context of a specific issue or project?
      instructions:
      - text: Evaluate the Jira expression {expression}.
        slots:
          expression: requestBody.expression
      - text: Run expression {expression} with context {context}.
        slots:
          expression: requestBody.expression
          context: requestBody.context
      method: generated
      generated: '2026-10-01'