Bitbucket · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitbucket Search API

4 actions 4 updates phrasing extends openapi/bitbucket-search-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 4

$.info

$.paths['/teams/{username}/search/code'].get

$.paths['/users/{selected_user}/search/code'].get

$.paths['/workspaces/{workspace}/search/code'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Bitbucket Search API
  version: 1.0.0
extends: openapi/bitbucket-search-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: 3
- target: $.paths['/teams/{username}/search/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Search code across a team's repositories
      effect: read
      questions:
      - How do I find where a function is used across all of my team's repos?
      - Can code search match file paths as well as file contents for a team?
      instructions:
      - text: Search team {username}'s repositories for {search_query}.
        slots:
          username: path.username
          search_query: query.search_query
      - text: Find code matching {search_query} across team {username}, {pagelen} results per page.
        slots:
          search_query: query.search_query
          username: path.username
          pagelen: query.pagelen
      method: generated
      generated: '2026-10-01'
- target: $.paths['/users/{selected_user}/search/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Search code in a user's repositories
      effect: read
      questions:
      - How can I search the code in one user's personal repositories?
      - Is there a way to grep a specific developer's repos for a string?
      instructions:
      - text: Search user {selected_user}'s repositories for {search_query}.
        slots:
          selected_user: path.selected_user
          search_query: query.search_query
      - text: Find code matching {search_query} in repos owned by {selected_user}, page {page}.
        slots:
          search_query: query.search_query
          selected_user: path.selected_user
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/search/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Search code across a workspace
      effect: read
      questions:
      - Where in my workspace is a particular config key referenced?
      - Can I search every repository in a workspace for a code snippet?
      instructions:
      - text: Search workspace {workspace} for code matching {search_query}.
        slots:
          workspace: path.workspace
          search_query: query.search_query
      - text: Find {search_query} in all repos of workspace {workspace}, {pagelen} per page.
        slots:
          search_query: query.search_query
          workspace: path.workspace
          pagelen: query.pagelen
      method: generated
      generated: '2026-10-01'