Optimizely · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Admin API V1 Local Tax Rate Tax Exemptions API

10 actions 10 updates phrasing extends openapi/optimizely-local-tax-rate-tax-exemptions-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Optimizely's API. It is a proposal applied on top of the contract, not a document Optimizely publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 10

$.info
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions'].get
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions'].post
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].get
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].put
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].delete
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].patch
$.paths['/api/v1/admin/LocalTaxRateTaxExemptions/Default.Default()'].get
$.paths['/api/v1/admin/localtaxratetaxexemptions/delete'].delete
$.paths['/api/v1/admin/localtaxratetaxexemptions({key})/customproperties({custompropertyKey})'].get

OpenAPI Overlay

Raw ↑
# 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 Local Tax Rate Tax Exemptions API
  version: 1.0.0
extends: openapi/optimizely-local-tax-rate-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/LocalTaxRateTaxExemptions'].get
  update:
    x-apievangelist-phrasing:
      intent: List tax exemptions on local tax rates
      effect: read
      questions:
      - How do I see which tax exemptions are linked to which local tax rates?
      - Can I filter the links to one local tax rate?
      instructions:
      - text: List local tax rate exemption links matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} tax rate exemption links.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/LocalTaxRateTaxExemptions'].post
  update:
    x-apievangelist-phrasing:
      intent: Link a tax exemption to a local tax rate
      effect: write
      questions:
      - Can I attach a tax exemption to a specific postal-code tax rate?
      - What ids do I need to connect an exemption with a local rate?
      instructions:
      - text: Link tax exemption {taxExemptionId} to local tax rate {localTaxRateId}.
        slots:
          taxExemptionId: requestBody.taxExemptionId
          localTaxRateId: requestBody.localTaxRateId
      - text: Apply exemption {taxExemptionId} to the local rate {localTaxRateId}.
        slots:
          taxExemptionId: requestBody.taxExemptionId
          localTaxRateId: requestBody.localTaxRateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one tax rate exemption link
      effect: read
      questions:
      - Where do I look up a single tax rate exemption link by id?
      - Which exemption and local rate does a given link record join?
      instructions:
      - text: Get tax rate exemption link {id}.
        slots:
          id: path.id
      - text: Show the exemption and rate joined by record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a tax rate exemption link
      effect: write
      questions:
      - How do I overwrite a tax rate exemption link with new ids?
      - Can I fully replace an exemption-to-rate link in one call?
      instructions:
      - text: Replace link {id} with exemption {taxExemptionId} and local rate {localTaxRateId}.
        slots:
          id: path.id
          taxExemptionId: requestBody.taxExemptionId
          localTaxRateId: requestBody.localTaxRateId
      - text: Overwrite the whole tax rate exemption link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unlink a tax exemption from a local rate
      effect: destructive
      questions:
      - Can I detach an exemption from a local tax rate?
      - Is an If-Match ETag honored when removing an exemption link?
      instructions:
      - text: Delete tax rate exemption link {id}.
        slots:
          id: path.id
      - text: Remove exemption link {id} only if ETag {etag} matches.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/LocalTaxRateTaxExemptions({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a tax rate exemption link
      effect: write
      questions:
      - Can I switch an existing link to a different tax exemption?
      - How do I point an exemption link at another local rate without replacing it?
      instructions:
      - text: Change link {id} to exemption {taxExemptionId}.
        slots:
          id: path.id
          taxExemptionId: requestBody.taxExemptionId
      - text: Repoint existing link record {id} at a different rate, {localTaxRateId}.
        slots:
          id: path.id
          localTaxRateId: requestBody.localTaxRateId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/LocalTaxRateTaxExemptions/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Call the Default function on tax rate exemptions
      effect: read
      questions:
      - What does the Default function on LocalTaxRateTaxExemptions return?
      - Where do I get the default tax rate exemption link entity?
      instructions:
      - text: Call the Default function on LocalTaxRateTaxExemptions.
      - text: Fetch the default local tax rate exemption entity.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/localtaxratetaxexemptions/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk remove tax rate exemption links
      effect: destructive
      questions:
      - Can I remove many exemption-to-rate links at once by id?
      - Is there a bulk delete for local tax rate exemptions?
      instructions:
      - text: Bulk delete tax rate exemption links {ids}.
        slots:
          ids: query.ids
      - text: Remove every exemption link in the id list {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/localtaxratetaxexemptions({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an exemption link
      effect: read
      questions:
      - How do I read a custom property stored on a tax rate exemption link?
      - Can I fetch one extension field from an exemption link record?
      instructions:
      - text: Get custom property {custompropertyKey} of exemption link {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Show custom field {custompropertyKey} on tax rate exemption {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'