From e023d896f2d79b1a48bbd345429c6b496cf46cc8 Mon Sep 17 00:00:00 2001 From: Charles Korn Date: Tue, 31 Jan 2023 19:04:17 +1100 Subject: [PATCH] Correct statement in docs about query results returning either floats or histograms but not both. (#11880) * Correct statement in docs about query results returning either floats or histograms but not both. * Move documentation for range and instant vectors under their corresponding headings. Signed-off-by: Charles Korn --- docs/querying/api.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/querying/api.md b/docs/querying/api.md index 53d12052c..f2182a205 100644 --- a/docs/querying/api.md +++ b/docs/querying/api.md @@ -449,9 +449,7 @@ raw numbers. The keys `"histogram"` and `"histograms"` only show up if the experimental native histograms are present in the response. Their placeholder `` -is explained in detail in its own section below. Any one object will only have -the `"value"`/`"values"` key or the `"histogram"`/`"histograms"` key, but not -both. +is explained in detail in its own section below. ### Range vectors @@ -469,6 +467,9 @@ Range vectors are returned as result type `matrix`. The corresponding ] ``` +Each series could have the `"values"` key, or the `"histograms"` key, or both. +For a given timestamp, there will only be one sample of either float or histogram type. + ### Instant vectors Instant vectors are returned as result type `vector`. The corresponding @@ -485,6 +486,8 @@ Instant vectors are returned as result type `vector`. The corresponding ] ``` +Each series could have the `"value"` key, or the `"histogram"` key, but not both. + ### Scalars Scalar results are returned as result type `scalar`. The corresponding