# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitbucket Branching model API
  version: 1.0.0
extends: openapi/bitbucket-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: Get a repository's branching model
      effect: read
      questions:
      - What are the development and production branches for this repo?
      - Which branch type prefixes does my repository use, like feature/ or hotfix/?
      instructions:
      - text: Show the branching model applied to {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Get the development and production branches of {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}/branching-model/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's branching model config
      effect: read
      questions:
      - How is the branching model configured for my repo, including disabled branch types?
      - Can I see the raw branching model settings for a repository?
      instructions:
      - text: Get the branching model settings for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the branching model configuration of 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}/branching-model/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a repository's branching model config
      effect: write
      questions:
      - How do I change the development branch for my repository?
      - Can I enable a production branch or change branch prefixes on one repo?
      instructions:
      - text: Update the branching model settings for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Set repo {repo_slug} in {workspace} to track the main branch for development.
        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: Get a repo's effective branching model
      effect: read
      questions:
      - Which branching model is actually in effect for my repo, repo or project level?
      - Is my repository inheriting its project's branching model?
      instructions:
      - text: Get the effective branching model for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show the branching model currently applied to {repo_slug} in {workspace}, inherited or not.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/branching-model'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project's branching model
      effect: read
      questions:
      - What branching model is set at the project level?
      - Which branch prefixes does a Bitbucket project define for its repos?
      instructions:
      - text: Show the branching model of project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Get the project-level development branch for {project_key}.
        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 config
      effect: read
      questions:
      - How is the branching model configured for a whole project?
      - Can I read a project's branching model settings including disabled types?
      instructions:
      - text: Get the branching model settings for project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show project {project_key}'s branching model 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: Update a project's branching model config
      effect: write
      questions:
      - How do I set a default branching model for every repo in a project?
      - Can I change a project's branch prefixes?
      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 development branch setting.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'