Skip to content

Commit

Permalink
Update Swagger Documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Mahad Zaryab <[email protected]>
  • Loading branch information
mahadzaryab1 committed Dec 26, 2024
1 parent c34879b commit f526d35
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions swagger/api_v3/query_service.swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,13 @@
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "raw_traces",
"description": "If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored.",
"in": "query",
"required": false,
"type": "boolean"
}
],
"tags": [
Expand Down Expand Up @@ -354,6 +361,10 @@
"type": "integer",
"format": "int32",
"description": "Maximum depth of search. Depending on the backend storage\nimplementtaion this could be like a regular LIMIT clause in SQL,\nbut not all implementations support such accuracy and for those\nthe larger depth value simply means more traces returned."
},
"raw_traces": {
"type": "boolean",
"description": "If set to true, the response will not perform any enrichments to the trace, such as clock skew adjustment. Instead, the trace will be returned exactly as stored."
}
},
"description": "Query parameters to find traces. Except for num_traces, all fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\".\nAll fields are matched against individual spans, not at the trace level.\nThe returned results contain traces where at least one span matches the conditions.\nWhen num_traces results in fewer traces returned, there is no required ordering.\n\nNote: num_traces should restrict the number of traces returned, but not all backends\ninterpret it this way. For instance, in Cassandra this limits the number of _spans_\nthat match the conditions, and the resulting number of traces can be less.\n\nNote: some storage implementations do not guarantee the correct implementation of all parameters."
Expand Down

0 comments on commit f526d35

Please sign in to comment.