Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Clause Version API

2 actions 2 updates phrasing extends openapi/conga-clauseversion-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/clauses/{clauseId}/versions/{clauseVersionId}/richtext-content'].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 Clause Version API
  version: 1.0.0
extends: openapi/conga-clauseversion-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/clauses/{clauseId}/versions/{clauseVersionId}/richtext-content'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clause version's content as text or HTML
      effect: read
      questions:
      - How do I read the rich text of a specific clause version in Conga?
      - Can I get the wording of an older clause version as HTML?
      instructions:
      - text: Fetch the rich text content of version {clauseVersionId} of clause {clauseId} for org type {OrgType}.
        slots:
          clauseVersionId: path.clauseVersionId
          clauseId: path.clauseId
          OrgType: header.OrgType
      - text: Show the HTML text of clause {clauseId}, version {clauseVersionId}.
        slots:
          clauseId: path.clauseId
          clauseVersionId: path.clauseVersionId
      method: generated
      generated: '2026-10-01'