Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Playbook API

4 actions 4 updates phrasing extends openapi/conga-playbook-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 4

$.info
$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks'].get
$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/match'].get
$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules'].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 X-Author Playbook API
  version: 1.0.0
extends: openapi/conga-playbook-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: 3
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List playbooks for a contract
      effect: read
      questions:
      - Which playbooks apply to a contract's type and legal entity?
      - Can I see the playbooks available for a contract?
      instructions:
      - text: List playbooks for contract {contract}.
        slots:
          contract: path.contractId
      - text: Show the playbooks for contract {contract} in org type {org}.
        slots:
          contract: path.contractId
          org: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/match'].get
  update:
    x-apievangelist-phrasing:
      intent: Find playbooks that match a contract
      effect: read
      questions:
      - Which playbooks match a specific contract?
      - Is there a matched playbook I should review this contract with?
      instructions:
      - text: Find matching playbooks for contract {contract}.
        slots:
          contract: path.contractId
      - text: Get the matched playbooks for {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List playbook rules for a contract
      effect: read
      questions:
      - Which playbook rules apply to a contract?
      - Can I see the matched rules of one playbook?
      instructions:
      - text: List rules of playbook {playbook} for contract {contract}.
        slots:
          playbook: path.playbookId
          contract: path.contractId
      - text: Show matched rules in {playbook} on contract {contract}.
        slots:
          playbook: path.playbookId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'