# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Hint Health Credit Category API
  version: 1.0.0
extends: openapi/hint-health-creditcategory-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: 5
- target: $.paths['/provider/credit_categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List credit categories
      effect: read
      questions:
      - What credit categories are set up for my practice?
      - Which categories can I file a patient credit under?
      instructions:
      - text: List all credit categories.
      - text: Show every category available for patient credits.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/credit_categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a credit category
      effect: write
      questions:
      - Can I add a new category for grouping patient credits?
      - What is needed to set up a credit category?
      instructions:
      - text: Create a credit category named {name}.
        slots:
          name: requestBody.name
      - text: Add {name} as a new credit category.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/credit_categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a credit category
      effect: read
      questions:
      - What are the details of one credit category?
      - Can I fetch a single credit category by its id?
      instructions:
      - text: Show credit category {id}.
        slots:
          id: path.id
      - text: Get the name of credit category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/credit_categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a credit category
      effect: destructive
      questions:
      - Can I remove a credit category we no longer use?
      - Is deleting a credit category irreversible?
      instructions:
      - text: Delete credit category {id}.
        slots:
          id: path.id
      - text: Remove the credit category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/provider/credit_categories/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a credit category
      effect: write
      questions:
      - Can I rename an existing credit category?
      - Is changing a credit category's name possible after it's created?
      instructions:
      - text: Rename credit category {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Change the name of credit category {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'