From 82b6e3225e2b5543296d2af4dc462c2b9905cb5b Mon Sep 17 00:00:00 2001 From: Peter Kingswell Date: Wed, 24 Mar 2021 15:51:44 -0400 Subject: [PATCH] adds x-client-id header to example curl in docco --- docs/_layouts/api-endpoint.html | 2 +- docs/content/_endpoints/post-query-batch.md | 6 +++--- docs/content/_endpoints/post-query-metrics.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_layouts/api-endpoint.html b/docs/_layouts/api-endpoint.html index 6a4ebfad3..6da322ae2 100644 --- a/docs/_layouts/api-endpoint.html +++ b/docs/_layouts/api-endpoint.html @@ -48,7 +48,7 @@

Example Curl

{% endunless %} {%- endcapture %} - $ curl -X{{ page.method }} {{ headers -}} + $ curl {{ page.x-client-id-header }} -X{{ page.method }} {{ headers -}} http://localhost:8080{{ page.endpoint }} {%- unless page.empty %} \ -d '{{ request | normalize_whitespace }}' diff --git a/docs/content/_endpoints/post-query-batch.md b/docs/content/_endpoints/post-query-batch.md index 76d3a8eda..7bed6832f 100644 --- a/docs/content/_endpoints/post-query-batch.md +++ b/docs/content/_endpoints/post-query-batch.md @@ -1,6 +1,7 @@ --- method: POST endpoint: /query/batch +x-client-id-header: "-H 'x-client-id: my-app'" help: Perform a batch query description: Run multiple metrics query in a batch. fields: @@ -14,6 +15,5 @@ response_fields: purpose: Responses to each query run. --- This accepts a JSON document where all keys are expected to map up to a Query. -

-Note that the x-client-id: my_app_name -header must be supplied since anonymous requests are not permitted. \ No newline at end of file + +*Note that the `x-client-id: my_app_name` header must be supplied since anonymous requests are not permitted.* diff --git a/docs/content/_endpoints/post-query-metrics.md b/docs/content/_endpoints/post-query-metrics.md index e247aa889..b7554d8f3 100644 --- a/docs/content/_endpoints/post-query-metrics.md +++ b/docs/content/_endpoints/post-query-metrics.md @@ -1,6 +1,7 @@ --- method: POST endpoint: /query/metrics +x-client-id-header: "-H 'x-client-id: my-app'" help: Query for metrics description: Query and aggregate metrics. fields: @@ -33,5 +34,4 @@ response_fields: type_name: 'Statistics' purpose: 'Statistics about the current query. This field should be inspected for errors which will have caused the result to be inconsistent.' --- -Note that the x-client-id: my_app_name -header must be supplied since anonymous requests are not permitted. \ No newline at end of file +*Note that the `x-client-id: my_app_name` header must be supplied since anonymous requests are not permitted.*