Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Rule Execution API

5 actions 5 updates phrasing extends openapi/conga-ruleexecution-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 5

$.info

$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/clause-rule/{executionId}/results'].get

$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/document-rule/{executionId}/results'].get

$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/content/run'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/run'].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 Rule Execution API
  version: 1.0.0
extends: openapi/conga-ruleexecution-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: 4
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/clause-rule/{executionId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a clause rule execution result
      effect: read
      questions:
      - What did a clause-level playbook rule find when it ran against my contract?
      - Can I fetch the outcome of one clause rule execution?
      instructions:
      - text: Get clause rule results for execution {executionId} on contract {contractId}, playbook {playbookId}.
        slots:
          executionId: path.executionId
          contractId: path.contractId
          playbookId: path.playbookId
      - text: Show the clause rule findings from run {executionId} of playbook {playbookId} on contract {contractId}.
        slots:
          executionId: path.executionId
          playbookId: path.playbookId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/document-rule/{executionId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document rule execution result
      effect: read
      questions:
      - What did a whole-document playbook rule conclude about my contract?
      - Can I retrieve the result of a document rule execution by its ID?
      instructions:
      - text: Get document rule results for execution {executionId} on contract {contractId}, playbook {playbookId}.
        slots:
          executionId: path.executionId
          contractId: path.contractId
          playbookId: path.playbookId
      - text: Show the document-level rule outcome of run {executionId} in playbook {playbookId} for contract {contractId}.
        slots:
          executionId: path.executionId
          playbookId: path.playbookId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/content/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a playbook rule on contract document content
      effect: write
      questions:
      - How do I run a playbook rule against the raw text of a contract document?
      - Can I check an uploaded file's content against one playbook rule?
      instructions:
      - text: Run rule {ruleId} of playbook {playbookId} on contract {contractId} using content {documentContent}.
        slots:
          ruleId: path.ruleId
          playbookId: path.playbookId
          contractId: path.contractId
          documentContent: requestBody.documentContent
      - text: Execute playbook {playbookId} rule {ruleId} against file {fileName} for contract {contractId}.
        slots:
          playbookId: path.playbookId
          ruleId: path.ruleId
          fileName: requestBody.fileName
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/playbooks/{playbookId}/rules/{ruleId}/run'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a playbook rule on pre-extracted rule text
      effect: write
      questions:
      - Can I run a playbook rule using rule text that was already extracted from the contract?
      - Which smart fields can I pass when executing a rule on extracted text?
      instructions:
      - text: Run rule {ruleId} of playbook {playbookId} on contract {contractId} with extracted text {ruleText}.
        slots:
          ruleId: path.ruleId
          playbookId: path.playbookId
          contractId: path.contractId
          ruleText: requestBody.ruleText
      - text: Execute playbook {playbookId} rule {ruleId} on extracted document {executionDocumentId} of contract {contractId}.
        slots:
          playbookId: path.playbookId
          ruleId: path.ruleId
          executionDocumentId: requestBody.executionDocumentId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'