Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Type Ahead API

2 actions 2 updates phrasing extends openapi/conga-typeahead-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 2

$.info
$.paths['/{objectname}/type-ahead'].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 Administration Type Ahead API
  version: 1.0.0
extends: openapi/conga-typeahead-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: 1
- target: $.paths['/{objectname}/type-ahead'].get
  update:
    x-apievangelist-phrasing:
      intent: Get type-ahead suggestions for an object
      effect: read
      questions:
      - Can I get autocomplete suggestions for records of an object as a user types?
      - What type-ahead matches come back for a partial search term against an object's records?
      instructions:
      - text: Get type-ahead suggestions for {objectname}.
        slots:
          objectname: path.objectname
      - text: Autocomplete {query} against {objectname} records.
        slots:
          query: query.query
          objectname: path.objectname
      method: generated
      generated: '2026-10-01'