Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Bitbucket Workspaces API

10 actions 10 updates phrasing extends openapi/atlassian-workspaces-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 10

$.info
$.paths['/user/permissions/workspaces'].get
$.paths['/workspaces'].get
$.paths['/workspaces/{workspace}'].get
$.paths['/workspaces/{workspace}/members'].get
$.paths['/workspaces/{workspace}/members/{member}'].get
$.paths['/workspaces/{workspace}/permissions'].get
$.paths['/workspaces/{workspace}/permissions/repositories'].get
$.paths['/workspaces/{workspace}/permissions/repositories/{repo_slug}'].get
$.paths['/workspaces/{workspace}/projects'].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 Workspaces API
  version: 1.0.0
extends: openapi/atlassian-workspaces-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: 9
- target: $.paths['/user/permissions/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List my workspace memberships and roles
      effect: read
      questions:
      - Which Bitbucket workspaces am I a member of and what's my highest role in each?
      - Can I see my effective permission level per workspace?
      instructions:
      - text: List my workspace memberships with my role in each.
      - text: Show my workspace permissions matching {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List workspaces I can access
      effect: read
      questions:
      - What workspaces can I access?
      - Can I list only private workspaces or the ones where I'm an owner?
      instructions:
      - text: List the workspaces I can access.
      - text: List workspaces where my role is {role}, sorted by {sort}.
        slots:
          role: query.role
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a workspace
      effect: read
      questions:
      - How do I fetch details about a Bitbucket workspace?
      - What information comes back for a single workspace?
      instructions:
      - text: Get workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Show the details of workspace {workspace}.
        slots:
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members of a workspace
      effect: read
      questions:
      - Who are the members of a workspace?
      - How do I get everyone in a Bitbucket workspace?
      instructions:
      - text: List members of workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Show everyone in {workspace}.
        slots:
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/members/{member}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's membership in a workspace
      effect: read
      questions:
      - Is a particular user a member of this workspace?
      - How do I fetch a single member's workspace membership record?
      instructions:
      - text: Get the membership of {member} in workspace {workspace}.
        slots:
          member: path.member
          workspace: path.workspace
      - text: Check whether {member} belongs to {workspace}.
        slots:
          member: path.member
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List members' permission levels in a workspace
      effect: read
      questions:
      - What permission level does each member have in a workspace?
      - Can I find just the owners of a workspace?
      instructions:
      - text: List member permissions in workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Show workspace {workspace} permissions matching {q}.
        slots:
          workspace: path.workspace
          q: query.q
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/permissions/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List repo permissions across a workspace
      effect: read
      questions:
      - Who has access to which repositories across my whole workspace?
      - Can I filter workspace repository permissions to admins only?
      instructions:
      - text: List repository permissions for all repos in {workspace}.
        slots:
          workspace: path.workspace
      - text: Show repository permissions in {workspace} matching {q}, sorted by {sort}.
        slots:
          workspace: path.workspace
          q: query.q
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/permissions/repositories/{repo_slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: List user permissions on one repository
      effect: read
      questions:
      - Who can read or write a specific repository?
      - What's each user's effective permission on one repo?
      instructions:
      - text: List user permissions on repository {repo_slug} in {workspace}.
        slots:
          repo_slug: path.repo_slug
          workspace: path.workspace
      - text: Show who has {q} access to repo {repo_slug} in {workspace}.
        slots:
          q: query.q
          repo_slug: path.repo_slug
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects in a workspace
      effect: read
      questions:
      - What projects exist in a Bitbucket workspace?
      - How do I see all the projects that group repositories in my workspace?
      instructions:
      - text: List projects in workspace {workspace}.
        slots:
          workspace: path.workspace
      - text: Show me the projects under {workspace}.
        slots:
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'