Confluence · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Confluence Cloud REST Search API

3 actions 3 updates phrasing extends openapi/confluence-search-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Confluence's API. It is a proposal applied on top of the contract, not a document Confluence publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.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 Confluence Cloud REST Search API
  version: 1.0.0
extends: openapi/confluence-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: 2
- target: $.paths['/wiki/rest/api/search'].get
  update:
    x-apievangelist-phrasing:
      intent: Search Confluence with CQL
      effect: read
      questions:
      - How do I search across pages, blogs, spaces and attachments with a CQL query?
      - Can search results include excerpts or archived spaces?
      - Is there a limit on how many search results come back per page?
      instructions:
      - text: Search Confluence for {cql}.
        slots:
          cql: query.cql
      - text: Run CQL search {cql} including archived spaces and show {limit} hits.
        slots:
          cql: query.cql
          limit: query.limit
      - text: Search with CQL {cql} and return excerpts using the {excerpt} strategy.
        slots:
          cql: query.cql
          excerpt: query.excerpt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/wiki/rest/api/search/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Search for users with CQL
      effect: read
      questions:
      - Can I find Confluence users by full name with a CQL user query?
      - Which user-specific CQL fields work for finding people?
      instructions:
      - text: Find users matching CQL {cql}.
        slots:
          cql: query.cql
      - text: Search for up to {limit} people with user query {cql}.
        slots:
          limit: query.limit
          cql: query.cql
      method: generated
      generated: '2026-10-01'