PMM-5260 Deprecate ExampleFormat. (#488)

percona · Jan 21, 2020 · 28dd2ef · 28dd2ef
1 parent a36bb71
commit 28dd2ef
Show file tree

Hide file tree

Showing 10 changed files with 525 additions and 510 deletions.
diff --git a/api/agentpb/collector.pb.go b/api/agentpb/collector.pb.go
diff --git a/api/agentpb/collector.proto b/api/agentpb/collector.proto
@@ -7,10 +7,12 @@ option go_package = "agentpb";
 import "inventorypb/agents.proto";
 
 // ExampleFormat is format of query example: real or query without values.
+//
+// Deprecated: is not used, should not be used, should be removed.
 enum ExampleFormat {
-  EXAMPLE_FORMAT_INVALID = 0;
-  EXAMPLE = 1;
-  FINGERPRINT = 2;
+  EXAMPLE_FORMAT_INVALID = 0 [deprecated = true];
+  EXAMPLE = 1 [deprecated = true];
+  FINGERPRINT = 2 [deprecated = true];
 }
 
 // ExampleType is a type of query example selected for this query class in given period of time.
@@ -60,7 +62,7 @@ message MetricsBucket {
     uint32 period_length_secs = 11;
     // One of query example from set found in bucket.
     string example = 12;
-    ExampleFormat example_format = 13;
+    ExampleFormat example_format = 13 [deprecated = true];
     ExampleType example_type = 14;
     // Indicates if query examples is too long and was truncated.
     bool is_truncated = 24;

diff --git a/api/qanpb/collector.pb.go b/api/qanpb/collector.pb.go
diff --git a/api/qanpb/collector.proto b/api/qanpb/collector.proto
@@ -107,7 +107,7 @@ message MetricsBucket {
   uint32 period_length_secs = 11;
   // One of query example from set found in bucket.
   string example = 13;
-  ExampleFormat example_format = 14;
+  ExampleFormat example_format = 14 [deprecated = true];
   // Indicates if query examples is too long and was truncated.
   bool is_truncated = 15;
   ExampleType example_type = 16;

diff --git a/api/qanpb/json/client/object_details/get_query_example_responses.go b/api/qanpb/json/client/object_details/get_query_example_responses.go
diff --git a/api/qanpb/json/qanpb.json b/api/qanpb/json/qanpb.json
@@ -1447,7 +1447,7 @@
                         "x-order": 0
                       },
                       "example_format": {
-                        "description": "ExampleFormat is format of query example: real or query without values.",
+                        "description": "ExampleFormat is format of query example: real or query without values.\n\nDeprecated: is not used, should not be used, should be removed.",
                         "type": "string",
                         "default": "EXAMPLE_FORMAT_INVALID",
                         "enum": [

diff --git a/api/qanpb/object_details.pb.go b/api/qanpb/object_details.pb.go
diff --git a/api/qanpb/object_details.proto b/api/qanpb/object_details.proto
@@ -108,7 +108,7 @@ message QueryExampleReply {
 // QueryExample shows query examples and their metrics.
 message QueryExample {
   string example = 1;
-  ExampleFormat example_format = 2;
+  ExampleFormat example_format = 2 [deprecated = true];
   ExampleType example_type = 3;
   uint32 is_truncated = 4;
   string example_metrics = 5;