Merge pull request #14429 from prometheus/document-info-annotations

Document info-level annotations in query response
pull/14430/head
Björn Rabenstein 5 months ago committed by GitHub
commit 06f0f2ef3b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -25,8 +25,10 @@ Other non-`2xx` codes may be returned for errors occurring before the API
endpoint is reached. endpoint is reached.
An array of warnings may be returned if there are errors that do An array of warnings may be returned if there are errors that do
not inhibit the request execution. All of the data that was successfully not inhibit the request execution. An additional array of info-level
collected will be returned in the data field. annotations may be returned for potential query issues that may or may
not be false positives. All of the data that was successfully collected
will be returned in the data field.
The JSON response envelope format is as follows: The JSON response envelope format is as follows:
@ -40,9 +42,11 @@ The JSON response envelope format is as follows:
"errorType": "<string>", "errorType": "<string>",
"error": "<string>", "error": "<string>",
// Only if there were warnings while executing the request. // Only set if there were warnings while executing the request.
// There will still be data in the data field. // There will still be data in the data field.
"warnings": ["<string>"] "warnings": ["<string>"],
// Only set if there were info-level annnotations while executing the request.
"infos": ["<string>"]
} }
``` ```

Loading…
Cancel
Save