Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Playbook Execution API

3 actions 3 updates phrasing extends openapi/conga-playbookexecution-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/contracts/{contractId}/playbooks/{playbookId}/execute'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/executions/{executionId}/results'].post

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 Playbook Execution API
  version: 1.0.0
extends: openapi/conga-playbookexecution-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/contracts/{contractId}/playbooks/{playbookId}/execute'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a playbook against a document
      effect: write
      questions:
      - How do I review a contract document with a playbook?
      - Can I run only certain playbook rules?
      instructions:
      - text: Run playbook {playbook} on contract {contract}.
        slots:
          playbook: path.playbookId
          contract: path.contractId
      - text: Execute rules {rules} of playbook {playbook} on contract {contract}.
        slots:
          rules: requestBody.ruleIds
          playbook: path.playbookId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/executions/{executionId}/results'].post
  update:
    x-apievangelist-phrasing:
      intent: Get playbook execution results
      effect: read
      questions:
      - What did a playbook review find in my contract?
      - Can I fetch the clause results of a playbook execution?
      instructions:
      - text: Get results of execution {exec} for playbook {playbook} on contract {contract}.
        slots:
          exec: path.executionId
          playbook: path.playbookId
          contract: path.contractId
      - text: Show findings from playbook run {exec} on {contract} using {playbook}.
        slots:
          exec: path.executionId
          contract: path.contractId
          playbook: path.playbookId
      method: generated
      generated: '2026-10-01'