Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals Activities API

2 actions 2 updates phrasing extends openapi/conga-activities-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['/v1/activities/{objectType}/{objectId}'].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 Approvals Activities API
  version: 1.0.0
extends: openapi/conga-activities-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['/v1/activities/{objectType}/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List approval activities for a record
      effect: read
      questions:
      - What approval activity has happened on this agreement or quote?
      - Can I look up approval history using an external ID?
      instructions:
      - text: List approval activities for {objectType} {objectId}.
        slots:
          objectType: path.objectType
          objectId: path.objectId
      - text: Show page {page} of approval activity on {objectType} {objectId}, {limit} per page.
        slots:
          page: query.page
          objectType: path.objectType
          objectId: path.objectId
          limit: query.limit
      method: generated
      generated: '2026-10-01'