Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Downloads API

5 actions 5 updates phrasing extends openapi/atlassian-downloads-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}/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 Atlassian Bitbucket Downloads API
  version: 1.0.0
extends: openapi/atlassian-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 a Bitbucket repo's Downloads section?
      - Can I list the download links for a repository?
      instructions:
      - text: List the downloads for repository {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show all download artifacts attached to repo {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/downloads'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a file to a repository's downloads
      effect: write
      questions:
      - How do I publish a release binary to a Bitbucket repository's Downloads?
      - Can I upload several files to repo downloads in one request?
      instructions:
      - text: Upload this file to the downloads of {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Publish the build artifacts to repo {repo_slug} downloads in workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/downloads/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a repository download artifact
      effect: read
      questions:
      - How do I fetch the actual contents of a file in a repo's Downloads?
      - Does getting a download artifact return the file or just metadata?
      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 {filename} in repo {repo_slug}, workspace {workspace}.
        slots:
          filename: path.filename
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/downloads/{filename}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository download artifact
      effect: destructive
      questions:
      - How do I remove an old file from a repo's Downloads?
      - Can I delete a single download artifact by filename?
      instructions:
      - text: Delete download {filename} from {workspace}/{repo_slug}.
        slots:
          filename: path.filename
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove the outdated artifact {filename} from repo {repo_slug} in {workspace}.
        slots:
          filename: path.filename
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'