# 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 Clause API
  version: 1.0.0
extends: openapi/conga-contract-clause-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: 8
- target: $.paths['/api/clm/v1/contracts/clauses/{contractClauseId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract clause's details
      effect: read
      questions:
      - What text and status does a particular contract clause have?
      - Can I fetch a contract clause using only its clause record ID?
      instructions:
      - text: Get contract clause {clause}.
        slots:
          clause: path.contractClauseId
      - text: Show the details of contract clause record {clause}.
        slots:
          clause: path.contractClauseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clause'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a clause to a contract
      effect: write
      questions:
      - How do I add a single new clause to a contract?
      - Can I attach one clause record to an existing contract?
      instructions:
      - text: Add a new clause to contract {contract}.
        slots:
          contract: path.contractId
      - text: Create one clause on contract {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clause/{contractClauseId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a clause on a contract
      effect: write
      questions:
      - How do I edit one clause that's already on a contract?
      - Can I change the data of a single contract clause?
      instructions:
      - text: Update clause {clause} on contract {contract}.
        slots:
          clause: path.contractClauseId
          contract: path.contractId
      - text: Edit contract {contract} clause {clause} with these values.
        slots:
          contract: path.contractId
          clause: path.contractClauseId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clauses'].post
  update:
    x-apievangelist-phrasing:
      intent: List the clauses of a contract
      effect: read
      questions:
      - Which clauses are in a contract, grouped by document version?
      - Can I filter the clauses returned for a contract?
      instructions:
      - text: List all clauses on contract {contract}.
        slots:
          contract: path.contractId
      - text: Show {limit} clauses of contract {contract} matching {criteria}.
        slots:
          limit: requestBody.Limit
          contract: path.contractId
          criteria: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clauses/bulk'].put
  update:
    x-apievangelist-phrasing:
      intent: Update many clauses of a contract
      effect: write
      questions:
      - Can I update several contract clauses in one request?
      - What does each clause need when bulk-updating a contract's clauses?
      instructions:
      - text: Bulk-update the listed clauses on contract {contract}.
        slots:
          contract: path.contractId
      - text: Apply these edits to many clauses of contract {contract} at once.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clauses/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Add many clauses to a contract
      effect: write
      questions:
      - How can I create a batch of clauses on a contract together?
      - Is there a bulk way to add clauses to a contract?
      instructions:
      - text: Bulk-create these clauses on contract {contract}.
        slots:
          contract: path.contractId
      - text: Add a batch of clauses to contract {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clauses/bulk'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete many clauses from a contract
      effect: destructive
      questions:
      - Can I remove several clauses from a contract in a single call?
      - What is the bulk way to delete a contract's clauses?
      instructions:
      - text: Bulk-delete the listed clauses from contract {contract}.
        slots:
          contract: path.contractId
      - text: Remove this set of clauses from contract {contract} together.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clauses/{contractClauseId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one clause from a contract
      effect: destructive
      questions:
      - How do I remove a single clause from a contract?
      - Is deleting one contract clause by its ID permanent?
      instructions:
      - text: Delete clause {clause} from contract {contract}.
        slots:
          clause: path.contractClauseId
          contract: path.contractId
      - text: Remove only contract {contract} clause {clause}.
        slots:
          contract: path.contractId
          clause: path.contractClauseId
      method: generated
      generated: '2026-10-01'