Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Catalog Smart Search API

3 actions 3 updates phrasing extends openapi/conga-smart-search-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/search'].post
$.paths['/search/typeahead'].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 Catalog Smart Search API
  version: 1.0.0
extends: openapi/conga-smart-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['/search'].post
  update:
    x-apievangelist-phrasing:
      intent: Search catalog products
      effect: read
      questions:
      - How do I search the product catalog with filters and facets?
      - Can I limit a product search to one price list or category?
      instructions:
      - text: Search the catalog for {query}.
        slots:
          query: query.query
      - text: Find products matching {query} in category {categoryid} on price list {pricelistid}.
        slots:
          query: query.query
          categoryid: header.categoryid
          pricelistid: header.pricelistid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/search/typeahead'].get
  update:
    x-apievangelist-phrasing:
      intent: Suggest products as the user types
      effect: read
      questions:
      - Can I get product suggestions from just the first few letters someone types?
      - Which typeahead configuration does the autosuggest use?
      instructions:
      - text: Suggest products as the user types {query}.
        slots:
          query: query.query
      - text: Autocomplete product names for {query} using typeahead config {configName}.
        slots:
          query: query.query
          configName: query.configName
      method: generated
      generated: '2026-10-01'