Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GlobalSearch Runtime API

2 actions 2 updates phrasing extends openapi/conga-globalsearch-runtime-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['/api/search/v1/global/query'].post

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 GlobalSearch Runtime API
  version: 1.0.0
extends: openapi/conga-globalsearch-runtime-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['/api/search/v1/global/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search across configured objects
      effect: read
      questions:
      - Can I search every configured object for a term?
      - How do I run an exact-phrase search across records?
      instructions:
      - text: Search all objects for {term}.
        slots:
          term: requestBody.SearchTerm
      - text: Search {objects} for {term}, returning {limit} results.
        slots:
          objects: requestBody.ObjectList
          term: requestBody.SearchTerm
          limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'