Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Field Data API

2 actions 2 updates phrasing extends openapi/conga-fielddata-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/1/fields/retrieve-data'].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 Field Data API
  version: 1.0.0
extends: openapi/conga-fielddata-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/1/fields/retrieve-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Get locale-formatted field values
      effect: read
      questions:
      - Can X-Author return field values formatted for a document's locale?
      - How do I get formatted values for a list of field metadata?
      instructions:
      - text: Get locale-formatted values for fields {fields}.
        slots:
          fields: requestBody.fieldMetadataList
      - text: Retrieve formatted field data for document property {prop}.
        slots:
          prop: requestBody.documentProperty
      method: generated
      generated: '2026-10-01'