# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Atlassian Bitbucket Addon API
  version: 1.0.0
extends: openapi/atlassian-addon-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: 10
- target: $.paths['/addon'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a Bitbucket Connect app installation
      effect: write
      questions:
      - How does a Bitbucket Connect app update its own installation?
      - Why does updating an installed Connect app require JWT authentication?
      instructions:
      - text: Update my Bitbucket Connect app's installation.
      - text: Refresh the installed app descriptor for my Connect app.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Uninstall a Bitbucket Connect app
      effect: destructive
      questions:
      - Can a Bitbucket Connect app remove itself for a user?
      - What authentication does deleting a Connect app installation need?
      instructions:
      - text: Delete my Bitbucket Connect app installation.
      - text: Uninstall this Connect app for the current user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers'].get
  update:
    x-apievangelist-phrasing:
      intent: List my app's linkers
      effect: read
      questions:
      - Which linkers has my Bitbucket app registered?
      - Can I see all linker modules for the authenticated app?
      instructions:
      - text: List all linkers for my Bitbucket app.
      - text: Show the linker modules my Connect app defines.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one linker for my app
      effect: read
      questions:
      - What's configured on a specific linker of my Bitbucket app?
      - Can I fetch a linker by its key?
      instructions:
      - text: Get linker {linker_key} for my app.
        slots:
          linker_key: path.linker_key
      - text: Show the configuration of linker {linker_key}.
        slots:
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}/values'].get
  update:
    x-apievangelist-phrasing:
      intent: List values for a linker
      effect: read
      questions:
      - Which values are feeding a linker's regular expression?
      - Can I see all values currently set on one linker?
      instructions:
      - text: List the values of linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Show every value plugged into linker {linker_key}'s regex.
        slots:
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}/values'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk replace a linker's values
      effect: write
      questions:
      - Can I replace all of a linker's values in one bulk update?
      - How do linker values change the linker's regular expression?
      instructions:
      - text: Bulk update the values of linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Replace the whole value set on linker {linker_key}.
        slots:
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}/values'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a value to a linker
      effect: write
      questions:
      - How do I add a single new value to my app's linker?
      - Can one more value be appended to a linker without replacing the rest?
      instructions:
      - text: Create a new value on linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Add one value to linker {linker_key}.
        slots:
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}/values'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete every value on a linker
      effect: destructive
      questions:
      - Can I wipe all values from a linker at once?
      - What's the way to clear a linker back to no values?
      instructions:
      - text: Delete all values on linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Clear every value from linker {linker_key}.
        slots:
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}/values/{value_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single linker value
      effect: read
      questions:
      - Can I fetch one specific value of a linker by its ID?
      - What does an individual linker value look like?
      instructions:
      - text: Get value {value_id} of linker {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      - text: Show linker {linker_key}'s value {value_id}.
        slots:
          linker_key: path.linker_key
          value_id: path.value_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}/values/{value_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one linker value
      effect: destructive
      questions:
      - How do I remove just one value from a linker?
      - Can I delete a single linker value and keep the others?
      instructions:
      - text: Delete value {value_id} from linker {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      - text: Remove only value {value_id} on linker {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'