Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Document Review API

3 actions 3 updates phrasing extends openapi/conga-document-review-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 3

$.info

$.paths['/api/xauthor/v1/documents/reviews/details'].get

$.paths['/api/xauthor/v1/documents/reviews/status'].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 X-Author Document Review API
  version: 1.0.0
extends: openapi/conga-document-review-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: 2
- target: $.paths['/api/xauthor/v1/documents/reviews/details'].get
  update:
    x-apievangelist-phrasing:
      intent: Check Send For Review status
      effect: read
      questions:
      - How do I check the Send For Review details of an agreement document?
      - Can I see send-for-review information for a template instead of an agreement?
      instructions:
      - text: Get Send For Review details for agreement {agreementId}.
        slots:
          agreementId: query.agreementId
      - text: Show Send For Review status for template {templateId} in org type {OrgType}.
        slots:
          templateId: query.templateId
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/reviews/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a review cycle is pending
      effect: read
      questions:
      - Is there still a pending review cycle on my agreement?
      - Can I tell if a template's review cycle is still open?
      instructions:
      - text: Check if agreement {agreementId} has a pending review cycle.
        slots:
          agreementId: query.agreementId
      - text: Tell me whether template {templateId}'s review cycle is pending for org type {OrgType}.
        slots:
          templateId: query.templateId
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'