GetResponse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GetResponse APIv3 Categories API

6 actions 6 updates phrasing extends openapi/getresponse-categories-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}/categories'].get

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

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

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

$.paths['/shops/{shopId}/categories/{categoryId}'].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 Categories API
  version: 1.0.0
extends: openapi/getresponse-categories-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}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's product categories
      effect: read
      questions:
      - Which product categories exist in my shop?
      - Can I find the sub-categories under a given parent category?
      instructions:
      - text: List categories in shop {shopId}.
        slots:
          shopId: path.shopId
      - text: Show categories in shop {shopId} under parent {parentId}.
        slots:
          shopId: path.shopId
          parentId: query.query[parentId]
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shop category
      effect: write
      questions:
      - How do I add a new product category to my shop?
      - Can I create a sub-category by giving it a parent?
      instructions:
      - text: Create a category named {name} in shop {shopId}.
        slots:
          name: requestBody.name
          shopId: path.shopId
      - text: Add sub-category {name} under {parentId} in shop {shopId}.
        slots:
          name: requestBody.name
          parentId: requestBody.parentId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/categories/{categoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shop category
      effect: read
      questions:
      - What are the details of one category in my shop?
      - Can I look up a category's parent and URL by its ID?
      instructions:
      - text: Show category {categoryId} in shop {shopId}.
        slots:
          categoryId: path.categoryId
          shopId: path.shopId
      - text: Get the parent and URL of category {categoryId} in shop {shopId}.
        slots:
          categoryId: path.categoryId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/categories/{categoryId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a shop category
      effect: write
      questions:
      - Can I rename an existing shop category?
      - Is it possible to move a category under a different parent?
      instructions:
      - text: Rename category {categoryId} in shop {shopId} to {name}.
        slots:
          categoryId: path.categoryId
          shopId: path.shopId
          name: requestBody.name
      - text: Move category {categoryId} in shop {shopId} under parent {parentId}.
        slots:
          categoryId: path.categoryId
          shopId: path.shopId
          parentId: requestBody.parentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/shops/{shopId}/categories/{categoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shop category
      effect: destructive
      questions:
      - How can I remove a category from my shop?
      - Can I permanently delete a product category I no longer use?
      instructions:
      - text: Delete category {categoryId} from shop {shopId}.
        slots:
          categoryId: path.categoryId
          shopId: path.shopId
      - text: Remove product category {categoryId} from shop {shopId}.
        slots:
          categoryId: path.categoryId
          shopId: path.shopId
      method: generated
      generated: '2026-09-26'