🧹 update documentation for protobuf and regenerate with latest protoc (…

…#5045) * 🧹 update documentation of proto file * 🧹 update generated protobuf code
mondoohq · Dec 30, 2024 · fe27e2e · fe27e2e
1 parent 6077ebd
commit fe27e2e
Show file tree

Hide file tree

Showing 19 changed files with 76 additions and 29 deletions.
diff --git a/cli/reporter/cnquery_report.pb.go b/cli/reporter/cnquery_report.pb.go
diff --git a/explorer/cnquery_explorer.pb.go b/explorer/cnquery_explorer.pb.go
diff --git a/explorer/cnquery_explorer.proto b/explorer/cnquery_explorer.proto
@@ -163,11 +163,20 @@ message Mquery {
 // protolint:disable ENUM_FIELD_NAMES_PREFIX
 // protolint:disable ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH
 enum ScoringSystem {
+  // Default value, should not be used
   SCORING_UNSPECIFIED = 0;
+  // Weighted scoring mechanism which uses the weight defined at the query
+  // level to calculate the score.
   WEIGHTED = 1;
+  // Worst scoring mechanism which uses the worst score of all findings
+  // to calculate the policy score.
   WORST = 2;
+  // Average scoring mechanism which uses the average score of all findings
+  // to calculate the policy score.
   AVERAGE = 3;
+  // Treats the query as data only, no scoring is applied.
   DATA_ONLY = 4;
+  // Ignore scoring mechanism which ignores the score of each query.
   IGNORE_SCORE = 5;
   // Experimental: BANDED scoring mechanism which creates a score based on
   // the 4 categories of criticality (critical, high, medium, low) and
@@ -203,19 +212,27 @@ message QueryPackDocs {
   string desc = 1;
 }
 
+// Documentation for Mquery
 message MqueryDocs {
   reserved 3;
-
+  // Description of the query
   string desc = 1;
+  // Optional. Audit instructions to verify the query results
   string audit = 2;
+  // Optional. References to external sources, typical URLs
   repeated MqueryRef refs = 4;
+  //  Optional. Remediation instructions for the query
   Remediation remediation = 5;
 }
 
+// Remediation is used to provide a fix for a check.
 message Remediation {
+  // items is a list of TypedDoc items that include the description of the
+  // remediation for different platforms.
   repeated TypedDoc items = 1;
 }
 
+// A typed documentation for a remediation
 message TypedDoc {
   // Identifier
   string id = 1;
@@ -231,13 +248,19 @@ message TypedDoc {
   map<string,string> tags = 22;
 }
 
+// Author is used to identify the author of a query
 message Author {
+  // Name of the author
   string name = 1;
+  // Email of the author
   string email = 2;
 }
 
+// MqueryRef is used to reference external sources
 message MqueryRef {
+  // Title of the reference
   string title = 1;
+  // URL of the reference
   string url = 2;
 }
 

diff --git a/explorer/resources/cnquery_resources_explorer.pb.go b/explorer/resources/cnquery_resources_explorer.pb.go
diff --git a/explorer/scan/cnquery_explorer_scan.pb.go b/explorer/scan/cnquery_explorer_scan.pb.go
diff --git a/llx/llx.pb.go b/llx/llx.pb.go
diff --git a/providers-sdk/v1/inventory/inventory.pb.go b/providers-sdk/v1/inventory/inventory.pb.go
diff --git a/providers-sdk/v1/plugin/plugin.pb.go b/providers-sdk/v1/plugin/plugin.pb.go
diff --git a/providers-sdk/v1/plugin/plugin_grpc.pb.go b/providers-sdk/v1/plugin/plugin_grpc.pb.go
diff --git a/providers-sdk/v1/resources/resources.pb.go b/providers-sdk/v1/resources/resources.pb.go
diff --git a/providers-sdk/v1/upstream/health/errors.pb.go b/providers-sdk/v1/upstream/health/errors.pb.go
diff --git a/providers-sdk/v1/upstream/health/health.pb.go b/providers-sdk/v1/upstream/health/health.pb.go
diff --git a/providers-sdk/v1/upstream/mvd/cvss/cvss.pb.go b/providers-sdk/v1/upstream/mvd/cvss/cvss.pb.go
diff --git a/providers-sdk/v1/upstream/mvd/mvd.pb.go b/providers-sdk/v1/upstream/mvd/mvd.pb.go
diff --git a/providers-sdk/v1/upstream/upstream.pb.go b/providers-sdk/v1/upstream/upstream.pb.go
diff --git a/providers-sdk/v1/vault/vault.pb.go b/providers-sdk/v1/vault/vault.pb.go
diff --git a/sbom/sbom.pb.go b/sbom/sbom.pb.go
diff --git a/shared/proto/cnquery.pb.go b/shared/proto/cnquery.pb.go
diff --git a/shared/proto/cnquery_grpc.pb.go b/shared/proto/cnquery_grpc.pb.go