Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Reports - Commits API

10 actions 10 updates phrasing extends openapi/atlassian-reports-commits-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 10

$.info

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports'].get

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}'].get

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}'].put

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}'].delete

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations'].get

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations'].post

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}'].get

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}'].put

$.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}'].delete

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 Reports - Commits API
  version: 1.0.0
extends: openapi/atlassian-reports-commits-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: 9
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports'].get
  update:
    x-apievangelist-phrasing:
      intent: List the code insight reports on a commit
      effect: read
      questions:
      - What test, security or coverage reports are attached to a commit?
      - Which code insight reports did CI publish for a specific commit?
      instructions:
      - text: List the reports on commit {commit} in {workspace}/{repo_slug}.
        slots:
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show all insight reports for {commit} in repo {repo_slug} ({workspace}).
        slots:
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one report on a commit
      effect: read
      questions:
      - What is the result of a particular report on a commit?
      - Can I fetch a commit report by my own external ID?
      instructions:
      - text: Get report {reportId} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the status and details of report {reportId} for {commit} in {repo_slug} ({workspace}).
        slots:
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a report on a commit
      effect: write
      questions:
      - How do I publish a test or security scan result against a commit?
      - Can I create a report as pending and update its result later?
      instructions:
      - text: Create report {reportId} titled {title} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          reportId: path.reportId
          title: requestBody.title
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Set report {reportId} on {commit} in {repo_slug} ({workspace}) to result {result}.
        slots:
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
          result: requestBody.result
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report from a commit
      effect: destructive
      questions:
      - How do I remove a stale insight report from a commit?
      - Can I delete a commit report using its external ID?
      instructions:
      - text: Delete report {reportId} from commit {commit} in {workspace}/{repo_slug}.
        slots:
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the {reportId} report on {commit} in repo {repo_slug} ({workspace}).
        slots:
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations'].get
  update:
    x-apievangelist-phrasing:
      intent: List the annotations in a commit report
      effect: read
      questions:
      - What individual findings does a commit report contain?
      - Which lines of code were flagged in a particular report?
      instructions:
      - text: List annotations for report {reportId} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show every finding in report {reportId} for {commit} in {repo_slug} ({workspace}).
        slots:
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk upload annotations to a commit report
      effect: write
      questions:
      - Can I upload many code findings to a report in one request?
      - How do I attach a batch of vulnerability annotations to a commit report?
      instructions:
      - text: Bulk upload annotations to report {reportId} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Push a batch of findings into report {reportId} for {commit} in {repo_slug} ({workspace}).
        slots:
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one annotation from a commit report
      effect: read
      questions:
      - What are the details and severity of one specific annotation?
      - Can I look up a single report finding by its external ID?
      instructions:
      - text: Get annotation {annotationId} in report {reportId} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          annotationId: path.annotationId
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show finding {annotationId} from report {reportId} for {commit} in {repo_slug} ({workspace}).
        slots:
          annotationId: path.annotationId
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update one annotation in a report
      effect: write
      questions:
      - How do I flag a single line of code in a commit report?
      - Can I set the severity and file path on an individual annotation?
      instructions:
      - text: Create annotation {annotationId} on {path} line {line} in report {reportId} for commit {commit} in {workspace}/{repo_slug}.
        slots:
          annotationId: path.annotationId
          path: requestBody.path
          line: requestBody.line
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Set severity {severity} on annotation {annotationId} in report {reportId} ({commit}, {repo_slug}, {workspace}).
        slots:
          severity: requestBody.severity
          annotationId: path.annotationId
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/commit/{commit}/reports/{reportId}/annotations/{annotationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an annotation from a commit report
      effect: destructive
      questions:
      - How do I remove one finding from a commit report?
      - Can I delete a single annotation without deleting the whole report?
      instructions:
      - text: Delete annotation {annotationId} from report {reportId} on commit {commit} in {workspace}/{repo_slug}.
        slots:
          annotationId: path.annotationId
          reportId: path.reportId
          commit: path.commit
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove finding {annotationId} from report {reportId} for {commit} in {repo_slug} ({workspace}).
        slots:
          annotationId: path.annotationId
          reportId: path.reportId
          commit: path.commit
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'