Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Partner Product Link API

5 actions 5 updates phrasing extends openapi/hint-health-partnerproductlink-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}/links'].get
$.paths['/partner/products/{product_id}/links'].post
$.paths['/partner/products/{product_id}/links/{id}'].delete
$.paths['/partner/products/{product_id}/links/{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 Link API
  version: 1.0.0
extends: openapi/hint-health-partnerproductlink-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}/links'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's links
      effect: read
      questions:
      - Which links are attached to my product listing?
      - In what order are links shown on a product?
      instructions:
      - text: List links for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show every link on product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/links'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a link to a product listing
      effect: write
      questions:
      - How do I add a link with UTM tracking to my product listing?
      - Can I control the position of a new link on my product?
      instructions:
      - text: Add a {link_type} link {value} to product {product_id}.
        slots:
          link_type: requestBody.link_type
          value: requestBody.value
          product_id: path.product_id
      - text: Add {link_type} link {value} titled {title} to product {product_id} with UTM campaign {utm_campaign}.
        slots:
          link_type: requestBody.link_type
          value: requestBody.value
          title: requestBody.title
          product_id: path.product_id
          utm_campaign: requestBody.utm_campaign
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/links/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a link from a product
      effect: destructive
      questions:
      - Can I delete a link from my product listing?
      - Can I remove an outdated link from a product?
      instructions:
      - text: Delete link {id} from product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      - text: Remove product {product_id}'s link {id}.
        slots:
          id: path.id
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/links/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a product link
      effect: write
      questions:
      - How do I change the URL or title of an existing product link?
      - Can I reorder an existing link on my product?
      instructions:
      - text: Update link {id} on product {product_id} to {link_type} {value}.
        slots:
          id: path.id
          product_id: path.product_id
          link_type: requestBody.link_type
          value: requestBody.value
      - text: Move link {id} on product {product_id} to position {position}, keeping type {link_type} and value {value}.
        slots:
          id: path.id
          product_id: path.product_id
          position: requestBody.position
          link_type: requestBody.link_type
          value: requestBody.value
      method: generated
      generated: '2026-10-01'