Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket SSH API

6 actions 6 updates phrasing extends openapi/bitbucket-ssh-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Bitbucket's API. It is a proposal applied on top of the contract, not a document Bitbucket publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/users/{selected_user}/ssh-keys'].get

$.paths['/users/{selected_user}/ssh-keys'].post

$.paths['/users/{selected_user}/ssh-keys/{key_id}'].get

$.paths['/users/{selected_user}/ssh-keys/{key_id}'].put

$.paths['/users/{selected_user}/ssh-keys/{key_id}'].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 Bitbucket SSH API
  version: 1.0.0
extends: openapi/bitbucket-ssh-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: 5
- target: $.paths['/users/{selected_user}/ssh-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's SSH keys
      effect: read
      questions:
      - Which SSH keys are on my Bitbucket account?
      - Can I audit a user's SSH public keys?
      instructions:
      - text: List SSH keys for user {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Show every SSH public key on account {selected_user}.
        slots:
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/ssh-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an SSH key to a user
      effect: write
      questions:
      - How do I add a new SSH key to my account?
      - Can I set an expiry date on an SSH key when adding it?
      instructions:
      - text: Add an SSH key to user {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Add an SSH key to {selected_user} that expires on {expires_on}.
        slots:
          selected_user: path.selected_user
          expires_on: query.expires_on
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/ssh-keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an SSH key
      effect: read
      questions:
      - Can I look up one SSH key by its id?
      - What is the fingerprint and comment on a particular SSH key?
      instructions:
      - text: Get SSH key {key_id} for user {selected_user}.
        slots:
          key_id: path.key_id
          selected_user: path.selected_user
      - text: Show SSH key {key_id}'s fingerprint.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/ssh-keys/{key_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an SSH key's comment
      effect: write
      questions:
      - How do I change the label on an existing SSH key?
      - Which fields of an SSH key can be edited after it is added?
      instructions:
      - text: Update the comment on SSH key {key_id} for {selected_user}.
        slots:
          key_id: path.key_id
          selected_user: path.selected_user
      - text: Relabel existing SSH key {key_id}.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/ssh-keys/{key_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an SSH key
      effect: destructive
      questions:
      - How do I revoke an SSH key from my account?
      - Can I remove an old laptop's SSH key?
      instructions:
      - text: Delete SSH key {key_id} from user {selected_user}.
        slots:
          key_id: path.key_id
          selected_user: path.selected_user
      - text: Remove SSH key {key_id} from my account.
        slots:
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'