Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Commit Statuses API

5 actions 5 updates phrasing extends openapi/atlassian-commit-statuses-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}/commit/{commit}/statuses'].get
$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build'].post
$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}'].get
$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}'].put

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 Atlassian Bitbucket Commit Statuses API
  version: 1.0.0
extends: openapi/atlassian-commit-statuses-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}/commit/{commit}/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: List build statuses on a commit
      effect: read
      questions:
      - Did CI pass on this commit?
      - Can I filter a commit's statuses to only failed builds?
      instructions:
      - text: List the statuses for commit {commit} in {workspace}/{repo_slug}.
        slots:
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show build results on commit {commit} matching {q}.
        slots:
          commit: path.commit
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build'].post
  update:
    x-apievangelist-phrasing:
      intent: Report a build status on a commit
      effect: write
      questions:
      - How does my CI server post a build result to a commit?
      - What happens if I report a build status with a key that already exists?
      instructions:
      - text: Report build {key} as {state} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          key: requestBody.key
          state: requestBody.state
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Add a new build status {name} linking to {url} for commit {commit}.
        slots:
          name: requestBody.name
          url: requestBody.url
          commit: path.commit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one build status on a commit
      effect: read
      questions:
      - What's the state of a specific CI build key on a commit?
      - How do I read one build status by its key?
      instructions:
      - text: Get build status {key} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          key: path.key
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me the result of build {key} for commit {commit}.
        slots:
          key: path.key
          commit: path.commit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/statuses/build/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing build status on a commit
      effect: write
      questions:
      - How do I flip a commit's in-progress build to successful when CI finishes?
      - Can I change the URL or description of a build status I already posted?
      instructions:
      - text: Set existing build {key} on commit {commit} in {workspace}/{repo_slug} to {state}.
        slots:
          key: path.key
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
          state: requestBody.state
      - text: Update the description of build {key} on {commit} to {description}.
        slots:
          key: path.key
          commit: path.commit
          description: requestBody.description
      method: generated
      generated: '2026-10-01'