Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Partner Product Highlight API

5 actions 5 updates phrasing extends openapi/hint-health-partnerproducthighlight-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/{product_id}/highlights'].get
$.paths['/partner/products/{product_id}/highlights'].post
$.paths['/partner/products/{product_id}/highlights/{id}'].delete
$.paths['/partner/products/{product_id}/highlights/{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 Partner Endpoints Partner Product Highlight API
  version: 1.0.0
extends: openapi/hint-health-partnerproducthighlight-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/{product_id}/highlights'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's highlights
      effect: read
      questions:
      - What highlights are shown on my partner product listing?
      - In what order do my product highlights appear?
      instructions:
      - text: List highlights for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show the feature highlights on product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/highlights'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a highlight to a product listing
      effect: write
      questions:
      - Can I add an image highlight to my product listing?
      - How do I add a new feature highlight for my product?
      instructions:
      - text: Add highlight {title} to product {product_id}.
        slots:
          title: requestBody.title
          product_id: path.product_id
      - text: Create a highlight on product {product_id} titled {title} with description {description}.
        slots:
          product_id: path.product_id
          title: requestBody.title
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/highlights/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product highlight
      effect: destructive
      questions:
      - Can I remove an outdated highlight from my product listing?
      - Is deleting a product highlight permanent?
      instructions:
      - text: Delete highlight {id} from product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      - text: Remove the highlight {id} on product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/highlights/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product highlight
      effect: write
      questions:
      - Can I reorder the highlights on my product listing?
      - Is it possible to change the image of an existing highlight?
      instructions:
      - text: Move highlight {id} on product {product_id} to position {position}.
        slots:
          id: path.id
          product_id: path.product_id
          position: requestBody.position
      - text: Retitle highlight {id} on product {product_id} as {title}.
        slots:
          id: path.id
          product_id: path.product_id
          title: requestBody.title
      method: generated
      generated: '2026-10-01'