Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Query API

2 actions 2 updates phrasing extends openapi/conga-query-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/xauthor/v1/query/{objectName}'].post

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 X-Author Query API
  version: 1.0.0
extends: openapi/conga-query-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/xauthor/v1/query/{objectName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Query dynamic lookup data for an object
      effect: read
      questions:
      - How do I pull dynamic lookup data for an object in Conga X-Author?
      - Can I search lookup records by a field value and sort the results?
      - What fields and conditions can I pass when querying lookup data?
      instructions:
      - text: Query lookup data for object {objectName} in org type {OrgType}.
        slots:
          objectName: path.objectName
          OrgType: header.OrgType
      - text: Search {objectName} lookup records where {searchFieldName} is {searchVal}.
        slots:
          objectName: path.objectName
          searchFieldName: requestBody.searchFieldName
          searchVal: requestBody.searchVal
      - text: Fetch {size} lookup rows for {objectName} with fields {fields}, ordered by {orderBy}.
        slots:
          size: requestBody.size
          objectName: path.objectName
          fields: requestBody.fields
          orderBy: requestBody.orderBy
      method: generated
      generated: '2026-10-01'