ClickHouse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for ClickHouse HTTP Interface Play API

2 actions 2 updates phrasing extends openapi/clickhouse-play-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['/play'].get

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 ClickHouse HTTP Interface Play API
  version: 1.0.0
extends: openapi/clickhouse-play-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['/play'].get
  update:
    x-apievangelist-phrasing:
      intent: Open the built-in Play web UI
      effect: read
      questions:
      - Where is the browser-based SQL console that ships with ClickHouse?
      - Can I write and run queries from a web page served by the server itself?
      instructions:
      - text: Open the embedded Play web UI on my server.
      - text: Load the Play query console page in the browser.
      method: generated
      generated: '2026-10-01'