Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Fields Validate API

2 actions 2 updates phrasing extends openapi/conga-fieldsvalidate-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/objects/{objectName}/{objectId}/fields/{fieldAPI}/validate'].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 Fields Validate API
  version: 1.0.0
extends: openapi/conga-fieldsvalidate-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/objects/{objectName}/{objectId}/fields/{fieldAPI}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate a field value on a record
      effect: read
      questions:
      - Is the value I typed into a document field valid for that record?
      - Can I check a lookup field value against its object?
      instructions:
      - text: Validate field {field} on {object} record {id}.
        slots:
          field: path.fieldAPI
          object: path.objectName
          id: path.objectId
      - text: Check whether {value} is valid for field {field} of {object} record {id}.
        slots:
          value: requestBody.currentValue
          field: path.fieldAPI
          object: path.objectName
          id: path.objectId
      method: generated
      generated: '2026-10-01'