API Evangelist conversational phrasing for Contracts Contract Obligations 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 Obligations API
  version: 1.0.0
extends: openapi/conga-contract-obligations-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: 10
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligation-fulfillments'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a contract's obligations and fulfillments
      effect: read
      questions:
      - Which obligations on a contract have been fulfilled, with their documents?
      - Can I see fulfillment details alongside each contract obligation?
      instructions:
      - text: Show obligation fulfillment details for contract {contract}.
        slots:
          contract: path.contractId
      - text: Get fulfillments with documents for contract {contract}, limited to {limit}.
        slots:
          contract: path.contractId
          limit: requestBody.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an obligation on a contract
      effect: write
      questions:
      - How do I add a new obligation to a contract?
      - What field is required to create a contract obligation?
      instructions:
      - text: Create an obligation on contract {contract}.
        slots:
          contract: path.contractId
      - text: Add a named obligation to contract {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete obligations from a contract
      effect: destructive
      questions:
      - Can I delete all obligations on a contract at once?
      - What happens if I pass specific obligation IDs when bulk-deleting?
      instructions:
      - text: Delete the obligations on contract {contract}.
        slots:
          contract: path.contractId
      - text: Bulk-remove the listed obligations from contract {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List a contract's obligations
      effect: read
      questions:
      - Which obligations are tracked against a given contract?
      - Can I filter and sort the obligations of a contract?
      instructions:
      - text: List the obligations on contract {contract}.
        slots:
          contract: path.contractId
      - text: Find contract {contract} obligations matching {criteria}.
        slots:
          contract: path.contractId
          criteria: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one contract obligation
      effect: read
      questions:
      - What are the details of a specific obligation on a contract?
      - How do I look up a contract obligation by its ID?
      instructions:
      - text: Get obligation {obligation} of contract {contract}.
        slots:
          obligation: path.obligationId
          contract: path.contractId
      - text: Show contract {contract} obligation {obligation}.
        slots:
          contract: path.contractId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract obligation
      effect: write
      questions:
      - How do I change the due date or details of a contract obligation?
      - Can I edit an existing obligation on a contract?
      instructions:
      - text: Update obligation {obligation} on contract {contract}.
        slots:
          obligation: path.obligationId
          contract: path.contractId
      - text: Edit contract {contract} obligation {obligation} with these changes.
        slots:
          contract: path.contractId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one contract obligation
      effect: destructive
      questions:
      - How do I delete a single obligation from a contract?
      - Is removing one contract obligation by ID permanent?
      instructions:
      - text: Delete obligation {obligation} from contract {contract}.
        slots:
          obligation: path.obligationId
          contract: path.contractId
      - text: Remove only obligation {obligation} on contract {contract}.
        slots:
          obligation: path.obligationId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/documents'].post
  update:
    x-apievangelist-phrasing:
      intent: Upload a document to a contract obligation
      effect: write
      questions:
      - How do I attach proof of fulfillment to a contract obligation?
      - Can I upload a file against an obligation on a contract?
      instructions:
      - text: Upload {file} to obligation {obligation} of contract {contract}.
        slots:
          file: requestBody.file
          obligation: path.obligationId
          contract: path.contractId
      - text: Attach a document to contract {contract} obligation {obligation}.
        slots:
          contract: path.contractId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/documents/{documentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract obligation document
      effect: read
      questions:
      - What are the details of a document attached to a contract obligation?
      - Can I look up one obligation document by its ID?
      instructions:
      - text: Get document {doc} on obligation {obligation} of contract {contract}.
        slots:
          doc: path.documentId
          obligation: path.obligationId
          contract: path.contractId
      - text: Show obligation document {doc} for contract {contract}, obligation {obligation}.
        slots:
          doc: path.documentId
          contract: path.contractId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/obligations/{obligationId}/documents/{documentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a contract obligation document
      effect: destructive
      questions:
      - How do I remove a file attached to a contract obligation?
      - Can I delete an obligation document without deleting the obligation?
      instructions:
      - text: Delete document {doc} from obligation {obligation} on contract {contract}.
        slots:
          doc: path.documentId
          obligation: path.obligationId
          contract: path.contractId
      - text: Remove attachment {doc} from contract {contract} obligation {obligation}.
        slots:
          doc: path.documentId
          contract: path.contractId
          obligation: path.obligationId
      method: generated
      generated: '2026-10-01'