Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Agreement Metadata API

2 actions 2 updates phrasing extends openapi/conga-agreementmetadata-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}/metadata'].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 Metadata API
  version: 1.0.0
extends: openapi/conga-agreementmetadata-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}/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an agreement's field metadata
      effect: read
      questions:
      - Which fields and values are defined on an agreement?
      - Can I read the field metadata for one agreement in X-Author?
      instructions:
      - text: Get the field metadata for agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: List the fields on agreement {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'