API Evangelist conversational phrasing for Contracts Contract Relationship 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 Relationship API
  version: 1.0.0
extends: openapi/conga-contract-relationship-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/clm/v1/contracts/{contractId}/hierarchy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract's hierarchy of child contracts
      effect: read
      questions:
      - Which child and descendant contracts sit under a parent contract?
      - Can I limit a contract hierarchy to system relationships only?
      instructions:
      - text: Show the contract hierarchy beneath contract {contractId}.
        slots:
          contractId: path.contractId
      - text: 'Get descendants of contract {contractId}, system relationships only: {onlySystemRelationship}.'
        slots:
          contractId: path.contractId
          onlySystemRelationship: query.onlySystemRelationship
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/relationships'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract's relationship details
      effect: read
      questions:
      - Is a contract linked to any amendments or renewals?
      - What relationship records does a contract have?
      instructions:
      - text: Show the relationship details of contract {contractId}.
        slots:
          contractId: path.contractId
      - text: List the links recorded on contract {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/relationships'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a contract as amendment or renewal of another
      effect: write
      questions:
      - How do I mark one contract as an amendment or renewal of another?
      - Which relationship types can I use when linking two contracts?
      instructions:
      - text: Link contract {contractId} to {RelatedContractId} as {RelationshipType}.
        slots:
          contractId: path.contractId
          RelatedContractId: requestBody.RelatedContractId
          RelationshipType: requestBody.RelationshipType
      - text: Record that contract {contractId} is a renewal for contract {RelatedContractId}.
        slots:
          contractId: path.contractId
          RelatedContractId: requestBody.RelatedContractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/relationships/link'].post
  update:
    x-apievangelist-phrasing:
      intent: Link two contracts with from and to relationship types
      effect: write
      questions:
      - Can I set both directions of a contract relationship explicitly when linking?
      - Is there a way to link contracts using a custom from-type and to-type pair?
      instructions:
      - text: Link contract {contractId} to {RelatedContractId} with from-type {RelationshipFromType} and to-type {RelationshipToType}.
        slots:
          contractId: path.contractId
          RelatedContractId: requestBody.RelatedContractId
          RelationshipFromType: requestBody.RelationshipFromType
          RelationshipToType: requestBody.RelationshipToType
      - text: Create a two-way relationship from {contractId} to {RelatedContractId} using explicit direction types.
        slots:
          contractId: path.contractId
          RelatedContractId: requestBody.RelatedContractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/relationships/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search a contract's related contracts
      effect: read
      questions:
      - Can I get a sorted list of the contracts related to one contract?
      - Which contracts are linked to this one, ordered how I choose?
      instructions:
      - text: Query the related contracts of {contractId} sorted by {SortInfo}.
        slots:
          contractId: path.contractId
          SortInfo: requestBody.SortInfo
      - text: Return the list of contracts related to {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/relationships/{relationshipId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink two related contracts
      effect: destructive
      questions:
      - How do I remove the link between two contracts?
      - Can I undo an amendment or renewal relationship I set by mistake?
      instructions:
      - text: Unlink relationship {relationshipId} from contract {contractId}.
        slots:
          relationshipId: path.relationshipId
          contractId: path.contractId
      - text: Delete the contract link {relationshipId} on {contractId}.
        slots:
          relationshipId: path.relationshipId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'