Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author UFC API

3 actions 3 updates phrasing extends openapi/conga-ufc-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/contracts/{contractId}/ufc/repeat-data'].post
$.paths['/api/xauthor/v1/contracts/{contractId}/ufc/update-document'].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 UFC API
  version: 1.0.0
extends: openapi/conga-ufc-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/contracts/{contractId}/ufc/repeat-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Load repeat and section data for the UFC screen
      effect: read
      questions:
      - Can I pull the repeat tables and section data from a contract document to show in the UFC screen?
      - What repeat and section data does X-Author find in an agreement's document content?
      instructions:
      - text: Get the repeat and section data for contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Read UFC repeat and section tables for contract {contractId} and agreement {agreementId} in my {OrgType} org.
        slots:
          contractId: path.contractId
          agreementId: requestBody.agreementId
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/ufc/update-document'].post
  update:
    x-apievangelist-phrasing:
      intent: Save repeat and section edits to a contract document
      effect: write
      questions:
      - After editing repeat rows in the UFC screen, how do I write them back into the contract document?
      - Can I update the section data of an agreement's document from UFC?
      instructions:
      - text: Update the repeat and section data in contract {contractId}'s document.
        slots:
          contractId: path.contractId
      - text: Write document content {documentContent} back to contract {contractId} in my {OrgType} org.
        slots:
          documentContent: requestBody.documentContent
          contractId: path.contractId
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'