Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Clause API

5 actions 5 updates phrasing extends openapi/conga-clause-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/clauses/alternate'].post
$.paths['/api/xauthor/v1/clauses/alternates/check'].post
$.paths['/api/xauthor/v1/clauses/bundles/{name}'].get
$.paths['/api/xauthor/v1/clauses/configurations/{clauseConfigId}'].get

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 Clause API
  version: 1.0.0
extends: openapi/conga-clause-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/clauses/alternate'].post
  update:
    x-apievangelist-phrasing:
      intent: Get alternate clauses for negotiation
      effect: read
      questions:
      - What alternate wording is available for a clause during contract negotiation?
      - Can I fetch fallback clauses for a clause in a specific document version?
      instructions:
      - text: Get alternate clauses for clause {clause}.
        slots:
          clause: requestBody.clauseReferenceId
      - text: Find alternates for clause {clause} in document version {version}.
        slots:
          clause: requestBody.clauseReferenceId
          version: requestBody.documentVersionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/alternates/check'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate alternate clauses
      effect: read
      questions:
      - How do I check that the alternate clauses I picked are valid?
      - Is there a validation step for alternate clauses before inserting them?
      instructions:
      - text: Validate these alternate clause selections.
      - text: Check the alternate clauses for org type {org}.
        slots:
          org: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/bundles/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clause bundle by name
      effect: read
      questions:
      - Which clauses are packaged inside a named clause bundle?
      - How do I look up a clause bundle by its name?
      instructions:
      - text: Get the clause bundle {name}.
        slots:
          name: path.name
      - text: Show the clauses in bundle {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/configurations/{clauseConfigId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List alternates and sub-clauses for a configuration
      effect: read
      questions:
      - What alternate clauses and sub-clauses belong to a clause configuration?
      - Can I see the sub-clause tree for one clause configuration?
      instructions:
      - text: List alternates and sub-clauses for clause configuration {config}.
        slots:
          config: path.clauseConfigId
      - text: Show the sub-clause structure of configuration {config}.
        slots:
          config: path.clauseConfigId
      method: generated
      generated: '2026-10-01'