Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Clause Metadata API

3 actions 3 updates phrasing extends openapi/conga-clausemetadata-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/clauses/mark/metadata/{contractId}'].get
$.paths['/api/xauthor/v1/clauses/metadata'].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 Metadata API
  version: 1.0.0
extends: openapi/conga-clausemetadata-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/clauses/mark/metadata/{contractId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get marked clause metadata for a contract
      effect: read
      questions:
      - How do I see metadata for the clauses marked in a specific contract?
      - Can I pull the mark-clause details for one agreement in X-Author?
      instructions:
      - text: Get mark clause metadata for contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Show marked clause metadata for contract {contractId} in org type {OrgType}.
        slots:
          contractId: path.contractId
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get template clause metadata
      effect: read
      questions:
      - Where do I find metadata for the clauses in a template?
      - What clause metadata does X-Author expose at the template level?
      instructions:
      - text: Get template clause metadata for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      - text: Show the metadata for template clauses.
      method: generated
      generated: '2026-10-01'