# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Search API
  version: 1.0.0
extends: openapi/redocly-search-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/_search'].post
  update:
    x-apievangelist-phrasing:
      intent: Full-text search a project's docs and API reference
      effect: read
      questions:
      - Can I search my Redocly documentation and API reference from a script or MCP server?
      - Are search results grouped by category like Documentation and API Reference?
      - Which locale do I have to pass when searching my docs content?
      instructions:
      - text: Search the {locale} docs for {query}.
        slots:
          locale: requestBody.locale
          query: requestBody.query
      - text: Run a full-text search for {query} in locale {locale}, restricted by facet filters {filter}.
        slots:
          query: requestBody.query
          locale: requestBody.locale
          filter: requestBody.filter
      - text: Load more results within a group for {query} in {locale} using {loadMore}.
        slots:
          query: requestBody.query
          locale: requestBody.locale
          loadMore: requestBody.loadMore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/_search-facets'].post
  update:
    x-apievangelist-phrasing:
      intent: Get search facets and counts for filter UIs
      effect: read
      questions:
      - What facets and value counts can I use to build a filter sidebar for docs search?
      - Can facet counts reflect a specific search query and the filters already applied?
      - Is there type-ahead for narrowing the values shown in one facet?
      instructions:
      - text: Get all configured search facets with counts for locale {locale}.
        slots:
          locale: requestBody.locale
      - text: Show the values and counts for facet field {field} in locale {locale} for query {query}.
        slots:
          field: requestBody.field
          locale: requestBody.locale
          query: requestBody.query
      - text: Find values of facet {field} starting with {facetQuery} in locale {locale}.
        slots:
          field: requestBody.field
          facetQuery: requestBody.facetQuery
          locale: requestBody.locale
      method: generated
      generated: '2026-09-26'