Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Reconciliation API

3 actions 3 updates phrasing extends openapi/conga-reconciliation-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['/api/xauthor/v1/reconcile/preview-data'].post

$.paths['/api/xauthor/v1/reconcile/preview-data/sametagfields'].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 Reconciliation API
  version: 1.0.0
extends: openapi/conga-reconciliation-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['/api/xauthor/v1/reconcile/preview-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Prepare a document for reconciliation preview
      effect: read
      questions:
      - How do I validate and reconcile the fields and clauses in an authored document before applying changes?
      - Does the reconciliation preview stop early if a field is invalid?
      instructions:
      - text: Run a reconciliation preview on {documentContent} for org type {OrgType}.
        slots:
          documentContent: requestBody.documentContent
          OrgType: header.OrgType
      - text: Preview field and clause reconciliation for this document in locale {locale}, org type {OrgType}.
        slots:
          locale: requestBody.locale
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/reconcile/preview-data/sametagfields'].post
  update:
    x-apievangelist-phrasing:
      intent: Preview reconciliation for same-tag fields
      effect: read
      questions:
      - Can I preview reconciliation data for fields that share the same tag?
      - What do fields with duplicate tags look like before reconciling them?
      instructions:
      - text: Build the same-tag field reconciliation preview for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      - text: Preview the fields sharing a tag in this document for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'