From fa573563984dae808f541690fcd1e15b60be2be3 Mon Sep 17 00:00:00 2001 From: Mahad Zaryab Date: Mon, 17 Feb 2025 15:03:23 -0500 Subject: [PATCH] Address Feedback Signed-off-by: Mahad Zaryab --- proto/api_v3/query_service.proto | 15 ++++++++------- swagger/api_v3/query_service.swagger.json | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/proto/api_v3/query_service.proto b/proto/api_v3/query_service.proto index d0def5e..6747505 100644 --- a/proto/api_v3/query_service.proto +++ b/proto/api_v3/query_service.proto @@ -40,15 +40,16 @@ message GetTraceRequest { bool raw_traces = 4; } -// Query parameters to find traces. All fields should be treated -// as forming a conjunction, e.g., "service_name='X' AND operation_name='Y' AND ...", -// with the exception of `search_depth` and `raw_traces`. +// Query parameters to find traces. // -// All fields are matched against individual spans, not at the trace level. -// The returned results contain traces where at least one span matches the conditions. -// There is no guaranteed ordering of the returned results. +// All fields form a conjunction (e.g., "service_name='X' AND operation_name='Y' AND ..."), +// except for `search_depth` and `raw_traces`. // -// Note: Some storage implementations do not guarantee the correct implementation of all parameters. +// Fields are matched against individual spans, not the trace level. The results include +// traces with at least one matching span. +// +// The results have no guaranteed ordering. Additionally, some storage implementations +// may not fully support all parameters. message TraceQueryParameters { // `service_name` filters traces generated by a specific service. string service_name = 1; diff --git a/swagger/api_v3/query_service.swagger.json b/swagger/api_v3/query_service.swagger.json index 506b07e..a76842f 100644 --- a/swagger/api_v3/query_service.swagger.json +++ b/swagger/api_v3/query_service.swagger.json @@ -378,7 +378,7 @@ "description": "If set to true, the response will exclude any enrichments to the trace, such as clock skew adjustments.\nThe trace will be returned exactly as stored.\n\nThis field is optional." } }, - "description": "Query parameters to find traces. All fields should be treated\nas forming a conjunction, e.g., \"service_name='X' AND operation_name='Y' AND ...\",\nwith the exception of `search_depth` and `raw_traces`.\n\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.\nThere is no guaranteed ordering of the returned results.\n\nNote: Some storage implementations do not guarantee the correct implementation of all parameters." + "description": "Query parameters to find traces.\n\nAll fields form a conjunction (e.g., \"service_name='X' AND operation_name='Y' AND ...\"),\nexcept for `search_depth` and `raw_traces`.\n\nFields are matched against individual spans, not the trace level. The results include\ntraces with at least one matching span.\n\nThe results have no guaranteed ordering. Additionally, some storage implementations\nmay not fully support all parameters." }, "protobufAny": { "type": "object",