# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitbucket Addon API
  version: 1.0.0
extends: openapi/bitbucket-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 an installed Connect app
      effect: write
      questions:
      - How does a Bitbucket Connect app update its own installation?
      - Can my app refresh its installation details using its JWT?
      instructions:
      - text: Update my Connect app's installation for this user.
      - text: Push the new installation settings for our installed Connect app.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Uninstall a Connect app
      effect: destructive
      questions:
      - How can a Connect app remove its own installation for a user?
      - What happens when an app deletes itself from Bitbucket?
      instructions:
      - text: Uninstall our Connect app for the current user.
      - text: Delete this app's installation entirely.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's linkers
      effect: read
      questions:
      - Which linkers has my Connect app registered?
      - Can I see every linker my app defines before they are removed in 2026?
      instructions:
      - text: List all linkers for my authenticated app.
      - text: Show me every linker key my Connect app registered.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/addon/linkers/{linker_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one linker of an app
      effect: read
      questions:
      - What does a single app linker look like, including its regex?
      - Can I inspect one linker by its key?
      instructions:
      - text: Get linker {linker_key} for my app.
        slots:
          linker_key: path.linker_key
      - text: Show the details of the {linker_key} linker.
        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 the values of a linker
      effect: read
      questions:
      - What values currently feed into my linker's regular expression?
      - Which substitution values does a linker hold right now?
      instructions:
      - text: List all values for linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Show the regex values configured on linker {linker_key}.
        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 call?
      - How do I bulk update the values my linker matches on?
      instructions:
      - text: Bulk update the values of linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Overwrite every value on linker {linker_key} with the new set.
        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 one more value to my app's linker?
      - Can a new linker value extend what the regex matches?
      instructions:
      - text: Add a new value to linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Create a linker value on {linker_key} for my app.
        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 all values of a linker
      effect: destructive
      questions:
      - How do I clear every value from a linker at once?
      - Is there a way to wipe all of a linker's values together?
      instructions:
      - text: Delete all values from linker {linker_key}.
        slots:
          linker_key: path.linker_key
      - text: Clear every value on the {linker_key} linker.
        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 just one value of a linker by its id?
      - What is stored in a specific linker value?
      instructions:
      - text: Get value {value_id} of linker {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      - text: Show linker value {value_id} on {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      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 a single value from a linker without touching the others?
      - Can I delete one linker value by id?
      instructions:
      - text: Delete value {value_id} from linker {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      - text: Remove only linker value {value_id} on {linker_key}.
        slots:
          value_id: path.value_id
          linker_key: path.linker_key
      method: generated
      generated: '2026-10-01'