Update http api docs with meta

grafana · Jan 8, 2020 · 8064f48 · 8064f48
1 parent 7c2bca7
commit 8064f48
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/docs/cloud/http-api.md b/docs/cloud/http-api.md
@@ -281,6 +281,7 @@ that duplicate entries will be returned.
 * from: Graphite [from time specification](#fromto) (optional. defaults to now-24hours)
 * format: series-json, lastts-json. (defaults to series-json)
 * limit: max number to return, 0 to defer to the instance configured max (default: 0). Note: if limit is 0 or greater than the instance configured max and the result set is greater than the instance configured max, an error is returned. Otherwise, the result set is truncated at the limit
+* meta: If false and format is `series-json` then return series names as array (graphite compatibility). If true, include meta information like warnings.  (defaults to false)
 
 ##### Example
 

diff --git a/docs/http-api.md b/docs/http-api.md
@@ -83,6 +83,7 @@ that duplicate entries will be returned.
 * from: Graphite [from time specification](#fromto) (optional. defaults to now-24hours)
 * format: series-json, lastts-json. (defaults to series-json)
 * limit: max number to return, 0 to defer to `http.max-series-per-req` (default: 0). Note: if limit is 0 or greater than `http.max-series-per-req` and the result set is greater than `http.max-series-per-req`, an error is returned. Otherwise, the result set is truncated at the limit
+* meta: If false and format is `series-json` then return series names as array (graphite compatibility). If true, include meta information like warnings.  (defaults to false)
 
 ##### Example