Drippay · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Drip Product Categories API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v1/product-categories'].get
$.paths['/v1/product-categories'].post
$.paths['/v1/product-categories/{id}'].delete
$.paths['/v1/product-categories/{id}'].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 Drip Product Categories API
  version: 1.0.0
extends: openapi/drippay-product-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: 4
- target: $.paths['/v1/product-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List product categories
      effect: read
      questions:
      - Which product categories exist in my taxonomy?
      - Can I leave archived categories out of the list?
      instructions:
      - text: List my product categories.
      - text: List product categories with includeArchived set to {includeArchived}.
        slots:
          includeArchived: query.includeArchived
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/product-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product category
      effect: write
      questions:
      - How do I add a new product category for revenue reporting?
      - Can a product category's key be changed after it's created?
      instructions:
      - text: Create a product category.
      - text: Add a new category to my product taxonomy.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/product-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Archive a product category
      effect: destructive
      questions:
      - How do I stop a product category from being attached to new pricing plans?
      - Can I un-archive a product category later?
      instructions:
      - text: Archive product category {id}.
        slots:
          id: path.id
      - text: Retire category {id} from new pricing plans.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/product-categories/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product category
      effect: write
      questions:
      - Can I change a product category's GL code or revenue class?
      - What can I edit on a category once it exists?
      instructions:
      - text: Update product category {id}.
        slots:
          id: path.id
      - text: Change the GL code on category {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'