@@ -129,7 +129,7 @@ GET /query-endpoints/{queryEndpointId}/run
129129POST /query-endpoints/{queryEndpointId}/run
130130```
131131
132- ### HTTP Methods
132+ ### HTTP methods {#http-methods}
133133
134134| Method | Use Case | Parameters |
135135| ---------| ----------| ------------|
@@ -146,29 +146,29 @@ POST /query-endpoints/{queryEndpointId}/run
146146- When request body is preferred for security/privacy
147147- Streaming file uploads or large data
148148
149- ### Authentication
149+ ### Authentication {#authentication}
150150
151151** Required:** Yes
152152** Method:** Basic Auth using OpenAPI Key/Secret
153153** Permissions:** Appropriate permissions for the query endpoint
154154
155- ### Request Configuration
155+ ### Request configuration {#request-configuration}
156156
157- #### URL Parameters
157+ #### URL parameters {#url-params}
158158
159159| Parameter | Required | Description |
160160| -----------| ----------| -------------|
161161| ` queryEndpointId ` | ** Yes** | The unique identifier of the query endpoint to run |
162162
163- #### Query Parameters
163+ #### Query parameters {#query-params}
164164
165165| Parameter | Required | Description | Example |
166166| -----------| ----------| -------------| ---------|
167167| ` format ` | No | Response format (supports all ClickHouse formats) | ` ?format=JSONEachRow ` |
168168| ` param_:name ` | No | Query variables when request body is a stream. Replace ` :name ` with your variable name | ` ?param_year=2024 ` |
169169| ` :clickhouse_setting ` | No | Any supported [ ClickHouse setting] ( https://clickhouse.com/docs/operations/settings/settings ) | ` ?max_threads=8 ` |
170170
171- #### Headers
171+ #### Headers {#headers}
172172
173173| Header | Required | Description | Values |
174174| --------| ----------| -------------| --------|
@@ -177,16 +177,16 @@ POST /query-endpoints/{queryEndpointId}/run
177177
178178---
179179
180- ### Request Body
180+ ### Request body {#request-body}
181181
182- #### Parameters
182+ #### Parameters {#params}
183183
184184| Parameter | Type | Required | Description |
185185| -----------| ------| ----------| -------------|
186186| ` queryVariables ` | object | No | Variables to be used in the query |
187187| ` format ` | string | No | Response format |
188188
189- #### Supported Formats
189+ #### Supported formats {#supported-formats}
190190
191191| Version | Supported Formats |
192192| -------------------------| --------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -195,30 +195,30 @@ POST /query-endpoints/{queryEndpointId}/run
195195
196196---
197197
198- ### Responses
198+ ### Responses {#responses}
199199
200- #### Success
200+ #### Success {#success}
201201
202202** Status:** ` 200 OK `
203203The query was successfully executed.
204204
205- #### Error Codes
205+ #### Error codes {#error-codes}
206206
207207| Status Code | Description |
208208| -------------| -------------|
209209| ` 400 Bad Request ` | The request was malformed |
210210| ` 401 Unauthorized ` | Missing authentication or insufficient permissions |
211211| ` 404 Not Found ` | The specified query endpoint was not found |
212212
213- #### Error Handling Best Practices
213+ #### Error handling best practices {#error-handling-best-practices}
214214
215215- Ensure valid authentication credentials are included in the request
216216- Validate the ` queryEndpointId ` and ` queryVariables ` before sending
217217- Implement graceful error handling with appropriate error messages
218218
219219---
220220
221- ### Upgrading Endpoint Versions
221+ ### Upgrading endpoint versions {#upgrading-endpoint-versions}
222222
223223To upgrade from version 1 to version 2:
224224
0 commit comments