Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Testimonial API

5 actions 5 updates phrasing extends openapi/hint-health-testimonial-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}/testimonials'].get
$.paths['/partner/products/{product_id}/testimonials'].post
$.paths['/partner/products/{product_id}/testimonials/{id}'].delete
$.paths['/partner/products/{product_id}/testimonials/{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 Testimonial API
  version: 1.0.0
extends: openapi/hint-health-testimonial-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}/testimonials'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's testimonials
      effect: read
      questions:
      - What customer testimonials are on my partner product listing?
      - Which quotes appear on my product page, and in what order?
      instructions:
      - text: List testimonials for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show customer quotes on product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/testimonials'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a testimonial to a product
      effect: write
      questions:
      - Can I add a customer quote to my product listing?
      - What author details does a product testimonial need?
      instructions:
      - text: Add testimonial {text} by {author}, {author_title}, to product {product_id}.
        slots:
          text: requestBody.text
          author: requestBody.author
          author_title: requestBody.author_title
          product_id: path.product_id
      - text: Post a new quote from {author} ({author_title}) on product {product_id} saying {text}.
        slots:
          author: requestBody.author
          author_title: requestBody.author_title
          product_id: path.product_id
          text: requestBody.text
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/testimonials/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product testimonial
      effect: destructive
      questions:
      - Can I remove a testimonial from my product listing?
      - Is deleting a testimonial permanent?
      instructions:
      - text: Delete testimonial {id} from product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      - text: Remove customer quote {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}/testimonials/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product testimonial
      effect: write
      questions:
      - Can I edit the wording of an existing testimonial?
      - Is it possible to change the author's title on a testimonial?
      instructions:
      - text: Update testimonial {id} on product {product_id} to {text} by {author}, {author_title}.
        slots:
          id: path.id
          product_id: path.product_id
          text: requestBody.text
          author: requestBody.author
          author_title: requestBody.author_title
      - text: 'Edit existing testimonial {id} on product {product_id}: author {author}, title {author_title}, wording {text}.'
        slots:
          id: path.id
          product_id: path.product_id
          author: requestBody.author
          author_title: requestBody.author_title
          text: requestBody.text
      method: generated
      generated: '2026-10-01'