# 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 Product API
  version: 1.0.0
extends: openapi/hint-health-product-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: 6
- target: $.paths['/partner/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List my partner products
      effect: read
      questions:
      - Which marketplace products have I created as a partner?
      - Can I list my products filtered by backend?
      instructions:
      - text: List my partner products.
      - text: List my products on backend {backend}.
        slots:
          backend: query.backend
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a marketplace product
      effect: write
      questions:
      - What does it take to create a new product listing for the Hint marketplace?
      - What details like summary, icon and builder name can I set on a new product?
      instructions:
      - text: Create a product named {name} with summary {summary}.
        slots:
          name: requestBody.name
          summary: requestBody.summary
      - text: Create product {name} of type {type}, built by {built_by_name} at {built_by_url}.
        slots:
          name: requestBody.name
          type: requestBody.type
          built_by_name: requestBody.built_by_name
          built_by_url: requestBody.built_by_url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one partner product
      effect: read
      questions:
      - What details are stored on one of my products?
      - What does a specific product listing currently contain?
      instructions:
      - text: Show product {id}.
        slots:
          id: path.id
      - text: Get the full details of my product {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a partner product
      effect: destructive
      questions:
      - Can I delete a product I no longer want listed?
      - Can I permanently remove one of my marketplace products?
      instructions:
      - text: Delete product {id}.
        slots:
          id: path.id
      - text: Permanently remove my product listing {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Edit a partner product listing
      effect: write
      questions:
      - How do I change the name, summary or icon of an existing product?
      - Can I update the slug of a product after it is created?
      instructions:
      - text: Rename product {id} to {name}.
        slots:
          id: path.id
          name: requestBody.name
      - text: Update the summary of product {id} to {summary}.
        slots:
          id: path.id
          summary: requestBody.summary
      - text: Change the icon of product {id} to {icon}.
        slots:
          id: path.id
          icon: requestBody.icon
      method: generated
      generated: '2026-10-01'
- target: $.paths['/partner/products/{id}/request_review'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a product for marketplace review
      effect: write
      questions:
      - What step sends my product for review before it goes live in the marketplace?
      - Can I ask for my product listing to be reviewed?
      instructions:
      - text: Request review of product {id}.
        slots:
          id: path.id
      - text: Submit product {id} for marketplace review.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'