Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Users API

5 actions 5 updates phrasing extends openapi/bitbucket-users-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['/user'].get

$.paths['/user/emails'].get

$.paths['/user/emails/{email}'].get

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

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 Users API
  version: 1.0.0
extends: openapi/bitbucket-users-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['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current user
      effect: read
      questions:
      - Who am I logged in as on Bitbucket?
      - Which account does my API token belong to?
      instructions:
      - text: Show my current Bitbucket user profile.
      - text: Get the account I'm authenticated as.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/emails'].get
  update:
    x-apievangelist-phrasing:
      intent: List my email addresses
      effect: read
      questions:
      - What email addresses are on my account, confirmed or not?
      - Which of my emails are still unconfirmed?
      instructions:
      - text: List all email addresses on my account.
      - text: Show my confirmed and unconfirmed emails.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/emails/{email}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check one of my email addresses
      effect: read
      questions:
      - Is this email address confirmed on my account?
      - Which of my emails is the primary one?
      instructions:
      - text: Check whether {email} is confirmed on my account.
        slots:
          email: path.email
      - text: Get the details for my email address {email}.
        slots:
          email: path.email
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's public profile
      effect: read
      questions:
      - What public information can I see about another Bitbucket user?
      - Can I look up a user by account id or UUID?
      instructions:
      - text: Get the public profile for user {selected_user}.
        slots:
          selected_user: path.selected_user
      - text: Look up account {selected_user}.
        slots:
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'