Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Activity History API

2 actions 2 updates phrasing extends openapi/conga-activityhistory-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/clm/v1/contracts/{contractId}/activityhistory/query'].post

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 Contracts Activity History API
  version: 1.0.0
extends: openapi/conga-activityhistory-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/clm/v1/contracts/{contractId}/activityhistory/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query a contract's activity history
      effect: read
      questions:
      - What has happened on a contract so far, and who did it?
      - Can I filter a contract's activity log and get a total count?
      instructions:
      - text: Show the activity history for contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Get the last {Limit} activity records on contract {contractId} where {CriteriaExpression}.
        slots:
          Limit: requestBody.Limit
          contractId: path.contractId
          CriteriaExpression: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'