Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Repositories API

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

$.info
$.paths['/repositories'].get
$.paths['/repositories/{workspace}'].get
$.paths['/repositories/{workspace}/{repo_slug}'].get
$.paths['/repositories/{workspace}/{repo_slug}'].put
$.paths['/repositories/{workspace}/{repo_slug}'].post
$.paths['/repositories/{workspace}/{repo_slug}'].delete
$.paths['/repositories/{workspace}/{repo_slug}/forks'].get
$.paths['/repositories/{workspace}/{repo_slug}/forks'].post
$.paths['/repositories/{workspace}/{repo_slug}/override-settings'].get
$.paths['/repositories/{workspace}/{repo_slug}/override-settings'].put
$.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups'].get
$.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}'].get
$.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}'].put
$.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}'].delete
$.paths['/repositories/{workspace}/{repo_slug}/permissions-config/users'].get

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 Repositories API
  version: 1.0.0
extends: openapi/atlassian-repositories-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: 20
- target: $.paths['/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List all public Bitbucket repositories
      effect: read
      questions:
      - What public repositories exist across all of Bitbucket?
      - Can I see only public repos created after a certain date?
      instructions:
      - text: List public repositories created on or after {after}.
        slots:
          after: query.after
      - text: Search all public repos matching {q}, sorted by {sort}.
        slots:
          q: query.q
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the repositories in a workspace
      effect: read
      questions:
      - Which repositories does my team's workspace own?
      - Can I list only the workspace repos where I'm a contributor?
      instructions:
      - text: List every repository in workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Show repos in {workspace} where my role is {role}.
        slots:
          workspace: path.workspace
          role: query.role
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's details
      effect: read
      questions:
      - What is the main branch, language and privacy setting of a specific repo?
      - Is a given Bitbucket repository private or public?
      instructions:
      - text: Show repository {repo_slug} in workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      - text: Get the details of {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a repository's settings
      effect: write
      questions:
      - How do I rename a repository or change its description?
      - Can I change who is allowed to fork an existing repo?
      instructions:
      - text: Change the description of {workspace}/{repo_slug} to {description}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          description: requestBody.description
      - text: Set the fork policy of existing repo {repo_slug} in {workspace} to {fork_policy}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          fork_policy: requestBody.fork_policy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new repository
      effect: write
      questions:
      - How do I create a new Bitbucket repository under a project?
      - Can I make a brand-new repo private from the start?
      instructions:
      - text: Create a new repository {repo_slug} in workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      - text: Create repo {repo_slug} in {workspace} under project {project} with private set to {is_private}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          project: requestBody.project
          is_private: requestBody.is_private
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository permanently
      effect: destructive
      questions:
      - Does deleting a repository also remove its forks?
      - Can I undo it after a repo is deleted?
      instructions:
      - text: Delete repository {repo_slug} from workspace {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      - text: Permanently remove {workspace}/{repo_slug} and leave a redirect to {redirect_to}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
          redirect_to: query.redirect_to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/forks'].get
  update:
    x-apievangelist-phrasing:
      intent: List the forks of a repository
      effect: read
      questions:
      - Who has forked a particular repository?
      - How many forks does a repo have, and can I filter them?
      instructions:
      - text: List the forks of {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show forks of {repo_slug} in {workspace} matching {q}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/forks'].post
  update:
    x-apievangelist-phrasing:
      intent: Fork a repository
      effect: write
      questions:
      - How do I fork a repo into a different workspace?
      - Can I give my fork a different name than the original?
      instructions:
      - text: Fork {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Fork repo {repo_slug} from {workspace} into {owner} with the name {name}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
          owner: requestBody.owner
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/override-settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Check which repo settings inherit from the project
      effect: read
      questions:
      - Is a repository inheriting its settings from the project or overriding them?
      - Which settings on a repo are overridden rather than inherited?
      instructions:
      - text: Show the settings inheritance state for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Check whether repo {repo_slug} in {workspace} overrides its project settings.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/override-settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set whether repo settings inherit from the project
      effect: write
      questions:
      - Can I make a repository go back to inheriting its project's settings?
      - How do I switch a repo to override inherited settings?
      instructions:
      - text: Update the settings inheritance state for {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Change repo {repo_slug} in {workspace} to override inherited project settings.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List group permissions on a repository
      effect: read
      questions:
      - Which groups have explicit access to a repository?
      - What permission level does each group hold on a repo?
      instructions:
      - text: List the group permissions on {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show every group with explicit access 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}/permissions-config/groups/{group_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one group's permission on a repository
      effect: read
      questions:
      - Does a specific group have admin, write or read on a repo?
      - What access has one particular group been granted to a repository?
      instructions:
      - text: Get group {group_slug}'s permission on {workspace}/{repo_slug}.
        slots:
          group_slug: path.group_slug
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Check what access group {group_slug} has to repo {repo_slug} in {workspace}.
        slots:
          group_slug: path.group_slug
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant or change a group's repository permission
      effect: write
      questions:
      - How do I give a group write access to a repository?
      - Can I change a group's repo access from read to admin?
      instructions:
      - text: Give group {group_slug} {permission} access to {workspace}/{repo_slug}.
        slots:
          group_slug: path.group_slug
          permission: requestBody.permission
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Set group {group_slug}'s permission on repo {repo_slug} in {workspace} to {permission}.
        slots:
          group_slug: path.group_slug
          repo_slug: path.repo_slug
          workspace: path.workspace
          permission: requestBody.permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/permissions-config/groups/{group_slug}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a group's access to a repository
      effect: destructive
      questions:
      - How do I revoke a group's explicit access to a repo?
      - Can I take a group off a repository's permission list?
      instructions:
      - text: Remove group {group_slug}'s permission from {workspace}/{repo_slug}.
        slots:
          group_slug: path.group_slug
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Revoke group {group_slug}'s explicit access to repo {repo_slug} in {workspace}.
        slots:
          group_slug: path.group_slug
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/permissions-config/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List user permissions on a repository
      effect: read
      questions:
      - Which individual users have explicit access to a repository?
      - Who has been granted direct, per-user permissions on a repo?
      instructions:
      - text: List the user permissions on {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show every user with explicit access 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}/permissions-config/users/{selected_user_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's permission on a repository
      effect: read
      questions:
      - What access does a particular person have to a repo?
      - Does a specific user hold admin rights on a repository?
      instructions:
      - text: Get user {selected_user_id}'s permission on {workspace}/{repo_slug}.
        slots:
          selected_user_id: path.selected_user_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Look up the direct per-user access level that account {selected_user_id} holds on {repo_slug} ({workspace}).
        slots:
          selected_user_id: path.selected_user_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Grant or change a user's repository permission
      effect: write
      questions:
      - How do I give one workspace member write access to a repo?
      - Can I give the workspace owner a different explicit permission on a repository?
      instructions:
      - text: Give user {selected_user_id} {permission} access to {workspace}/{repo_slug}.
        slots:
          selected_user_id: path.selected_user_id
          permission: requestBody.permission
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Change the individual account {selected_user_id} to {permission} on {repo_slug} in the {workspace} workspace.
        slots:
          selected_user_id: path.selected_user_id
          repo_slug: path.repo_slug
          workspace: path.workspace
          permission: requestBody.permission
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/permissions-config/users/{selected_user_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's access to a repository
      effect: destructive
      questions:
      - How do I revoke one person's explicit access to a repo?
      - Can I take an individual user off a repository's permissions?
      instructions:
      - text: Remove user {selected_user_id}'s permission from {workspace}/{repo_slug}.
        slots:
          selected_user_id: path.selected_user_id
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Take the individual account {selected_user_id} off the user permission list of {repo_slug} in {workspace}.
        slots:
          selected_user_id: path.selected_user_id
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/repositories/{workspace}/{repo_slug}/watchers'].get
  update:
    x-apievangelist-phrasing:
      intent: List the watchers of a repository
      effect: read
      questions:
      - Who is watching a given repository?
      - Which accounts get notified about activity on a repo?
      instructions:
      - text: List the watchers of {workspace}/{repo_slug}.
        slots:
          workspace: path.workspace
          repo_slug: path.repo_slug
      - text: Show who watches repo {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/user/permissions/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List the repositories I have explicit access to
      effect: read
      questions:
      - Which repositories do I have access to, and at what level?
      - What is my highest effective permission on each repo I can reach?
      instructions:
      - text: List my repository permissions.
      - text: Show the repos I have explicit access to matching {q}, sorted by {sort}.
        slots:
          q: query.q
          sort: query.sort
      method: generated
      generated: '2026-10-01'