Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian The Jira Cloud platform REST UI Modifications…

5 actions 5 updates phrasing extends openapi/atlassian-ui-modifications-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 5

$.info

$.paths['/rest/api/3/uiModifications'].get

$.paths['/rest/api/3/uiModifications'].post

$.paths['/rest/api/3/uiModifications/{uiModificationId}'].put

$.paths['/rest/api/3/uiModifications/{uiModificationId}'].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 UI Modifications…
  version: 1.0.0
extends: openapi/atlassian-ui-modifications-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: 4
- target: $.paths['/rest/api/3/uiModifications'].get
  update:
    x-apievangelist-phrasing:
      intent: List my Forge app's UI modifications
      effect: read
      questions:
      - Which UI modifications has my Forge app defined in Jira?
      - Can I include the contexts each UI modification applies to?
      instructions:
      - text: List my app's UI modifications.
      - text: List UI modifications expanded with {expand}.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/uiModifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a UI modification
      effect: write
      questions:
      - How does a Forge app create a UI modification for Jira screens?
      - How many UI modifications and contexts can one app define?
      instructions:
      - text: Create a UI modification named {name}.
        slots:
          name: requestBody.name
      - text: Create UI modification {name} for contexts {contexts} with data {data}.
        slots:
          name: requestBody.name
          contexts: requestBody.contexts
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/uiModifications/{uiModificationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a UI modification
      effect: write
      questions:
      - How do I change the contexts or data of an existing UI modification?
      - Can I rename a UI modification my app already created?
      instructions:
      - text: Rename UI modification {uiModificationId} to {name}.
        slots:
          uiModificationId: path.uiModificationId
          name: requestBody.name
      - text: Set the contexts of UI modification {uiModificationId} to {contexts}.
        slots:
          uiModificationId: path.uiModificationId
          contexts: requestBody.contexts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rest/api/3/uiModifications/{uiModificationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a UI modification
      effect: destructive
      questions:
      - How do I remove a UI modification from my Forge app?
      - Are a UI modification's contexts deleted along with it?
      instructions:
      - text: Delete UI modification {uiModificationId}.
        slots:
          uiModificationId: path.uiModificationId
      - text: Remove UI modification {uiModificationId} and its contexts.
        slots:
          uiModificationId: path.uiModificationId
      method: generated
      generated: '2026-10-01'