Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Search Runtime API

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

$.info

$.paths['/api/search/v1/document/query'].post

$.paths['/api/search/v1/objects/multiple/query'].post

$.paths['/api/search/v1/objects/{objectName}/indexedfields'].get

$.paths['/api/search/v1/objects/{objectName}/query'].post

$.paths['/api/search/v1/setting/list'].get

$.paths['/api/search/v1/setting/{objectName}'].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 Search Runtime API
  version: 1.0.0
extends: openapi/conga-search-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: 6
- target: $.paths['/api/search/v1/document/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search documents
      effect: read
      questions:
      - How do I run a full-text or advanced search across documents?
      - Can I get a total count along with document search results?
      instructions:
      - text: Search documents of object {objectName} for {Criteria}.
        slots:
          objectName: query.objectName
          Criteria: requestBody.Criteria
      - text: Run a {SearchType} document search with total count {IncludeTotalCount}.
        slots:
          SearchType: requestBody.SearchType
          IncludeTotalCount: query.IncludeTotalCount
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/objects/multiple/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search across several objects
      effect: read
      questions:
      - Can I search several record types in one query?
      - Is it possible to search text across all documents and related objects together?
      instructions:
      - text: Search multiple objects with queries {MultipleObjectSearchQueries}.
        slots:
          MultipleObjectSearchQueries: requestBody.MultipleObjectSearchQueries
      - text: Search all documents across objects for the text {DocumentSearchText}.
        slots:
          DocumentSearchText: requestBody.DocumentSearchText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/objects/{objectName}/indexedfields'].get
  update:
    x-apievangelist-phrasing:
      intent: List an object's searchable fields
      effect: read
      questions:
      - Which fields of an object are searchable or indexed?
      - What fields can I filter on when searching an object?
      instructions:
      - text: List the searchable fields for {objectName}.
        slots:
          objectName: path.objectName
      - text: Show indexed fields of object {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/objects/{objectName}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search records of one object
      effect: read
      questions:
      - How do I query records of a single object type with criteria and sorting?
      - Can I select specific fields and group results in an object search?
      instructions:
      - text: Search {objectName} records for {Criteria}.
        slots:
          objectName: path.objectName
          Criteria: requestBody.Criteria
      - text: Query {objectName} returning {Select}, sorted by {Sort}.
        slots:
          objectName: path.objectName
          Select: requestBody.Select
          Sort: requestBody.Sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/setting/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List objects with search enabled
      effect: read
      questions:
      - Which objects have search settings enabled?
      - What record types can I search right now?
      instructions:
      - text: List objects that have search enabled.
      - text: Show every object with a search setting turned on.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/search/v1/setting/{objectName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an object's search setting
      effect: read
      questions:
      - How is search configured for a specific object?
      - What search setting is applied to one object?
      instructions:
      - text: Get the search setting for {objectName}.
        slots:
          objectName: path.objectName
      - text: Show search configuration of object {objectName}.
        slots:
          objectName: path.objectName
      method: generated
      generated: '2026-10-01'