API Evangelist conversational phrasing for Contracts Contract Documents API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Contract Documents API
  version: 1.0.0
extends: openapi/conga-contract-documents-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: 17
- target: $.paths['/api/clm/v1/contracts/createoffline'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract from third-party paper
      effect: write
      questions:
      - How do I bring a counterparty's contract document into Conga CLM as a new contract?
      - Can I create a contract record and attach the third-party file in one step?
      instructions:
      - text: Create a new contract {contract} from the uploaded third-party file {file}.
        slots:
          contract: requestBody.contract
          file: requestBody.file
      - text: Import this outside-paper document as a brand-new contract in Author Contract status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/createoffline/large'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract from a large third-party file
      effect: write
      questions:
      - What if the third-party contract file is too big to upload directly?
      - Can I create a new contract from a large document that is already in the filestore?
      instructions:
      - text: Create contract {Contract} from the large third-party file {FileName} at {FilePath}.
        slots:
          Contract: requestBody.Contract
          FileName: requestBody.FileName
          FilePath: requestBody.FilePath
      - text: Start a new offline contract linked to the filestore document at {FilePath}.
        slots:
          FilePath: requestBody.FilePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/storeexecuted'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an activated contract from a signed document
      effect: write
      questions:
      - How do I record a contract that is already signed so it goes straight to Activated?
      - Can I upload an executed agreement and create its contract record at the same time?
      instructions:
      - text: Store the executed document {file} as new contract {contract}.
        slots:
          file: requestBody.file
          contract: requestBody.contract
      - text: Create an already-activated contract from this signed copy.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/storeexecuted/large'].post
  update:
    x-apievangelist-phrasing:
      intent: Store a large executed contract document
      effect: write
      questions:
      - Can I store a large signed contract file that is already in the filestore?
      - What is the large-file version of storing an executed contract?
      instructions:
      - text: Store the large executed file {FileName} from {FilePath} against contract {Contract}.
        slots:
          FileName: requestBody.FileName
          FilePath: requestBody.FilePath
          Contract: requestBody.Contract
      - text: Link the already-uploaded signed document at {FilePath} as the executed copy.
        slots:
          FilePath: requestBody.FilePath
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a document to an existing contract
      effect: write
      questions:
      - How do I upload a new document onto a contract that already exists?
      - Does adding a document move a contract out of Request status?
      instructions:
      - text: Upload document {file} to contract {contractId}.
        slots:
          file: requestBody.file
          contractId: path.contractId
      - text: Attach a new contract document to {contractId} with attributes {documentAttributes}.
        slots:
          contractId: path.contractId
          documentAttributes: requestBody.documentAttributes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete documents from a contract
      effect: destructive
      questions:
      - Can I wipe every document attached to a contract at once?
      - Is document metadata kept after I delete a contract's documents?
      instructions:
      - text: Delete all documents linked to contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Remove the listed document IDs from contract {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/large'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a large document to a contract
      effect: write
      questions:
      - How do I add a very large file to an existing contract?
      - Can I link a document already sitting in the filestore to a contract?
      instructions:
      - text: Attach large file {FileName} from {FilePath} to contract {contractId}.
        slots:
          FileName: requestBody.FileName
          FilePath: requestBody.FilePath
          contractId: path.contractId
      - text: Link the filestore document at {FilePath} to contract {contractId} as a working document.
        slots:
          FilePath: requestBody.FilePath
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a contract's documents
      effect: read
      questions:
      - Can I search the documents on a contract with my own criteria?
      - What documents on a contract match a given filter?
      instructions:
      - text: Query the documents of contract {contractId} matching {CriteriaExpression}.
        slots:
          contractId: path.contractId
          CriteriaExpression: requestBody.CriteriaExpression
      - text: Return the first {Limit} documents on contract {contractId}.
        slots:
          Limit: requestBody.Limit
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/querywithreview'].post
  update:
    x-apievangelist-phrasing:
      intent: Search contract documents with review status
      effect: read
      questions:
      - Which documents on a contract are under review, and what versions do they have?
      - Can I query contract documents and include their version history?
      instructions:
      - text: Query documents of contract {contractId} including review status and versions.
        slots:
          contractId: path.contractId
      - text: Find documents on {contractId} matching {CriteriaExpression} with their review state.
        slots:
          contractId: path.contractId
          CriteriaExpression: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/relateddocuments'].get
  update:
    x-apievangelist-phrasing:
      intent: List a contract's related documents
      effect: read
      questions:
      - What documents are related to a given contract?
      - Can I see every related document tied to one contract?
      instructions:
      - text: List the related documents for contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Show all documents related to {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract document's details
      effect: read
      questions:
      - How do I get the details of one document on a contract?
      - What metadata is stored for a specific contract document?
      instructions:
      - text: Fetch document {documentId} on contract {contractId}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      - text: Show the latest details of contract {contractId}'s document {documentId}.
        slots:
          contractId: path.contractId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/{documentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a new version of a contract document
      effect: write
      questions:
      - Can I replace a contract document but keep its earlier version?
      - What happens to the old file when I update a contract document?
      instructions:
      - text: Upload {file} as a new version of document {documentId} on contract {contractId}.
        slots:
          file: requestBody.file
          documentId: path.documentId
          contractId: path.contractId
      - text: Version document {documentId} of contract {contractId} with note {description}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
          description: query.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/{documentId}/protect'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply protection to a contract document
      effect: write
      questions:
      - How do I lock a DOCX contract document against edits?
      - Which protection levels can I apply to a contract document?
      instructions:
      - text: Protect document {documentId} on contract {contractId} at level {UserSelectedProtectionLevel}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
          UserSelectedProtectionLevel: requestBody.UserSelectedProtectionLevel
      - text: Return a protected copy of contract {contractId} document {documentId} for action {DocumentAction}.
        slots:
          contractId: path.contractId
          documentId: path.documentId
          DocumentAction: requestBody.DocumentAction
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/{documentId}/versions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete specific versions of a contract document
      effect: destructive
      questions:
      - Can I delete old versions of a contract document but keep the document itself?
      - Is a deleted document version recoverable or just flagged?
      instructions:
      - text: Delete the listed versions of document {documentId} on contract {contractId}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      - text: Permanently remove selected version files of {documentId} from contract {contractId}.
        slots:
          documentId: path.documentId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/documents/{documentId}/versions/{documentMetadataId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a specific version of a contract document
      effect: read
      questions:
      - How do I open an earlier version of a contract document?
      - Can I fetch a document by both its ID and version ID?
      instructions:
      - text: Fetch version {documentMetadataId} of document {documentId} on contract {contractId}.
        slots:
          documentMetadataId: path.documentMetadataId
          documentId: path.documentId
          contractId: path.contractId
      - text: Show the older version {documentMetadataId} of contract {contractId} document {documentId}.
        slots:
          documentMetadataId: path.documentMetadataId
          contractId: path.contractId
          documentId: path.documentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/importoffline'].post
  update:
    x-apievangelist-phrasing:
      intent: Import third-party paper onto an existing contract
      effect: write
      questions:
      - Can I attach a counterparty's paper to a contract I already created?
      - What status does a contract move to after importing offline paper onto it?
      instructions:
      - text: Import the third-party document {file} onto contract {contractId}.
        slots:
          file: requestBody.file
          contractId: path.contractId
      - text: Bring outside paper into existing contract {contractId} as its authoring document.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/importoffline/large'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a large third-party file onto a contract
      effect: write
      questions:
      - How do I import a big counterparty document onto an existing contract?
      - Can offline paper already in the filestore be imported onto a contract?
      instructions:
      - text: Import large offline file {FileName} from {FilePath} onto contract {contractId}.
        slots:
          FileName: requestBody.FileName
          FilePath: requestBody.FilePath
          contractId: path.contractId
      - text: Link the large third-party paper at {FilePath} to existing contract {contractId}.
        slots:
          FilePath: requestBody.FilePath
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'