# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Category Tax Exemptions API
  version: 1.0.0
extends: openapi/optimizely-category-tax-exemptions-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/CategoryTaxExemptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List category tax exemptions
      effect: read
      questions:
      - Which product categories have tax exemptions assigned?
      - Can I filter category tax exemptions by category ID?
      instructions:
      - text: List all category tax exemptions.
      - text: Find category tax exemptions matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryTaxExemptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Assign a tax exemption to a category
      effect: write
      questions:
      - How do I make a product category tax exempt?
      - Can I link an existing tax exemption to a catalog category?
      instructions:
      - text: Apply tax exemption {taxExemptionId} to category {categoryId}.
        slots:
          taxExemptionId: requestBody.taxExemptionId
          categoryId: requestBody.categoryId
      - text: Create a category tax exemption linking category {categoryId} to exemption {taxExemptionId}.
        slots:
          categoryId: requestBody.categoryId
          taxExemptionId: requestBody.taxExemptionId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryTaxExemptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category tax exemption by ID
      effect: read
      questions:
      - Which category and exemption does one category tax exemption record link?
      - Can I look up a single category tax exemption by its ID?
      instructions:
      - text: Get category tax exemption {id}.
        slots:
          id: path.id
      - text: Show the category and exemption linked by record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryTaxExemptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a category tax exemption
      effect: write
      questions:
      - Can I overwrite a whole category tax exemption record at once?
      - What does a full replace of a category tax exemption expect in the body?
      instructions:
      - text: Replace category tax exemption {id} with category {categoryId} and exemption {taxExemptionId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
          taxExemptionId: requestBody.taxExemptionId
      - text: Overwrite the entire category tax exemption {id} using a full PUT.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryTaxExemptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a tax exemption from a category
      effect: destructive
      questions:
      - How do I stop a category from being tax exempt?
      - Does deleting a category tax exemption accept an If-Match ETag?
      instructions:
      - text: Delete category tax exemption {id}.
        slots:
          id: path.id
      - text: Delete category tax exemption {id} only if its ETag matches {ifMatch}.
        slots:
          id: path.id
          ifMatch: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryTaxExemptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a category tax exemption
      effect: write
      questions:
      - How do I switch an existing category exemption to a different tax exemption?
      - Can I move a category tax exemption to another category without replacing it?
      instructions:
      - text: Change the exemption on category tax exemption {id} to {taxExemptionId}.
        slots:
          id: path.id
          taxExemptionId: requestBody.taxExemptionId
      - text: Point category tax exemption {id} at category {categoryId}.
        slots:
          id: path.id
          categoryId: requestBody.categoryId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryTaxExemptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a default category tax exemption template
      effect: read
      questions:
      - What default values does a new category tax exemption start with?
      - Is there a blank category tax exemption template to fetch first?
      instructions:
      - text: Fetch the default category tax exemption template.
      - text: Show me the default values for a new category tax exemption.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categorytaxexemptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete category tax exemptions
      effect: destructive
      questions:
      - How do I delete several category tax exemptions at once?
      - Can I pass a list of IDs to remove many category tax exemptions?
      instructions:
      - text: Bulk delete the category tax exemptions with IDs {ids}.
        slots:
          ids: query.ids
      - text: 'Remove all of these category tax exemptions in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categorytaxexemptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a category tax exemption
      effect: read
      questions:
      - Where do I read a custom property stored on a category tax exemption?
      - Can I fetch one extra property value from a category tax exemption?
      instructions:
      - text: Get custom property {custompropertyKey} on category tax exemption {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show the custom property {custompropertyKey} of category tax exemption {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'