Hilt · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Hilt So System API

3 actions 3 updates phrasing extends openapi/hilt-so-system-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/health'].get

$.paths['/v1/health'].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 Hilt So System API
  version: 1.0.0
extends: openapi/hilt-so-system-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check service health at the root path
      effect: read
      questions:
      - Is the Hilt service up at the root /health check?
      - What's the unversioned health endpoint for load balancers?
      instructions:
      - text: Check the root /health endpoint.
      - text: Ping the unversioned health check.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check v1 API health
      effect: read
      questions:
      - Is the v1 API responding right now?
      - Where's the versioned health check for the v1 API?
      instructions:
      - text: Check the /v1/health endpoint.
      - text: Ping the v1 API health check.
      method: generated
      generated: '2026-09-26'