Hint Health · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Endpoints Partner Product Precondition API

5 actions 5 updates phrasing extends openapi/hint-health-partnerproductprecondition-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}/preconditions'].get
$.paths['/partner/products/{product_id}/preconditions'].post
$.paths['/partner/products/{product_id}/preconditions/{id}'].delete
$.paths['/partner/products/{product_id}/preconditions/{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 Precondition API
  version: 1.0.0
extends: openapi/hint-health-partnerproductprecondition-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}/preconditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's install preconditions
      effect: read
      questions:
      - What preconditions must a practice meet before installing my product?
      - Which precondition URLs are attached to my partner product?
      instructions:
      - text: List preconditions for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show the install requirements on product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/preconditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a precondition to a product
      effect: write
      questions:
      - Can I require practices to complete a step before installing my product?
      - What type and URL does a new product precondition need?
      instructions:
      - text: Add a {type} precondition with URL {url} to product {product_id}.
        slots:
          type: requestBody.type
          url: requestBody.url
          product_id: path.product_id
      - text: Require practices to complete {type} at {url} before installing product {product_id}.
        slots:
          type: requestBody.type
          url: requestBody.url
          product_id: path.product_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{product_id}/preconditions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product precondition
      effect: destructive
      questions:
      - Can I drop a precondition that practices no longer need to meet?
      - Is removing a product precondition permanent?
      instructions:
      - text: Delete precondition {id} from product {product_id}.
        slots:
          id: path.id
          product_id: path.product_id
      - text: Remove install requirement {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}/preconditions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product precondition
      effect: write
      questions:
      - Can I change the URL of an existing product precondition?
      - Is it possible to switch an existing precondition to a different type?
      instructions:
      - text: Update precondition {id} on product {product_id} to type {type} and URL {url}.
        slots:
          id: path.id
          product_id: path.product_id
          type: requestBody.type
          url: requestBody.url
      - text: Point existing precondition {id} of product {product_id} at new URL {url}, keeping type {type}.
        slots:
          id: path.id
          product_id: path.product_id
          url: requestBody.url
          type: requestBody.type
      method: generated
      generated: '2026-10-01'