Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Agreement Document Checkin API

2 actions 2 updates phrasing extends openapi/conga-agreementdocumentcheckin-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/contracts/{contractId}/documents/check-in'].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 Agreement Document Checkin API
  version: 1.0.0
extends: openapi/conga-agreementdocumentcheckin-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/contracts/{contractId}/documents/check-in'].post
  update:
    x-apievangelist-phrasing:
      intent: Check in an agreement document
      effect: write
      questions:
      - How do I check my edited document back into an agreement?
      - Can checking in a document also create a PDF and submit it for approval?
      instructions:
      - text: Check in my edited document to agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Check in the document on agreement {contractId} as {suggestedFileName} and submit for approval {submitForApproval}.
        slots:
          contractId: path.contractId
          suggestedFileName: requestBody.suggestedFileName
          submitForApproval: requestBody.submitForApproval
      method: generated
      generated: '2026-10-01'