# 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 Lifecycle API
  version: 1.0.0
extends: openapi/conga-contract-lifecycle-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: 9
- target: $.paths['/api/clm/v1/contracts/{contractId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a signed contract
      effect: write
      questions:
      - How do I bring a fully signed contract into effect?
      - What needs to be true before a contract can be activated?
      instructions:
      - text: Activate contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Put signed contract {contract_id} into effect.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/amend'].post
  update:
    x-apievangelist-phrasing:
      intent: Amend a contract
      effect: write
      questions:
      - Can I modify a contract's terms mid-term by creating an amended version?
      - What contract number does an amendment get?
      instructions:
      - text: Amend contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Create an amended version of contract {contract_id}.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a contract
      effect: destructive
      questions:
      - Which contract statuses allow a contract to be canceled?
      - What status does a contract end up in after cancellation?
      instructions:
      - text: Cancel contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Cancel the in-authoring contract {contract_id}.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a contract
      effect: write
      questions:
      - Can I copy an existing contract into a new version without changing the original?
      - What data carries over when a contract is cloned?
      instructions:
      - text: Clone contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Make a copy of contract {contract_id} as a new version.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/expire'].post
  update:
    x-apievangelist-phrasing:
      intent: Expire a contract
      effect: destructive
      questions:
      - How do I mark a contract as expired when its term ends?
      - Which statuses must a contract be in before it can expire?
      instructions:
      - text: Expire contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Mark contract {contract_id} as expired now that its term is over.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/renew'].post
  update:
    x-apievangelist-phrasing:
      intent: Renew a contract
      effect: write
      questions:
      - Can I renew a contract at the end of its term?
      - What start date does a renewed contract get?
      instructions:
      - text: Renew contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Create the renewal for contract {contract_id}.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/submitrequest'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a contract request for processing
      effect: write
      questions:
      - How does a contract get sent through the steps in its agreement rule?
      - Can I submit a contract request so processing begins?
      instructions:
      - text: Submit the request for contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: Send contract {contract_id} into agreement rule processing.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/terminate'].post
  update:
    x-apievangelist-phrasing:
      intent: Terminate an active contract
      effect: destructive
      questions:
      - Can I terminate an executed contract early?
      - Are related amendments and renewals also terminated with the contract?
      instructions:
      - text: Terminate contract {contract_id}.
        slots:
          contract_id: path.contractId
      - text: End activated contract {contract_id} and its amendments and renewals.
        slots:
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/update-contract-lifecycle-status'].post
  update:
    x-apievangelist-phrasing:
      intent: Set contract status from a lifecycle action
      effect: write
      questions:
      - Can I update a contract's status and status category by naming a lifecycle action?
      - Does the record type affect which status a lifecycle action sets?
      instructions:
      - text: Update contract {contract_id} status for lifecycle action {action}.
        slots:
          contract_id: path.contractId
          action: requestBody.LifeCycleAction
      - text: Apply lifecycle action {action} with record type {record_type} to contract {contract_id}.
        slots:
          action: requestBody.LifeCycleAction
          record_type: requestBody.RecordType
          contract_id: path.contractId
      method: generated
      generated: '2026-10-01'