RepoMirrors/prometheus
1
0
Fork 0
mirror of https://github.com/prometheus/prometheus synced 2024-12-26 16:43:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document info-level annotations in query response

Browse Source 
Fixes https://github.com/prometheus/prometheus/issues/14135

Signed-off-by: Julius Volz <julius.volz@gmail.com>
This commit is contained in:
Julius Volz 2024-07-06 23:50:40 +02:00
parent 480fefd089
commit 0f0b3d82e1
1 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/querying/api.md
View File

@ -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>"]
} }
``` ```