API Evangelist conversational phrasing for X-Author Clause Comparison API

# 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 Clause Comparison API
  version: 1.0.0
extends: openapi/conga-clausecomparison-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/clause/compare'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a semantic clause comparison
      effect: write
      questions:
      - How do I check whether a clause in a contract deviates from our standard wording?
      - Can I compare extracted clause text against standard text semantically?
      - What do I need to submit to kick off a Conga clause comparison?
      instructions:
      - text: Start a semantic comparison of clause {clauseId} in attachment {attachmentId} for org type {OrgType}.
        slots:
          clauseId: requestBody.clauseId
          attachmentId: requestBody.attachmentId
          OrgType: header.OrgType
      - text: Compare the text {extractedText} against standard wording {standardText} ({OrgType} org).
        slots:
          extractedText: requestBody.extractedText
          standardText: requestBody.standardText
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clause/compare/statuses'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of several clause comparisons
      effect: read
      questions:
      - Can I check the progress of many clause comparisons in one call?
      - Which of my pending clause comparisons have finished?
      instructions:
      - text: Get the statuses of comparisons {comparisonIds} for org type {OrgType}.
        slots:
          comparisonIds: query.comparisonIds
          OrgType: header.OrgType
      - text: Check in bulk whether clause comparisons {comparisonIds} are done.
        slots:
          comparisonIds: query.comparisonIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clause/compare/{comparisonId}/results'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the results of a clause comparison
      effect: read
      questions:
      - Where do I read the outcome of a finished semantic clause comparison?
      - What differences did the clause comparison find?
      instructions:
      - text: Fetch the results of clause comparison {comparisonId} for org type {OrgType}.
        slots:
          comparisonId: path.comparisonId
          OrgType: header.OrgType
      - text: Show me what comparison {comparisonId} found once it completes.
        slots:
          comparisonId: path.comparisonId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clause/compare/{comparisonId}/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of one clause comparison
      effect: read
      questions:
      - Is my single clause comparison still running or complete?
      - Can I poll one comparison ID until it is ready?
      instructions:
      - text: Check the status of clause comparison {comparisonId} for org type {OrgType}.
        slots:
          comparisonId: path.comparisonId
          OrgType: header.OrgType
      - text: Poll whether comparison {comparisonId} has finished yet.
        slots:
          comparisonId: path.comparisonId
      method: generated
      generated: '2026-10-01'