# 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 Click Pipes API
  version: 1.0.0
extends: openapi/clickhouse-clickpipes-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: 18
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes'].get
  update:
    x-apievangelist-phrasing:
      intent: List a service's ClickPipes
      effect: read
      questions:
      - Which ClickPipes are ingesting data into my ClickHouse service?
      - Can I see all the ingestion pipes set up on one service?
      instructions:
      - text: List all ClickPipes on service {service} in org {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      - text: Show every ingestion pipe feeding service {service} in organization {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ClickPipe to ingest data
      effect: write
      questions:
      - How do I start streaming data from a source into a ClickHouse table?
      - Can I set up a new pipe with custom field mappings to my destination table?
      instructions:
      - text: Create a ClickPipe named {name} on service {service} in org {org} reading from {source}.
        slots:
          name: requestBody.name
          service: path.serviceId
          org: path.organizationId
          source: requestBody.source
      - text: Set up a new pipe on service {service} in organization {org} from {source} into destination {destination} with field mappings {fieldMappings}.
        slots:
          service: path.serviceId
          org: path.organizationId
          source: requestBody.source
          destination: requestBody.destination
          fieldMappings: requestBody.fieldMappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/context'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a service's ClickPipes capabilities and identity
      effect: read
      questions:
      - Which GCP service account do I need to grant access to my source for ClickPipes?
      - What ClickPipes capabilities does this particular service support?
      instructions:
      - text: Get the ClickPipes service context for service {service} in org {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      - text: Show the workload identity service account ClickPipes uses for service {service} in organization {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get details of one ClickPipe
      effect: read
      questions:
      - What is the current state and source of a specific ClickPipe?
      - Is one of my pipes running, stopped or failed?
      instructions:
      - text: Show ClickPipe {pipe} on service {service} in org {org}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      - text: Check the status and scaling of pipe {pipe} on service {service} in organization {org}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ClickPipe
      effect: destructive
      questions:
      - How do I permanently remove an ingestion pipe I no longer need?
      - Can I tear down a ClickPipe instead of just stopping it?
      instructions:
      - text: Delete ClickPipe {pipe} from service {service} in org {org}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      - text: Remove pipe {pipe} on service {service} in organization {org} for good.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a ClickPipe's name, source or mappings
      effect: write
      questions:
      - Which source fields can I still change after a pipe is created?
      - How do I rename a ClickPipe or adjust its field mappings?
      instructions:
      - text: Rename ClickPipe {pipe} on service {service} in org {org} to {name}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
          name: requestBody.name
      - text: Change the field mappings of existing pipe {pipe} on service {service} in organization {org} to {fieldMappings}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
          fieldMappings: requestBody.fieldMappings
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ClickPipe's advanced settings
      effect: read
      questions:
      - What advanced tuning settings are applied to one of my ClickPipes?
      - What insert thread and wait-time settings is my pipe using right now?
      instructions:
      - text: Show the advanced settings of ClickPipe {pipe} on service {service} in org {org}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      - text: Get the tuning parameters for pipe {pipe} on service {service} in organization {org}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Tune a ClickPipe's advanced settings
      effect: write
      questions:
      - Can I make a streaming pipe wait longer before inserting to batch bigger blocks?
      - How do I raise the number of insert threads a ClickPipe uses?
      - Is there a setting to read only committed Kafka messages?
      instructions:
      - text: Set streaming max insert wait to {streaming_max_insert_wait_ms} ms on ClickPipe {pipe} on service {service} in org {org}.
        slots:
          streaming_max_insert_wait_ms: requestBody.streaming_max_insert_wait_ms
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      - text: Use {clickhouse_max_insert_threads} insert threads for pipe {pipe} on service {service} in organization {org}.
        slots:
          clickhouse_max_insert_threads: requestBody.clickhouse_max_insert_threads
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      - text: Poll object storage every {object_storage_polling_interval_ms} ms for pipe {pipe} on service {service} in org {org}.
        slots:
          object_storage_polling_interval_ms: requestBody.object_storage_polling_interval_ms
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/schemaDiscovery'].post
  update:
    x-apievangelist-phrasing:
      intent: Infer the schema of a ClickPipe source
      effect: read
      questions:
      - Can ClickHouse detect the column names and types in my source before I build a pipe?
      - What ClickHouse data types would my incoming data map to?
      instructions:
      - text: Discover the schema of source {source} for service {service} in org {org}.
        slots:
          source: requestBody.source
          service: path.serviceId
          org: path.organizationId
      - text: Infer field names and ClickHouse types from {source} before creating a pipe on service {service} in organization {org}.
        slots:
          source: requestBody.source
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/scaling'].patch
  update:
    x-apievangelist-phrasing:
      intent: Scale a streaming or object storage ClickPipe
      effect: write
      questions:
      - How do I add more replicas to a Kafka or Kinesis pipe that's falling behind?
      - Can I give an S3 ingestion pipe more CPU and memory per replica?
      instructions:
      - text: Scale ClickPipe {pipe} on service {service} in org {org} to {replicas} replicas.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
          replicas: requestBody.replicas
      - text: Give each replica of pipe {pipe} on service {service} in organization {org} {replicaCpuMillicores} millicores and {replicaMemoryGb} GB.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
          replicaCpuMillicores: requestBody.replicaCpuMillicores
          replicaMemoryGb: requestBody.replicaMemoryGb
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipes/{clickPipeId}/state'].patch
  update:
    x-apievangelist-phrasing:
      intent: Start, stop or resync a ClickPipe
      effect: write
      questions:
      - How do I pause a ClickPipe and restart it later?
      - Can I restart a pipe that's in a failed state?
      - Which pipes can be resynced from scratch?
      instructions:
      - text: Stop ClickPipe {pipe} on service {service} in org {org}.
        slots:
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      - text: Send command {command} to pipe {pipe} on service {service} in organization {org}.
        slots:
          command: requestBody.command
          pipe: path.clickPipeId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shared scaling for database CDC ClickPipes
      effect: read
      questions:
      - How much compute is allocated to my Postgres and MySQL CDC pipes?
      - What CPU and memory do the database ClickPipes on a service share?
      instructions:
      - text: Show the CDC ClickPipes scaling for service {service} in org {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      - text: Get the shared CPU and memory settings for database pipes on service {service} in organization {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesCdcScaling'].patch
  update:
    x-apievangelist-phrasing:
      intent: Resize shared compute for database CDC ClickPipes
      effect: write
      questions:
      - How do I give my Postgres CDC replication more CPU and memory?
      - Can I scale down the infrastructure shared by all database pipes on a service?
      instructions:
      - text: Set CDC ClickPipes on service {service} in org {org} to {replicaCpuMillicores} millicores and {replicaMemoryGb} GB.
        slots:
          service: path.serviceId
          org: path.organizationId
          replicaCpuMillicores: requestBody.replicaCpuMillicores
          replicaMemoryGb: requestBody.replicaMemoryGb
      - text: Increase memory for database CDC pipes on service {service} in organization {org} to {replicaMemoryGb} GB.
        slots:
          service: path.serviceId
          org: path.organizationId
          replicaMemoryGb: requestBody.replicaMemoryGb
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints'].get
  update:
    x-apievangelist-phrasing:
      intent: List reverse private endpoints for ClickPipes
      effect: read
      questions:
      - Which reverse private endpoints are set up for private ClickPipes connectivity?
      - Can I see all the private links ClickPipes uses to reach my sources?
      instructions:
      - text: List reverse private endpoints on service {service} in org {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      - text: Show all private connections ClickPipes uses for service {service} in organization {org}.
        slots:
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reverse private endpoint for ClickPipes
      effect: write
      questions:
      - How do I let ClickPipes reach my Kafka cluster over a private link instead of the internet?
      - Can I connect ClickPipes to an MSK cluster or a VPC endpoint service privately?
      instructions:
      - text: Create a reverse private endpoint of type {type} on service {service} in org {org} for VPC endpoint service {vpcEndpointServiceName}.
        slots:
          type: requestBody.type
          service: path.serviceId
          org: path.organizationId
          vpcEndpointServiceName: requestBody.vpcEndpointServiceName
      - text: Set up a private endpoint to MSK cluster {mskClusterArn} for service {service} in organization {org}.
        slots:
          mskClusterArn: requestBody.mskClusterArn
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one reverse private endpoint
      effect: read
      questions:
      - What's the status of a specific reverse private endpoint I created?
      - Which DNS mappings are on one of my ClickPipes private endpoints?
      instructions:
      - text: Show reverse private endpoint {endpoint} on service {service} in org {org}.
        slots:
          endpoint: path.reversePrivateEndpointId
          service: path.serviceId
          org: path.organizationId
      - text: Check the configuration of private endpoint {endpoint} for service {service} in organization {org}.
        slots:
          endpoint: path.reversePrivateEndpointId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a reverse private endpoint
      effect: destructive
      questions:
      - How do I remove a reverse private endpoint that ClickPipes no longer needs?
      - Can I delete a private link to one of my ingestion sources?
      instructions:
      - text: Delete reverse private endpoint {endpoint} from service {service} in org {org}.
        slots:
          endpoint: path.reversePrivateEndpointId
          service: path.serviceId
          org: path.organizationId
      - text: Tear down private endpoint {endpoint} used by ClickPipes on service {service} in organization {org}.
        slots:
          endpoint: path.reversePrivateEndpointId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/organizations/{organizationId}/services/{serviceId}/clickpipesReversePrivateEndpoints/{reversePrivateEndpointId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a reverse private endpoint's DNS mappings
      effect: write
      questions:
      - How do I update the custom private DNS mappings on a reverse private endpoint?
      - Can I clear all DNS mappings from an existing private endpoint?
      instructions:
      - text: Replace the DNS mappings on reverse private endpoint {endpoint} for service {service} in org {org} with {customPrivateDnsMappings}.
        slots:
          endpoint: path.reversePrivateEndpointId
          service: path.serviceId
          org: path.organizationId
          customPrivateDnsMappings: requestBody.customPrivateDnsMappings
      - text: Clear every custom DNS mapping from private endpoint {endpoint} on service {service} in organization {org}.
        slots:
          endpoint: path.reversePrivateEndpointId
          service: path.serviceId
          org: path.organizationId
      method: generated
      generated: '2026-09-26'