# 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 Related List API
  version: 1.0.0
extends: openapi/conga-contract-related-list-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: 7
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several related records on a contract
      effect: write
      questions:
      - How do I bulk-update related list records on a contract?
      - Does each record in a bulk related-list update need its own Id?
      instructions:
      - text: Update multiple {objectName} records on contract {contractId}.
        slots:
          objectName: path.objectName
          contractId: path.contractId
      - text: Bulk-edit related list records, each identified by its Id.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create related records on a contract
      effect: write
      questions:
      - How do I add new related list records to a contract?
      - Can I create several records of a related object for one contract?
      instructions:
      - text: Create new {objectName} records on contract {contractId}.
        slots:
          objectName: path.objectName
          contractId: path.contractId
      - text: Add related list entries of type {objectName} to contract {contractId}.
        slots:
          objectName: path.objectName
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete related records from a contract
      effect: destructive
      questions:
      - How do I remove several related list records from a contract?
      - Can I wipe every record of a related object on a contract at once?
      instructions:
      - text: Delete {objectName} records {ObjectIds} from contract {contractId}.
        slots:
          objectName: path.objectName
          ObjectIds: requestBody.ObjectIds
          contractId: path.contractId
      - text: Delete all {objectName} records on contract {contractId} with DeleteAll {DeleteAll}.
        slots:
          objectName: path.objectName
          contractId: path.contractId
          DeleteAll: requestBody.DeleteAll
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Query related records on a contract
      effect: read
      questions:
      - How do I filter and sort a contract's related list records?
      - Can I get a total count when querying related records on a contract?
      instructions:
      - text: Query {objectName} records on contract {contractId} where {CriteriaExpression}.
        slots:
          objectName: path.objectName
          contractId: path.contractId
          CriteriaExpression: requestBody.CriteriaExpression
      - text: Fetch the first {Limit} {objectName} records for contract {contractId}.
        slots:
          Limit: requestBody.Limit
          objectName: path.objectName
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}/{objectId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one related record on a contract
      effect: read
      questions:
      - How do I see the details of one specific related record on a contract?
      - Can I fetch a single related list entry by object name and ID?
      instructions:
      - text: Show {objectName} record {objectId} on contract {contractId}.
        slots:
          objectName: path.objectName
          objectId: path.objectId
          contractId: path.contractId
      - text: Get details for related item {objectId} of contract {contractId}.
        slots:
          objectId: path.objectId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}/{objectId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update one related record on a contract
      effect: write
      questions:
      - How do I change a single related record on a contract?
      - Can I edit one related list entry by its ID?
      instructions:
      - text: Update {objectName} record {objectId} on contract {contractId}.
        slots:
          objectName: path.objectName
          objectId: path.objectId
          contractId: path.contractId
      - text: Edit only related item {objectId} on contract {contractId}.
        slots:
          objectId: path.objectId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/{objectName}/{objectId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one related record from a contract
      effect: destructive
      questions:
      - How do I delete a single related record from a contract?
      - Can I remove one related list entry by object name and ID?
      instructions:
      - text: Delete {objectName} record {objectId} from contract {contractId}.
        slots:
          objectName: path.objectName
          objectId: path.objectId
          contractId: path.contractId
      - text: Remove only related item {objectId} from contract {contractId}.
        slots:
          objectId: path.objectId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'