# 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 Branching Model API
  version: 1.0.0
extends: openapi/atlassian-branching-model-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: 7
- target: $.paths['/repositories/{workspace}/{repo_slug}/branching-model'].get
  update:
    x-apievangelist-phrasing:
      intent: View a repository's branching model
      effect: read
      questions:
      - What development and production branches and branch prefixes does my repo use?
      - Can I see the branching model as it applies to one repository?
      instructions:
      - text: Get the branching model for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the branch types and prefixes in repository {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/branching-model/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's branching model settings
      effect: read
      questions:
      - Which raw branching model settings are configured on a repository, including disabled branch types?
      - Is my repo's development branch set to track the main branch?
      instructions:
      - text: Fetch the editable branching settings, including disabled branch types, for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the editable branching model configuration of repo {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/branching-model/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a repository's branching model
      effect: write
      questions:
      - How do I set the development branch or change branch prefixes for a repository?
      - Can I enable or disable branch types like hotfix for one repo?
      instructions:
      - text: Update the branching model settings for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Change repository {repo_slug}'s branching model configuration in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/effective-branching-model'].get
  update:
    x-apievangelist-phrasing:
      intent: See the branching model actually in effect
      effect: read
      questions:
      - Is my repository using its own branching model or inheriting the project's?
      - Which branching model is currently applied to a repo after inheritance?
      instructions:
      - text: Get the effective branching model for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show which branching model is actually applied to repository {repo_slug}.
        slots:
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/branching-model'].get
  update:
    x-apievangelist-phrasing:
      intent: View a project's branching model
      effect: read
      questions:
      - What branching model is set at the project level in Bitbucket?
      - Can I see the branch types a project hands down to its repositories?
      instructions:
      - text: Get the branching model for project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show project {project_key}'s branch types and prefixes.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/branching-model/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's branching model settings
      effect: read
      questions:
      - Which branching model settings are configured on a project, including disabled branch types?
      - Does my project's development branch track main or a specific branch?
      instructions:
      - text: Fetch the editable branching settings, including disabled branch types, for project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show project {project_key}'s editable branching configuration.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/branching-model/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a project's branching model
      effect: write
      questions:
      - How do I set a default branching model for every repo in a project?
      - Can I change the release branch prefix at the project level?
      instructions:
      - text: Update the branching model settings for project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Change project {project_key}'s branching model configuration.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'