Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Field Data Retrieval API

2 actions 2 updates phrasing extends openapi/conga-fielddataretrieval-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/metadata/2/fields/retrieve-data'].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 X-Author Field Data Retrieval API
  version: 1.0.0
extends: openapi/conga-fielddataretrieval-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/metadata/2/fields/retrieve-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a record's field data by locale
      effect: read
      questions:
      - Can I fetch a record's field values formatted for a locale?
      - How do I pull field data for one object record into a document?
      instructions:
      - text: Get field data for {object} record {id} in locale {locale}.
        slots:
          object: requestBody.objectName
          id: requestBody.objectId
          locale: requestBody.documentLocale
      - text: Retrieve formatted values of {fields} for record {id}.
        slots:
          fields: requestBody.fieldMetadata
          id: requestBody.objectId
      method: generated
      generated: '2026-10-01'