Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Partner Product Overview API

3 actions 3 updates phrasing extends openapi/hint-health-partnerproductoverview-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 3

$.info
$.paths['/partner/products/{product_id}/overview'].get
$.paths['/partner/products/{product_id}/overview'].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 Overview API
  version: 1.0.0
extends: openapi/hint-health-partnerproductoverview-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: 2
- target: $.paths['/partner/products/{product_id}/overview'].get
  update:
    x-apievangelist-phrasing:
      intent: View a product's overview
      effect: read
      questions:
      - What description and images appear on my product's overview?
      - Can I see the current overview content for a partner product?
      instructions:
      - text: Show the overview for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Get the listing description of product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/overview'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a product's overview
      effect: write
      questions:
      - Can I rewrite the description on my product's overview?
      - Is it possible to replace the images in a product overview?
      instructions:
      - text: Set the overview description of product {product_id} to {description}.
        slots:
          product_id: path.product_id
          description: requestBody.description
      - text: Replace the overview images on product {product_id} with {images}.
        slots:
          product_id: path.product_id
          images: requestBody.images
      method: generated
      generated: '2026-10-01'