Skip to content
This repository has been archived by the owner on Mar 27, 2021. It is now read-only.

adds x-client-id header to example curl in docco #766

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_layouts/api-endpoint.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h4>Example Curl</h4>
{%
endunless %}
{%- endcapture %}
$ curl -X{{ page.method }} {{ headers -}}
$ curl {{ page.x-client-id-header }} -X{{ page.method }} {{ headers -}}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does {{ headers -}} not imply all headers here anyway?

http://localhost:8080{{ page.endpoint }}
{%- unless page.empty %} \
-d '{{ request | normalize_whitespace }}'
Expand Down
6 changes: 3 additions & 3 deletions docs/content/_endpoints/post-query-batch.md
Original file line number Diff line number Diff line change
@@ -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:
Expand All @@ -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.
<p></p>
<em>Note that the <code>x-client-id: my_app_name</code>
header must be supplied since anonymous requests are not permitted.</em>

*Note that the `x-client-id: my_app_name` header must be supplied since anonymous requests are not permitted.*
4 changes: 2 additions & 2 deletions docs/content/_endpoints/post-query-metrics.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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.'
---
<em>Note that the <code>x-client-id: my_app_name</code>
header must be supplied since anonymous requests are not permitted.</em>
*Note that the `x-client-id: my_app_name` header must be supplied since anonymous requests are not permitted.*