Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Source - Repositories API

5 actions 5 updates phrasing extends openapi/atlassian-source-repositories-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 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

# 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 Source - Repositories API
  version: 1.0.0
extends: openapi/atlassian-source-repositories-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:
      - Which commits touched a specific file in my Bitbucket repo, newest first?
      - Does the file history follow the file across renames?
      instructions:
      - text: Show the history 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 commits that modified {path} from {commit} in repo {repo_slug}, workspace {workspace}, without following renames: {renames}.'
        slots:
          path: path.path
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
          renames: query.renames
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/src'].get
  update:
    x-apievangelist-phrasing:
      intent: Browse the root folder of the main branch
      effect: read
      questions:
      - How do I see the top-level files of a repo's main branch without knowing its commit hash?
      - Can I get the root directory listing of a Bitbucket repository as metadata?
      instructions:
      - text: List the root directory of the main branch in {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the top-level files of repo {repo_slug} in {workspace} in {format} format.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          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 commit a file to a Bitbucket repo without cloning it?
      - How do I delete a file from a branch with a commit made through the API?
      instructions:
      - text: Commit an uploaded file to branch {branch} of {workspace}/{repo_slug} with message {message}.
        slots:
          branch: query.branch
          workspace: path.workspace
          repo_slug: path.repo_slug
          message: query.message
      - text: Create a commit in repo {repo_slug}, workspace {workspace}, removing files {files}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          files: query.files
      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:
      - How do I read the raw contents of a file at a given commit in Bitbucket?
      - Can I list a directory recursively at a specific branch or tag?
      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 revision {commit} in repo {repo_slug}, workspace {workspace}, to depth {max_depth}.
        slots:
          path: path.path
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
          max_depth: query.max_depth
      method: generated
      generated: '2026-10-01'