add summaries to methods

percona · Mar 20, 2022 · f0a372e · f0a372e
1 parent 619927e
commit f0a372e
Show file tree

Hide file tree

Showing 6 changed files with 156 additions and 113 deletions.
diff --git a/api/managementpb/checks.pb.go b/api/managementpb/checks.pb.go
diff --git a/api/managementpb/checks.proto b/api/managementpb/checks.proto
@@ -143,20 +143,32 @@ service SecurityChecks {
       post: "/v1/management/SecurityChecks/ListFailedServices"
       body: "*"
     };
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      summary: "List Failed Services"
+      description: "Returns a list of services with failed checks and a summary of check results."
+    };
   }
   // GetFailedChecks returns the checks result for a given service.
   rpc GetFailedChecks(GetFailedChecksRequest) returns (GetFailedChecksResponse) {
     option (google.api.http) = {
       post: "/v1/management/SecurityChecks/FailedChecks"
       body: "*"
     };
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      summary: "Get Failed Checks"
+      description: "Returns the latest check results for a given service."
+    };
   }
   // ToggleCheckAlert allows to switch alerts state for a check result between "silenced" and "unsilenced".
   rpc ToggleCheckAlert(ToggleCheckAlertRequest) returns (ToggleCheckAlertResponse) {
     option (google.api.http) = {
       post: "/v1/management/SecurityChecks/ToggleCheckAlert"
       body: "*"
     };
+    option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_operation) = {
+      summary: "Toggle Check Alert"
+      description: "Silence/Unsilence alerts for a specific check result."
+    };
   }
   // GetSecurityCheckResults returns Security Thread Tool's latest checks results.
   rpc GetSecurityCheckResults(GetSecurityCheckResultsRequest) returns (GetSecurityCheckResultsResponse) {

diff --git a/api/managementpb/json/client/security_checks/security_checks_client.go b/api/managementpb/json/client/security_checks/security_checks_client.go
diff --git a/api/managementpb/json/managementpb.json b/api/managementpb/json/managementpb.json
@@ -5749,10 +5749,11 @@
     },
     "/v1/management/SecurityChecks/FailedChecks": {
       "post": {
+        "description": "Returns the latest check results for a given service.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "GetFailedChecks returns the checks result for a given service.",
+        "summary": "Get Failed Checks",
         "operationId": "GetFailedChecks",
         "parameters": [
           {
@@ -6165,10 +6166,11 @@
     },
     "/v1/management/SecurityChecks/ListFailedServices": {
       "post": {
+        "description": "Returns a list of services with failed checks and a summary of check results.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "ListFailedServices returns a list of services with failed checks.",
+        "summary": "List Failed Services",
         "operationId": "ListFailedServices",
         "parameters": [
           {
@@ -6346,10 +6348,11 @@
     },
     "/v1/management/SecurityChecks/ToggleCheckAlert": {
       "post": {
+        "description": "Silence/Unsilence alerts for a specific check result.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "ToggleCheckAlert allows to switch alerts state for a check result between \"silenced\" and \"unsilenced\".",
+        "summary": "Toggle Check Alert",
         "operationId": "ToggleCheckAlert",
         "parameters": [
           {

diff --git a/api/swagger/swagger-dev.json b/api/swagger/swagger-dev.json
@@ -24549,10 +24549,11 @@
     },
     "/v1/management/SecurityChecks/FailedChecks": {
       "post": {
+        "description": "Returns the latest check results for a given service.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "GetFailedChecks returns the checks result for a given service.",
+        "summary": "Get Failed Checks",
         "operationId": "GetFailedChecks",
         "parameters": [
           {
@@ -24965,10 +24966,11 @@
     },
     "/v1/management/SecurityChecks/ListFailedServices": {
       "post": {
+        "description": "Returns a list of services with failed checks and a summary of check results.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "ListFailedServices returns a list of services with failed checks.",
+        "summary": "List Failed Services",
         "operationId": "ListFailedServices",
         "parameters": [
           {
@@ -25146,10 +25148,11 @@
     },
     "/v1/management/SecurityChecks/ToggleCheckAlert": {
       "post": {
+        "description": "Silence/Unsilence alerts for a specific check result.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "ToggleCheckAlert allows to switch alerts state for a check result between \"silenced\" and \"unsilenced\".",
+        "summary": "Toggle Check Alert",
         "operationId": "ToggleCheckAlert",
         "parameters": [
           {

diff --git a/api/swagger/swagger.json b/api/swagger/swagger.json
@@ -18494,10 +18494,11 @@
     },
     "/v1/management/SecurityChecks/FailedChecks": {
       "post": {
+        "description": "Returns the latest check results for a given service.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "GetFailedChecks returns the checks result for a given service.",
+        "summary": "Get Failed Checks",
         "operationId": "GetFailedChecks",
         "parameters": [
           {
@@ -18910,10 +18911,11 @@
     },
     "/v1/management/SecurityChecks/ListFailedServices": {
       "post": {
+        "description": "Returns a list of services with failed checks and a summary of check results.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "ListFailedServices returns a list of services with failed checks.",
+        "summary": "List Failed Services",
         "operationId": "ListFailedServices",
         "parameters": [
           {
@@ -19091,10 +19093,11 @@
     },
     "/v1/management/SecurityChecks/ToggleCheckAlert": {
       "post": {
+        "description": "Silence/Unsilence alerts for a specific check result.",
         "tags": [
           "SecurityChecks"
         ],
-        "summary": "ToggleCheckAlert allows to switch alerts state for a check result between \"silenced\" and \"unsilenced\".",
+        "summary": "Toggle Check Alert",
         "operationId": "ToggleCheckAlert",
         "parameters": [
           {