Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Downloads API

5 actions 5 updates phrasing extends openapi/bitbucket-downloads-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}/downloads'].get
$.paths['/repositories/{workspace}/{repo_slug}/downloads'].post
$.paths['/repositories/{workspace}/{repo_slug}/downloads/{filename}'].get
$.paths['/repositories/{workspace}/{repo_slug}/downloads/{filename}'].delete

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 Downloads API
  version: 1.0.0
extends: openapi/bitbucket-downloads-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}/downloads'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's download artifacts
      effect: read
      questions:
      - What files are published in my repo's Downloads section?
      - Can I see all download artifacts attached to a repository?
      instructions:
      - text: List download artifacts for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show every file in the Downloads area of {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/downloads'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a download artifact
      effect: write
      questions:
      - How do I upload a release binary to my repo's Downloads?
      - Can I attach several files to Downloads in one upload?
      instructions:
      - text: Upload a file to the Downloads of {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Publish this build artifact to {repo_slug}'s Downloads.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/downloads/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a repository artifact file
      effect: read
      questions:
      - How do I fetch the contents of a file from a repo's Downloads?
      - Can I download a specific artifact by its filename?
      instructions:
      - text: Download {filename} from {workspace}/{repo_slug}.
        slots:
          filename: path.filename
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Get the file contents of download artifact {filename}.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/downloads/{filename}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a download artifact
      effect: destructive
      questions:
      - How do I remove an old file from Downloads?
      - Can I delete a published download artifact?
      instructions:
      - text: Delete download artifact {filename} from {workspace}/{repo_slug}.
        slots:
          filename: path.filename
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove {filename} from the Downloads of {repo_slug}.
        slots:
          filename: path.filename
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'