Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Source API

5 actions 5 updates phrasing extends openapi/bitbucket-source-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['/repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}'].get
$.paths['/repositories/{workspace}/{repo_slug}/src'].get
$.paths['/repositories/{workspace}/{repo_slug}/src'].post
$.paths['/repositories/{workspace}/{repo_slug}/src/{commit}/{path}'].get

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 Source API
  version: 1.0.0
extends: openapi/bitbucket-source-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['/repositories/{workspace}/{repo_slug}/filehistory/{commit}/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: List commits that changed a file
      effect: read
      questions:
      - Who changed this file and when?
      - Can the file history follow renames?
      instructions:
      - text: List commits that modified {path} as of {commit} in {workspace}/{repo_slug}.
        slots:
          path: path.path
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the history of {path} at {commit}, following renames {renames}.
        slots:
          path: path.path
          commit: path.commit
          renames: query.renames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/src'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the main branch root directory
      effect: read
      questions:
      - What files are at the top level of my repo's main branch?
      - Can I browse the root of a repository without knowing a commit hash?
      instructions:
      - text: Show the root directory of the main branch in {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Browse the top-level files of {repo_slug} as {format}.
        slots:
          repo_slug: path.repo_slug
          format: query.format
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/src'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit files by uploading them
      effect: write
      questions:
      - Can I make a commit by uploading a file, without git?
      - How do I commit a file to a specific branch with a message?
      instructions:
      - text: Upload files to {workspace}/{repo_slug} as a new commit with message {message}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          message: query.message
      - text: Commit uploaded files to branch {branch} with author {author}.
        slots:
          branch: query.branch
          author: query.author
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/src/{commit}/{path}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a file or directory at a revision
      effect: read
      questions:
      - What did this file look like at an older commit?
      - Can I list a directory's contents several levels deep?
      instructions:
      - text: Get the contents of {path} at {commit} in {workspace}/{repo_slug}.
        slots:
          path: path.path
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: List directory {path} at {commit} up to depth {max_depth}.
        slots:
          path: path.path
          commit: path.commit
          max_depth: query.max_depth
      method: generated
      generated: '2026-10-01'