Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Ssh API

6 actions 6 updates phrasing extends openapi/atlassian-ssh-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 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 Atlassian Bitbucket Ssh API
  version: 1.0.0
extends: openapi/atlassian-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 public keys are registered on a Bitbucket account?
      - Can I see all the SSH keys a user has added?
      instructions:
      - text: List the SSH keys for user {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Show every SSH public key on {selected_user}'s Bitbucket account.
        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 account
      effect: write
      questions:
      - How do I register a new SSH public key on my Bitbucket account?
      - Can I add an ed25519 key through the API?
      instructions:
      - text: Add a new SSH public key to user {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Register my laptop's SSH key on {selected_user}'s Bitbucket account.
        slots:
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/ssh-keys/{key_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one SSH key
      effect: read
      questions:
      - What are the details of one specific SSH key on an account?
      - When was a particular SSH key added and what's its comment?
      instructions:
      - text: Get SSH key {key_id} for user {selected_user}.
        slots:
          key_id: path.key_id
          selected_user: path.selected_user
      - text: Show the comment and fingerprint of {selected_user}'s key {key_id}.
        slots:
          selected_user: path.selected_user
          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:
      - Can I change the label on an SSH key without re-adding it?
      - Is the comment the only part of an SSH key I can edit?
      instructions:
      - text: Update the comment on SSH key {key_id} for user {selected_user}.
        slots:
          key_id: path.key_id
          selected_user: path.selected_user
      - text: Relabel {selected_user}'s SSH key {key_id} as my work machine.
        slots:
          selected_user: path.selected_user
          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 a lost laptop?
      - Can I remove a single SSH key from a user's account?
      instructions:
      - text: Delete SSH key {key_id} from user {selected_user}.
        slots:
          key_id: path.key_id
          selected_user: path.selected_user
      - text: Revoke {selected_user}'s SSH key {key_id}.
        slots:
          selected_user: path.selected_user
          key_id: path.key_id
      method: generated
      generated: '2026-10-01'