Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Agreement Document API

5 actions 5 updates phrasing extends openapi/conga-agreementdocument-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 5

$.info

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/compareandmerge'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/regenerate'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/versions'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentId}/tags'].get

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 Agreement Document API
  version: 1.0.0
extends: openapi/conga-agreementdocument-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: 4
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/compareandmerge'].post
  update:
    x-apievangelist-phrasing:
      intent: Compare and merge agreement documents
      effect: write
      questions:
      - How do I compare a counterparty's version against my agreement document and merge them?
      - Can I merge several attachments into one agreement document?
      instructions:
      - text: Compare and merge attachments {attachments} into agreement {contractId}.
        slots:
          attachments: requestBody.attachments
          contractId: path.contractId
      - text: Merge documents on agreement {contractId} into a file named {documentMergeName}.
        slots:
          contractId: path.contractId
          documentMergeName: requestBody.documentMergeName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/regenerate'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate an agreement document from a template
      effect: write
      questions:
      - How do I regenerate an agreement's document using a different template?
      - Can I regenerate a document as a draft and accept redlines at the same time?
      instructions:
      - text: Regenerate agreement {contractId}'s document with template {templateId}.
        slots:
          contractId: path.contractId
          templateId: requestBody.templateId
      - text: Regenerate the document for agreement {contractId} in format {documentFormat}.
        slots:
          contractId: path.contractId
          documentFormat: requestBody.documentFormat
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/versions'].post
  update:
    x-apievangelist-phrasing:
      intent: List an agreement's document versions
      effect: read
      questions:
      - What versions of the document exist on an agreement?
      - Can I page through an agreement's document version history?
      instructions:
      - text: List document versions for agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Show {size} document versions of agreement {contractId} from offset {offset}.
        slots:
          size: requestBody.size
          contractId: path.contractId
          offset: requestBody.offset
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentId}/tags'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the tags on an agreement document
      effect: read
      questions:
      - Which tags are attached to a document on an agreement?
      - Can I read the tags of one agreement attachment?
      instructions:
      - text: Get tags for document {documentId} on agreement {contractId}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      - text: Show the tags on attachment {documentId} of agreement {contractId}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'