Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Product Category API

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

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/partner/products/categories'].get
$.paths['/partner/products/{product_id}/categories'].get
$.paths['/partner/products/{product_id}/categories'].post
$.paths['/partner/products/{product_id}/categories/{id}'].delete

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 Partner Endpoints Product Category API
  version: 1.0.0
extends: openapi/hint-health-product-category-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/partner/products/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List all marketplace categories
      effect: read
      questions:
      - Which marketplace categories are available to tag my product with?
      - What categories are currently in use across the marketplace?
      instructions:
      - text: List all available marketplace product categories.
      - text: Show every category in use in the marketplace.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List categories on one product
      effect: read
      questions:
      - Which categories is my product currently listed under?
      - How do I check the categories attached to a specific product?
      instructions:
      - text: List categories attached to product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show product {product_id}'s categories.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a category to a product
      effect: write
      questions:
      - How do I add my product to an existing marketplace category?
      - Can I attach a category by name instead of by id?
      - Can partners create a brand-new category name?
      instructions:
      - text: Attach category {category_id} to product {product_id}.
        slots:
          category_id: requestBody.category_id
          product_id: path.product_id
      - text: Add product {product_id} to the category named {name}.
        slots:
          product_id: path.product_id
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a category from a product
      effect: destructive
      questions:
      - How do I take my product out of a category?
      - Does detaching a category delete it for other products?
      instructions:
      - text: Detach category {id} from product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      - text: Remove product {product_id} from category {id}.
        slots:
          id: path.id
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'