Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Projects API

17 actions 17 updates phrasing extends openapi/bitbucket-projects-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 17 · first 16 shown; the file carries all of them

$.info
$.paths['/workspaces/{workspace}/projects'].post
$.paths['/workspaces/{workspace}/projects/{project_key}'].get
$.paths['/workspaces/{workspace}/projects/{project_key}'].put
$.paths['/workspaces/{workspace}/projects/{project_key}'].delete
$.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers'].get
$.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}'].get
$.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}'].put
$.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}'].delete
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups'].get
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}'].get
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}'].put
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}'].delete
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users'].get
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}'].get
$.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}'].put

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 Projects API
  version: 1.0.0
extends: openapi/bitbucket-projects-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: 16
- target: $.paths['/workspaces/{workspace}/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project in a workspace
      effect: write
      questions:
      - How do I create a new project to group repositories?
      - Can I make a project private when I create it?
      instructions:
      - text: Create project {name} with key {key} in {workspace}.
        slots:
          name: requestBody.name
          key: requestBody.key
          workspace: path.workspace
      - text: Create a private project {name} in {workspace} described as {description}.
        slots:
          name: requestBody.name
          workspace: path.workspace
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project
      effect: read
      questions:
      - What are the details of a Bitbucket project?
      - Is a given project private?
      instructions:
      - text: Get project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show the description and visibility of project {project_key}.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update or create a project by key
      effect: write
      questions:
      - How do I rename an existing project?
      - Can I change a project's key or description?
      instructions:
      - text: Rename project {project_key} in {workspace} to {name}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
          name: requestBody.name
      - text: Update project {project_key}'s description to {description}.
        slots:
          project_key: path.project_key
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project
      effect: destructive
      questions:
      - How do I delete an empty project?
      - Can I delete a project that still has repositories in it?
      instructions:
      - text: Delete project {project_key} from {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Permanently remove the empty project {project_key}.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's default reviewers
      effect: read
      questions:
      - Who gets added automatically as a reviewer on PRs across a project?
      - Which users are project-level default reviewers?
      instructions:
      - text: List default reviewers for project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show who is auto-added to PRs in project {project_key}.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a project default reviewer
      effect: read
      questions:
      - Is a particular user a default reviewer for this project?
      - Can I confirm one person is on a project's reviewer list?
      instructions:
      - text: Check whether {selected_user} is a default reviewer on project {project_key} in {workspace}.
        slots:
          selected_user: path.selected_user
          project_key: path.project_key
          workspace: path.workspace
      - text: Get project default reviewer {selected_user} for {project_key}.
        slots:
          selected_user: path.selected_user
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a project default reviewer
      effect: write
      questions:
      - How do I make someone a default reviewer for every repo in a project?
      - Can I add a reviewer to all PRs in a project automatically?
      instructions:
      - text: Add {selected_user} as a default reviewer on project {project_key} in {workspace}.
        slots:
          selected_user: path.selected_user
          project_key: path.project_key
          workspace: path.workspace
      - text: Make {selected_user} a project-wide default reviewer for {project_key}.
        slots:
          selected_user: path.selected_user
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/default-reviewers/{selected_user}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a project default reviewer
      effect: destructive
      questions:
      - How do I stop someone being auto-added to PRs across a project?
      - Can I take a user off a project's default reviewers?
      instructions:
      - text: Remove {selected_user} from the default reviewers of project {project_key} in {workspace}.
        slots:
          selected_user: path.selected_user
          project_key: path.project_key
          workspace: path.workspace
      - text: Drop {selected_user} as project default reviewer on {project_key}.
        slots:
          selected_user: path.selected_user
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List group permissions on a project
      effect: read
      questions:
      - Which groups have explicit access to this project?
      - What permission level does each group hold on a project?
      instructions:
      - text: List group permissions on project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show which groups can access project {project_key}.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a group's permission on a project
      effect: read
      questions:
      - What access does one group have on a project?
      - Does a given group have admin or write on this project?
      instructions:
      - text: Get the permission of group {group_slug} on project {project_key} in {workspace}.
        slots:
          group_slug: path.group_slug
          project_key: path.project_key
          workspace: path.workspace
      - text: Check group {group_slug}'s access to {project_key}.
        slots:
          group_slug: path.group_slug
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a group's permission on a project
      effect: write
      questions:
      - How do I give a group write access to a project?
      - Can I grant a group create-repo rights on a project?
      instructions:
      - text: Give group {group_slug} {permission} access to project {project_key} in {workspace}.
        slots:
          group_slug: path.group_slug
          permission: requestBody.permission
          project_key: path.project_key
          workspace: path.workspace
      - text: Set group {group_slug}'s project permission to {permission}.
        slots:
          group_slug: path.group_slug
          permission: requestBody.permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/groups/{group_slug}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a group's project permission
      effect: destructive
      questions:
      - How do I remove a group's access to a project?
      - Can I revoke a group's explicit permission on a project?
      instructions:
      - text: Revoke group {group_slug}'s permission on project {project_key} in {workspace}.
        slots:
          group_slug: path.group_slug
          project_key: path.project_key
          workspace: path.workspace
      - text: Remove group {group_slug} from project {project_key} access.
        slots:
          group_slug: path.group_slug
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List user permissions on a project
      effect: read
      questions:
      - Which individual users have explicit access to a project?
      - Who are the admins of this project?
      instructions:
      - text: List user permissions on project {project_key} in {workspace}.
        slots:
          project_key: path.project_key
          workspace: path.workspace
      - text: Show individual users with access to {project_key}.
        slots:
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's permission on a project
      effect: read
      questions:
      - What access does one person have on a project?
      - Is a given user an admin on this project?
      instructions:
      - text: Get the permission of user {selected_user_id} on project {project_key} in {workspace}.
        slots:
          selected_user_id: path.selected_user_id
          project_key: path.project_key
          workspace: path.workspace
      - text: Check user {selected_user_id}'s access to {project_key}.
        slots:
          selected_user_id: path.selected_user_id
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a user's permission on a project
      effect: write
      questions:
      - How do I give one teammate admin on a project?
      - Can I change a user's project access to read only?
      instructions:
      - text: Give user {selected_user_id} {permission} access to project {project_key} in {workspace}.
        slots:
          selected_user_id: path.selected_user_id
          permission: requestBody.permission
          project_key: path.project_key
          workspace: path.workspace
      - text: Set user {selected_user_id}'s project permission to {permission}.
        slots:
          selected_user_id: path.selected_user_id
          permission: requestBody.permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects/{project_key}/permissions-config/users/{selected_user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Revoke a user's project permission
      effect: destructive
      questions:
      - How do I remove one person's explicit access to a project?
      - Can I revoke a user's permission on a project?
      instructions:
      - text: Revoke user {selected_user_id}'s permission on project {project_key} in {workspace}.
        slots:
          selected_user_id: path.selected_user_id
          project_key: path.project_key
          workspace: path.workspace
      - text: Remove user {selected_user_id} from project {project_key} access.
        slots:
          selected_user_id: path.selected_user_id
          project_key: path.project_key
      method: generated
      generated: '2026-10-01'