Atlassian · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Atlassian Search API

6 actions 6 updates phrasing extends openapi/atlassian-search-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 6

$.info

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

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

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

$.paths['/wiki/rest/api/search'].get

$.paths['/wiki/rest/api/search/user'].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 Atlassian Search API
  version: 1.0.0
extends: openapi/atlassian-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: 5
- target: $.paths['/teams/{username}/search/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Search code in a team's repositories
      effect: read
      questions:
      - Can I search all of a Bitbucket team's repos for a code snippet?
      - Does Bitbucket team code search match file paths as well as contents?
      instructions:
      - text: Search team {username}'s repositories for {search_query}.
        slots:
          username: path.username
          search_query: query.search_query
      - text: Find {search_query} in code 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:
      - Can I grep a single Bitbucket user's repositories for some code?
      - What query syntax works for searching a user's repos?
      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}.
        slots:
          search_query: query.search_query
          selected_user: path.selected_user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/workspaces/{workspace}/search/code'].get
  update:
    x-apievangelist-phrasing:
      intent: Search code in a workspace
      effect: read
      questions:
      - How do I search code across every repository in a Bitbucket workspace?
      - Can workspace code search match on file path only?
      instructions:
      - text: Search workspace {workspace} code for {search_query}.
        slots:
          workspace: path.workspace
          search_query: query.search_query
      - text: Get page {page} of code matches for {search_query} in workspace {workspace}.
        slots:
          page: query.page
          search_query: query.search_query
          workspace: path.workspace
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Confluence content with CQL
      effect: read
      questions:
      - How can I find Confluence pages using a CQL query?
      - Can a Confluence content search include archived spaces?
      instructions:
      - text: Search Confluence content with CQL {cql}.
        slots:
          cql: query.cql
      - text: Run CQL {cql} and return {limit} results including archived spaces {includeArchivedSpaces}.
        slots:
          cql: query.cql
          limit: query.limit
          includeArchivedSpaces: query.includeArchivedSpaces
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/search/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Confluence users with CQL
      effect: read
      questions:
      - Can I find Confluence users with a user-specific CQL query?
      - Which CQL fields work when searching for people in Confluence?
      instructions:
      - text: Search Confluence users matching CQL {cql}.
        slots:
          cql: query.cql
      - text: Find up to {limit} Confluence people with the user query {cql}.
        slots:
          limit: query.limit
          cql: query.cql
      method: generated
      generated: '2026-10-01'