Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Validation API

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

$.info
$.paths['/validate'].post
$.paths['/{objectName}/validate'].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 Administration Validation API
  version: 1.0.0
extends: openapi/conga-validation-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: 2
- target: $.paths['/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate data across multiple objects
      effect: read
      questions:
      - Can I check records from several different objects against validation rules in one call?
      - Is there a way to validate a mixed batch of object data before saving it?
      instructions:
      - text: Validate this data for multiple objects at once.
      - text: Run validation across all the objects in this payload.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{objectName}/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate data for a single object
      effect: read
      questions:
      - How do I check one object's data against its validation criteria?
      - Can I force validation triggers to run when validating an object?
      instructions:
      - text: Validate the data for object {objectName}.
        slots:
          objectName: path.objectName
      - text: Validate {objectName} records with force trigger set to {forceTrigger}.
        slots:
          objectName: path.objectName
          forceTrigger: query.forceTrigger
      method: generated
      generated: '2026-10-01'