ClickHouse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ClickHouse HTTP Interface Ping API

2 actions 2 updates phrasing extends openapi/clickhouse-ping-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/ping'].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 ClickHouse HTTP Interface Ping API
  version: 1.0.0
extends: openapi/clickhouse-ping-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: 1
- target: $.paths['/ping'].get
  update:
    x-apievangelist-phrasing:
      intent: Ping the server to check it is healthy
      effect: read
      questions:
      - Is my ClickHouse server up and responding?
      - What endpoint can a load balancer hit to confirm the server is healthy?
      instructions:
      - text: Ping the server and confirm it answers Ok.
      - text: Run a liveness check against the /ping endpoint.
      method: generated
      generated: '2026-10-01'