ClickHouse · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for OpenAPI spec for ClickHouse Cloud Prometheus API

6 actions 6 updates phrasing extends openapi/clickhouse-prometheus-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 6

$.info

$.paths['/v1/organizations/{organizationId}/prometheus'].get

$.paths['/v1/organizations/{organizationId}/prometheus/discovery'].get

$.paths['/v1/organizations/{organizationId}/services/{serviceId}/prometheus'].get

$.paths['/v1/organizations/{organizationId}/postgres/prometheus'].get

$.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/prometheus'].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 OpenAPI spec for ClickHouse Cloud Prometheus API
  version: 1.0.0
extends: openapi/clickhouse-prometheus-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: 5
- target: $.paths['/v1/organizations/{organizationId}/prometheus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get org-wide Prometheus metrics (deprecated)
      effect: read
      questions:
      - Can I still scrape all my services' metrics from the older single org-wide Prometheus endpoint?
      - Is there a way to limit the legacy org metrics feed to a filtered set of metrics?
      instructions:
      - text: Fetch Prometheus metrics for all services in org {org} from the deprecated org-wide endpoint.
        slots:
          org: path.organizationId
      - text: Get the legacy organization metrics for org {org} with filtered metrics set to {filtered_metrics}.
        slots:
          org: path.organizationId
          filtered_metrics: query.filtered_metrics
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/prometheus/discovery'].get
  update:
    x-apievangelist-phrasing:
      intent: List Prometheus scrape targets for every service
      effect: read
      questions:
      - How do I point Prometheus http_sd service discovery at all my ClickHouse services?
      - Which scrape targets does my organization expose for Prometheus?
      instructions:
      - text: List Prometheus scrape targets for every service in org {org}.
        slots:
          org: path.organizationId
      - text: Get http_sd discovery targets for organization {org} with filtered metrics {filtered_metrics}.
        slots:
          org: path.organizationId
          filtered_metrics: query.filtered_metrics
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/prometheus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Prometheus metrics for one ClickHouse service
      effect: read
      questions:
      - How do I scrape Prometheus metrics from a single ClickHouse service?
      - Can I get just the filtered set of metrics for one service?
      instructions:
      - text: Get Prometheus metrics for ClickHouse service {service} in org {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      - text: Scrape service {service} in organization {org} with filtered metrics {filtered_metrics}.
        slots:
          service: path.serviceId
          org: path.organizationId
          filtered_metrics: query.filtered_metrics
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/prometheus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Prometheus metrics for all Postgres services
      effect: read
      questions:
      - How do I scrape metrics for every managed Postgres service in my org at once?
      - How many Postgres services can the org-wide Postgres metrics feed cover?
      instructions:
      - text: Get Prometheus metrics for all Postgres services in org {org}.
        slots:
          org: path.organizationId
      - text: Scrape the combined PostgreSQL metrics feed for organization {org}.
        slots:
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/postgres/{postgresId}/prometheus'].get
  update:
    x-apievangelist-phrasing:
      intent: Get Prometheus metrics for one Postgres service
      effect: read
      questions:
      - How do I scrape Prometheus metrics from a single managed Postgres service?
      - What metrics does one PostgreSQL service expose to Prometheus?
      instructions:
      - text: Get Prometheus metrics for Postgres service {postgres} in org {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      - text: Scrape PostgreSQL service {postgres} in organization {org}.
        slots:
          postgres: path.postgresId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'