Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Branch Restrictions API

6 actions 6 updates phrasing extends openapi/atlassian-branch-restrictions-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 6

$.info

$.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions'].get

$.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions'].post

$.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}'].get

$.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}'].put

$.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}'].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 Branch Restrictions API
  version: 1.0.0
extends: openapi/atlassian-branch-restrictions-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: 5
- target: $.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's branch restrictions
      effect: read
      questions:
      - Which branch permissions are set on my Bitbucket repository?
      - Can I filter branch restrictions by kind, like push or delete, or by branch pattern?
      instructions:
      - text: List the branch restrictions on {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show {kind} restrictions in {workspace}/{repo_slug} matching branch pattern {pattern}.
        slots:
          kind: query.kind
          workspace: path.workspace
          repo_slug: path.repo_slug
          pattern: query.pattern
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a branch restriction rule
      effect: write
      questions:
      - How do I stop people from force-pushing to main?
      - Can I require approvals or completed tasks before merging into a branch?
      instructions:
      - text: Create a branch restriction in {workspace}/{repo_slug} allowing only users {users} to push.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          users: requestBody.users
      - text: Add a branch restriction rule to repository {repo_slug} in {workspace} for groups {groups}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          groups: requestBody.groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one branch restriction rule
      effect: read
      questions:
      - What does a specific branch restriction rule enforce?
      - Can I look up one branch permission rule by its ID?
      instructions:
      - text: Get branch restriction {id} in {workspace}/{repo_slug}.
        slots:
          id: path.id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show me the details of branch rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a branch restriction rule
      effect: write
      questions:
      - Can I add more users to an existing branch restriction?
      - Do fields I leave out when updating a branch rule stay unchanged?
      instructions:
      - text: Update branch restriction {id} in {workspace}/{repo_slug} to allow users {users}.
        slots:
          id: path.id
          workspace: path.workspace
          repo_slug: path.repo_slug
          users: requestBody.users
      - text: Change branch rule {id} to exempt groups {groups}.
        slots:
          id: path.id
          groups: requestBody.groups
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/branch-restrictions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a branch restriction rule
      effect: destructive
      questions:
      - Can I lift a branch restriction so anyone can push again?
      - What's the way to remove one branch permission rule?
      instructions:
      - text: Delete branch restriction {id} from {workspace}/{repo_slug}.
        slots:
          id: path.id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Remove branch rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'