# 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 UI modifications (apps) API
  version: 1.0.0
extends: openapi/jira-ui-modifications-apps-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: 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?
      - Can I include each UI modification's contexts in the listing?
      instructions:
      - text: List my app's UI modifications.
      - text: Show my UI modifications with {expand} expanded.
        slots:
          expand: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/uiModifications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a UI modification
      effect: write
      questions:
      - How do I create a UI modification for my Forge app?
      - 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} applied to contexts {contexts}.
        slots:
          name: requestBody.name
          contexts: requestBody.contexts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/uiModifications/{uiModificationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a UI modification
      effect: write
      questions:
      - Can I change the contexts or data of an existing UI modification?
      - Is it possible to rename a UI modification after creating it?
      instructions:
      - text: Rename UI modification {uiModificationId} to {name}.
        slots:
          uiModificationId: path.uiModificationId
          name: requestBody.name
      - text: Set UI modification {uiModificationId}'s contexts to {contexts}.
        slots:
          uiModificationId: path.uiModificationId
          contexts: requestBody.contexts
      method: generated
      generated: '2026-09-26'
- target: $.paths['/rest/api/3/uiModifications/{uiModificationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a UI modification
      effect: destructive
      questions:
      - Can I delete a UI modification my Forge app no longer needs?
      - Are a UI modification's contexts removed when it's deleted?
      instructions:
      - text: Delete UI modification {uiModificationId}.
        slots:
          uiModificationId: path.uiModificationId
      - text: Remove UI modification {uiModificationId} and all its contexts.
        slots:
          uiModificationId: path.uiModificationId
      method: generated
      generated: '2026-09-26'