Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals Async Operation Status API

2 actions 2 updates phrasing extends openapi/conga-asyncoperationstatus-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/async-operation-status/{correlationId}'].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 Async Operation Status API
  version: 1.0.0
extends: openapi/conga-asyncoperationstatus-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/async-operation-status/{correlationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an async operation status
      effect: read
      questions:
      - Is my background operation finished yet?
      - Can I track a long-running request by its correlation ID?
      instructions:
      - text: Check the status of async operation {correlationId}.
        slots:
          correlationId: path.correlationId
      - text: Get progress for correlation ID {correlationId}.
        slots:
          correlationId: path.correlationId
      method: generated
      generated: '2026-10-01'