(skywalking-query-protocol) 01/01: Add comments for MQE tracing

[wankai]

This is an automated email from the ASF dual-hosted git repository.

wankai pushed a commit to branch mqe-trace-comment
in repository https://gitbox.apache.org/repos/asf/skywalking-query-protocol.git

commit 4fb19b43f476f0b225c3cbd7bf050454704a04f2
Author: wankai123 <wankai...@foxmail.com>
AuthorDate: Tue Jun 18 15:51:24 2024 +0800

    Add comments for MQE tracing
---
 common.graphqls     | 2 +-
 metrics-v3.graphqls | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/common.graphqls b/common.graphqls
index 98bd655..5d5ec16 100644
--- a/common.graphqls
+++ b/common.graphqls
@@ -134,7 +134,7 @@ type DebuggingSpan {
     startTime: Long!
     endTime: Long!
     duration: Long!
-    msg: String!
+    msg: String
     error: String
 }
 
diff --git a/metrics-v3.graphqls b/metrics-v3.graphqls
index 173c0b0..c4fd56a 100644
--- a/metrics-v3.graphqls
+++ b/metrics-v3.graphqls
@@ -99,5 +99,7 @@ extend type Query {
     # Get the list of all available metrics in the current OAP server.
     # Param, regex, could be used to filter the metrics by name.
     listMetrics(regex: String): [MetricDefinition!]!
+    # Param, if debug is true will enable the query tracing and return 
DebuggingTrace in the ExpressionResult.
+    # Param, if dumpDBRsp is true the database response will dump into the 
DebuggingTrace span message.
     execExpression(expression: String!, entity: Entity!, duration: Duration!, 
debug: Boolean, dumpDBRsp: Boolean): ExpressionResult!
 }