Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for eSignature Agreement Signing Cycle API

2 actions 2 updates phrasing extends openapi/conga-agreementsigningcycle-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/esign/v1/agreement/{agreementId}/signing-cycle'].get

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 eSignature Agreement Signing Cycle API
  version: 1.0.0
extends: openapi/conga-agreementsigningcycle-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/esign/v1/agreement/{agreementId}/signing-cycle'].get
  update:
    x-apievangelist-phrasing:
      intent: List an agreement's signing cycles
      effect: read
      questions:
      - How many times has an agreement been sent out for signature?
      - Can I see an agreement's signing cycles for one sign provider?
      instructions:
      - text: List signing cycles for agreement {agreementId}.
        slots:
          agreementId: path.agreementId
      - text: Show agreement {agreementId}'s signing cycles with provider {signProviderType}.
        slots:
          agreementId: path.agreementId
          signProviderType: query.signProviderType
      method: generated
      generated: '2026-10-01'