Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket GPG API

5 actions 5 updates phrasing extends openapi/bitbucket-gpg-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 5

$.info
$.paths['/users/{selected_user}/gpg-keys'].get
$.paths['/users/{selected_user}/gpg-keys'].post
$.paths['/users/{selected_user}/gpg-keys/{fingerprint}'].get
$.paths['/users/{selected_user}/gpg-keys/{fingerprint}'].delete

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitbucket GPG API
  version: 1.0.0
extends: openapi/bitbucket-gpg-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: 4
- target: $.paths['/users/{selected_user}/gpg-keys'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's GPG keys
      effect: read
      questions:
      - Which GPG keys are registered on my account for signing commits?
      - Can I see a user's GPG public keys?
      instructions:
      - text: List GPG keys for user {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Show all GPG public keys on account {selected_user}.
        slots:
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/gpg-keys'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a GPG key to a user
      effect: write
      questions:
      - How do I add a GPG key so my signed commits show as verified?
      - Can I upload a GPG public key with a name?
      instructions:
      - text: Add GPG public key {key} to user {selected_user}.
        slots:
          key: requestBody.key
          selected_user: path.selected_user
      - text: Register GPG key {key} named {name} on {selected_user}.
        slots:
          key: requestBody.key
          name: requestBody.name
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/gpg-keys/{fingerprint}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a GPG key by fingerprint
      effect: read
      questions:
      - Can I look up one GPG key by its fingerprint?
      - When does a particular GPG key expire and when was it last used?
      instructions:
      - text: Get GPG key {fingerprint} for user {selected_user}.
        slots:
          fingerprint: path.fingerprint
          selected_user: path.selected_user
      - text: Show GPG key {fingerprint} details.
        slots:
          fingerprint: path.fingerprint
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/gpg-keys/{fingerprint}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a GPG key
      effect: destructive
      questions:
      - How do I remove a compromised GPG key from my account?
      - Can I delete a GPG key by fingerprint?
      instructions:
      - text: Delete GPG key {fingerprint} from user {selected_user}.
        slots:
          fingerprint: path.fingerprint
          selected_user: path.selected_user
      - text: Remove GPG key {fingerprint} from my account {selected_user}.
        slots:
          fingerprint: path.fingerprint
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'