Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts In-Effect View API

4 actions 4 updates phrasing extends openapi/conga-in-effect-view-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 4

$.info

$.paths['/api/clm/v1/contracts/{contractId}/in-effect-view/clauses'].get

$.paths['/api/clm/v1/contracts/{contractId}/in-effect-view/details'].get

$.paths['/api/clm/v1/contracts/{contractId}/in-effect-view/documents'].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 Contracts In-Effect View API
  version: 1.0.0
extends: openapi/conga-in-effect-view-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: 3
- target: $.paths['/api/clm/v1/contracts/{contractId}/in-effect-view/clauses'].get
  update:
    x-apievangelist-phrasing:
      intent: View in-effect clause changes on a contract
      effect: read
      questions:
      - Which clauses are currently in effect after amendments?
      - Can I page through a contract's in-effect clause changes?
      instructions:
      - text: Show the in-effect clause changes for contract {contract}.
        slots:
          contract: path.contractId
      - text: List {limit} in-effect clauses of contract {contract}.
        slots:
          limit: query.limit
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/in-effect-view/details'].get
  update:
    x-apievangelist-phrasing:
      intent: View in-effect detail changes on a contract
      effect: read
      questions:
      - What contract details are in effect after all amendments?
      - Can I see the current effective terms of a contract?
      instructions:
      - text: Show the in-effect detail changes for contract {contract}.
        slots:
          contract: path.contractId
      - text: Get the effective contract details of {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/in-effect-view/documents'].get
  update:
    x-apievangelist-phrasing:
      intent: View in-effect document changes on a contract
      effect: read
      questions:
      - Which documents are currently in effect on a contract?
      - Can I page through a contract's in-effect documents?
      instructions:
      - text: Show the in-effect document changes for contract {contract}.
        slots:
          contract: path.contractId
      - text: List {limit} in-effect documents of contract {contract}.
        slots:
          limit: query.limit
          contract: path.contractId
      method: generated
      generated: '2026-10-01'