[docs] Add M3-Restrict-By-Tags-JSON example to docs (#2437)

m3db · Jul 2, 2020 · e601e67 · e601e67
1 parent 4401470
commit e601e67
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/docs/common/headers_optional_read_all.md b/docs/common/headers_optional_read_all.md
@@ -0,0 +1,13 @@
+--8<--
+docs/common/headers_optional_read_limits.md
+--8<--
+- `M3-Restrict-By-Tags-JSON`:  
+ If this header is set it can ensure specific label matching is performed as part
+of every query including series metadata endpoints. As an example, the following 
+header would unconditionally cause `globaltag=somevalue` to be a part of all queries
+issued regardless of if they include the label or not in a query and also strip the
+"globaltag" from appearing as a label in any of the resulting timeseries:
+```
+M3-Restrict-By-Tags-JSON: '{"match":[{"name":"globaltag","type":"EQUAL","value":"somevalue"}],"strip":["globaltag"]}'
+```
+<br /><br />
diff --git a/docs/m3coordinator/api/remote.md b/docs/m3coordinator/api/remote.md
@@ -100,7 +100,7 @@ None.
 docs/common/headers_optional_read_write_all.md
 --8<--
 --8<--
-docs/common/headers_optional_read_limits.md
+docs/common/headers_optional_read_all.md
 --8<--
 
 ### Data Params

diff --git a/docs/m3query/api/index.md b/docs/m3query/api/index.md
@@ -36,7 +36,7 @@ Query using PromQL and returns JSON datapoints compatible with the Prometheus Gr
 docs/common/headers_optional_read_write_all.md
 --8<--
 --8<--
-docs/common/headers_optional_read_limits.md
+docs/common/headers_optional_read_all.md
 --8<--
 
 ### Data Params