# 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 Agreement Clause API
  version: 1.0.0
extends: openapi/conga-agreementclause-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: 6
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/clauses/final'].post
  update:
    x-apievangelist-phrasing:
      intent: Record agreement clauses as final
      effect: write
      questions:
      - How do I save an agreement's clause entries as the final version?
      - Can I mark clauses as final for a particular document version?
      instructions:
      - text: Record these clauses as final on agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Save final clause entries for agreement {contractId} on document version {documentVersionId}.
        slots:
          contractId: path.contractId
          documentVersionId: requestBody.documentVersionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/clauses/original'].post
  update:
    x-apievangelist-phrasing:
      intent: Record an agreement's original clauses
      effect: write
      questions:
      - How do I capture the original clause entries for an agreement?
      - Can I log the starting clauses of an agreement before negotiation?
      instructions:
      - text: Record the original clauses for agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Create original clause entries on agreement {contractId} for document version {documentVersionId}.
        slots:
          contractId: path.contractId
          documentVersionId: requestBody.documentVersionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentId}/clauses/final'].post
  update:
    x-apievangelist-phrasing:
      intent: Finalize one document's clause entries
      effect: write
      questions:
      - How do I finalize the clauses within one specific agreement document?
      - Can clause finalization be done per document rather than per agreement?
      instructions:
      - text: Finalize clause entries on document {documentId} of agreement {contractId}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      - text: Mark the clauses in document {documentId} for agreement {contractId} as final.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentVersionId}/clauses/revertible'].get
  update:
    x-apievangelist-phrasing:
      intent: List clause changes that can be reverted
      effect: read
      questions:
      - Which modified clauses in a document version can still be reverted?
      - Can I see the clause edits I'm able to undo?
      instructions:
      - text: List revertible clauses in document version {documentVersionId} of agreement {contractId}.
        slots:
          documentVersionId: path.documentVersionId
          contractId: path.contractId
      - text: Show the modified clauses I can undo on agreement {contractId}, version {documentVersionId}.
        slots:
          contractId: path.contractId
          documentVersionId: path.documentVersionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentVersionId}/files/{fileId}/clauses/original'].post
  update:
    x-apievangelist-phrasing:
      intent: Record original clauses from an attached file
      effect: write
      questions:
      - How do I extract original clause entries from a specific attached file?
      - Can original clauses be captured from one file of a document version?
      instructions:
      - text: Record original clauses from file {fileId} in version {documentVersionId} of agreement {contractId}.
        slots:
          fileId: path.fileId
          documentVersionId: path.documentVersionId
          contractId: path.contractId
      - text: Create original clause entries from attached file {fileId} on agreement {contractId}, version {documentVersionId}.
        slots:
          fileId: path.fileId
          contractId: path.contractId
          documentVersionId: path.documentVersionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentVersionId}/metadata/{metadataFileId}/clauses/original'].post
  update:
    x-apievangelist-phrasing:
      intent: Record original clauses from a metadata file
      effect: write
      questions:
      - Can I create original clause entries using a document's metadata file?
      - How are original clauses captured from metadata rather than the document itself?
      instructions:
      - text: Record original clauses from metadata file {metadataFileId} for agreement {contractId}, version {documentVersionId}.
        slots:
          metadataFileId: path.metadataFileId
          contractId: path.contractId
          documentVersionId: path.documentVersionId
      - text: Use metadata file {metadataFileId} to log original clauses on agreement {contractId} version {documentVersionId}.
        slots:
          metadataFileId: path.metadataFileId
          contractId: path.contractId
          documentVersionId: path.documentVersionId
      method: generated
      generated: '2026-10-01'