# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DoiT Contracts API
  version: 1.0.0
extends: openapi/doit-contracts-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['/customers/{customerID}/contracts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's contracts
      effect: read
      questions:
      - Which contracts does a given customer hold?
      - Can I see contracts for one of my descendant tenants?
      instructions:
      - text: List contracts for customer {customerID}.
        slots:
          customerID: path.customerID
      - text: Show every contract held by {customerID}.
        slots:
          customerID: path.customerID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customerID}/contracts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a draft contract
      effect: write
      questions:
      - How do I create a new draft contract for a customer?
      - What fields are required to draft a contract?
      instructions:
      - text: Draft contract {name} for customer {customerID} starting {startDate} with renewal {renewalPolicy}.
        slots:
          customerID: path.customerID
          name: requestBody.name
          startDate: requestBody.startDate
          renewalPolicy: requestBody.renewalPolicy
      - text: Create a draft contract {name} for {customerID} billed to profile {billingProfile}.
        slots:
          name: requestBody.name
          customerID: path.customerID
          billingProfile: requestBody.billingProfile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customerID}/contracts/{contractID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a contract
      effect: read
      questions:
      - How do I see the details of a specific customer contract?
      - What are the dates and renewal terms on one contract?
      instructions:
      - text: Get contract {contractID} for customer {customerID}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
      - text: Show the terms of contract {contractID} of {customerID}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customerID}/contracts/{contractID}'].post
  update:
    x-apievangelist-phrasing:
      intent: Save a new version of a contract
      effect: write
      questions:
      - How do I change the end date on an existing contract?
      - Does editing a contract create a new version?
      instructions:
      - text: Update contract {contractID} for {customerID} to end on {endDate}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
          endDate: requestBody.endDate
      - text: Rename contract {contractID} of customer {customerID} to {name}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customerID}/contracts/{contractID}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate a draft contract
      effect: write
      questions:
      - How do I make a draft contract live?
      - What happens if I activate a contract whose start date is in the future?
      instructions:
      - text: Activate contract {contractID} for customer {customerID}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
      - text: Move draft {contractID} of {customerID} to active.
        slots:
          contractID: path.contractID
          customerID: path.customerID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/customers/{customerID}/contracts/{contractID}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a contract
      effect: destructive
      questions:
      - How do I end an active contract since it can't be deleted?
      - Can I record why a contract was cancelled?
      instructions:
      - text: Cancel contract {contractID} for customer {customerID}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
      - text: Cancel contract {contractID} of {customerID} because {reason}.
        slots:
          contractID: path.contractID
          customerID: path.customerID
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'