Explorium · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Service Healthcheck API

3 actions 3 updates phrasing extends openapi/explorium-health-check-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Explorium's API. It is a proposal applied on top of the contract, not a document Explorium publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/healthcheck/http'].get

$.paths['/healthcheck/http_payload/{response_bytes}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Partner Service Healthcheck API
  version: 1.0.0
extends: openapi/explorium-health-check-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['/healthcheck/http'].get
  update:
    x-apievangelist-phrasing:
      intent: Check that the service is up
      effect: read
      questions:
      - Is the enrichment service up and responding?
      - Can I ping the API to confirm it's healthy?
      instructions:
      - text: Check the service health.
      - text: Ping the HTTP healthcheck.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/healthcheck/http_payload/{response_bytes}'].get
  update:
    x-apievangelist-phrasing:
      intent: Run a healthcheck returning a sized payload
      effect: read
      questions:
      - Can I test the API's response with a payload of a specific size?
      - What healthcheck lets me measure throughput by requesting a number of bytes?
      instructions:
      - text: Run a payload healthcheck returning {response_bytes} bytes.
        slots:
          response_bytes: path.response_bytes
      - text: Test the service with a {response_bytes}-byte response.
        slots:
          response_bytes: path.response_bytes
      method: generated
      generated: '2026-10-01'