Omnisend · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Product Categories API

6 actions 6 updates phrasing extends openapi/omnisend-product-categories-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Omnisend's API. It is a proposal applied on top of the contract, not a document Omnisend publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/product-categories'].get
$.paths['/product-categories'].post
$.paths['/product-categories/{categoryID}'].get
$.paths['/product-categories/{categoryID}'].delete
$.paths['/product-categories/{categoryID}'].patch

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 Product Categories API
  version: 1.0.0
extends: openapi/omnisend-product-categories-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/product-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List product categories
      effect: read
      questions:
      - Which product categories are synced to my account?
      - Can I page through product categories with an offset and limit?
      instructions:
      - text: List product categories sorted by {sort}.
        slots:
          sort: query.sort
      - text: List {limit} product categories starting at offset {offset}.
        slots:
          limit: query.limit
          offset: query.offset
      method: generated
      generated: '2026-10-02'
- target: $.paths['/product-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product category
      effect: write
      questions:
      - How do I add a new product category to my catalog?
      - What ID and title does a new product category need?
      instructions:
      - text: Create product category {categoryID} titled {title}.
        slots:
          categoryID: requestBody.categoryID
          title: requestBody.title
      - text: Add a new category to my catalog with ID {categoryID} and name {title}.
        slots:
          categoryID: requestBody.categoryID
          title: requestBody.title
      method: generated
      generated: '2026-10-02'
- target: $.paths['/product-categories/{categoryID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product category
      effect: read
      questions:
      - Can I fetch one product category by its ID?
      - What title does a specific product category have?
      instructions:
      - text: Get product category {categoryID}.
        slots:
          categoryID: path.categoryID
      - text: Show the details of category {categoryID}.
        slots:
          categoryID: path.categoryID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/product-categories/{categoryID}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product category
      effect: destructive
      questions:
      - Can I delete a product category I no longer sell?
      - Is there a way to remove a category from my synced catalog?
      instructions:
      - text: Delete product category {categoryID}.
        slots:
          categoryID: path.categoryID
      - text: Remove category {categoryID} from the catalog.
        slots:
          categoryID: path.categoryID
      method: generated
      generated: '2026-10-02'
- target: $.paths['/product-categories/{categoryID}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename a product category
      effect: write
      questions:
      - Can I rename an existing product category?
      - How do I change the title of a category that's already synced?
      instructions:
      - text: Rename product category {categoryID} to {title}.
        slots:
          categoryID: path.categoryID
          title: requestBody.title
      - text: Change the title of existing category {categoryID} to {title}.
        slots:
          categoryID: path.categoryID
          title: requestBody.title
      method: generated
      generated: '2026-10-02'