GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Taxes API

6 actions 6 updates phrasing extends openapi/getresponse-taxes-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for GetResponse's API. It is a proposal applied on top of the contract, not a document GetResponse publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/shops/{shopId}/taxes'].get

$.paths['/shops/{shopId}/taxes'].post

$.paths['/shops/{shopId}/taxes/{taxId}'].get

$.paths['/shops/{shopId}/taxes/{taxId}'].post

$.paths['/shops/{shopId}/taxes/{taxId}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GetResponse APIv3 Taxes API
  version: 1.0.0
extends: openapi/getresponse-taxes-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: 5
- target: $.paths['/shops/{shopId}/taxes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's taxes
      effect: read
      questions:
      - Which tax rates are defined in my shop?
      - Can I find a shop tax by name?
      instructions:
      - text: List taxes in shop {shopId}.
        slots:
          shopId: path.shopId
      - text: Find taxes named {name} in shop {shopId}.
        slots:
          name: query.query[name]
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/taxes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shop tax
      effect: write
      questions:
      - How do I add a new tax rate to my shop?
      - What fields does a new tax need?
      instructions:
      - text: Create a tax named {name} at rate {rate} in shop {shopId}.
        slots:
          name: requestBody.name
          rate: requestBody.rate
          shopId: path.shopId
      - text: Add a new {rate} tax rate called {name} to shop {shopId}.
        slots:
          rate: requestBody.rate
          name: requestBody.name
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/taxes/{taxId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shop tax
      effect: read
      questions:
      - What rate is set on one particular tax?
      - Can I look up a single tax by its ID?
      instructions:
      - text: Show tax {taxId} in shop {shopId}.
        slots:
          taxId: path.taxId
          shopId: path.shopId
      - text: Get the rate of tax {taxId} in shop {shopId}.
        slots:
          taxId: path.taxId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/taxes/{taxId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a shop tax
      effect: write
      questions:
      - Can I change the rate of an existing tax?
      - Is it possible to rename a tax in my shop?
      instructions:
      - text: Change tax {taxId} in shop {shopId} to rate {rate}.
        slots:
          taxId: path.taxId
          shopId: path.shopId
          rate: requestBody.rate
      - text: Rename tax {taxId} in shop {shopId} to {name}.
        slots:
          taxId: path.taxId
          shopId: path.shopId
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/taxes/{taxId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shop tax
      effect: destructive
      questions:
      - How do I remove a tax from my shop?
      - Can a tax rate be permanently deleted?
      instructions:
      - text: Delete tax {taxId} from shop {shopId}.
        slots:
          taxId: path.taxId
          shopId: path.shopId
      - text: Remove the tax rate {taxId} from shop {shopId}.
        slots:
          taxId: path.taxId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'