docs: improve the jsdoc documentation (#78)

docs: improve the jsdoc documentation

packages/google-cloud-securitycenter/protos/google/cloud/securitycenter/v1/securitycenter_service.proto

@@ -278,6 +278,18 @@ message GroupAssetsRequest {
   // * integer literals without quotes.
   // * boolean literals `true` and `false` without quotes.
   //
+  // The following field and operator combinations are supported:
+  // name | `=`
+  // update_time | `>`, `<`, `>=`, `<=`
+  // iam_policy.policy_blob | '=', ':'
+  // resource_properties | '=', ':', `>`, `<`, `>=`, `<=`
+  // security_marks | '=', ':'
+  // security_center_properties.resource_name | '=', ':'
+  // security_center_properties.resource_type | '=', ':'
+  // security_center_properties.resource_parent | '=', ':'
+  // security_center_properties.resource_project | '=', ':'
+  // security_center_properties.resource_owners | '=', ':'
+  //
   // For example, `resource_properties.size = 100` is a valid filter string.
   string filter = 2;
 
@@ -394,6 +406,17 @@ message GroupFindingsRequest {
   // * integer literals without quotes.
   // * boolean literals `true` and `false` without quotes.
   //
+  // The following field and operator combinations are supported:
+  // name | `=`
+  // parent | '=', ':'
+  // resource_name | '=', ':'
+  // state | '=', ':'
+  // category | '=', ':'
+  // external_uri | '=', ':'
+  // event_time | `>`, `<`, `>=`, `<=`
+  // security_marks | '=', ':'
+  // source_properties | '=', ':', `>`, `<`, `>=`, `<=`
+  //
   // For example, `source_properties.size = 100` is a valid filter string.
   string filter = 2;
 
@@ -406,8 +429,11 @@ message GroupFindingsRequest {
   // * resource_name
   // * category
   // * state
-  // * state_change
   // * parent
+  //
+  // The following fields are supported when compare_duration is set:
+  //
+  // * state_change
   string group_by = 3;
 
   // Time used as a reference point when filtering findings. The filter is
@@ -541,6 +567,18 @@ message ListAssetsRequest {
   // * integer literals without quotes.
   // * boolean literals `true` and `false` without quotes.
   //
+  // The following are the allowed field and operator combinations:
+  // name | `=`
+  // update_time | `>`, `<`, `>=`, `<=`
+  // iam_policy.policy_blob | '=', ':'
+  // resource_properties | '=', ':', `>`, `<`, `>=`, `<=`
+  // security_marks | '=', ':'
+  // security_center_properties.resource_name | '=', ':'
+  // security_center_properties.resource_type | '=', ':'
+  // security_center_properties.resource_parent | '=', ':'
+  // security_center_properties.resource_project | '=', ':'
+  // security_center_properties.resource_owners | '=', ':'
+  //
   // For example, `resource_properties.size = 100` is a valid filter string.
   string filter = 2;
 
@@ -552,6 +590,16 @@ message ListAssetsRequest {
   // desc,resource_properties.a_property". Redundant space characters in the
   // syntax are insignificant. "name desc,resource_properties.a_property" and "
   // name     desc  ,   resource_properties.a_property  " are equivalent.
+  //
+  // The following fields are supported:
+  // name
+  // update_time
+  // resource_properties
+  // security_marks
+  // security_center_properties.resource_name
+  // security_center_properties.resource_parent
+  // security_center_properties.resource_project
+  // security_center_properties.resource_type
   string order_by = 3;
 
   // Time used as a reference point when filtering assets. The filter is limited
@@ -682,6 +730,17 @@ message ListFindingsRequest {
   // * integer literals without quotes.
   // * boolean literals `true` and `false` without quotes.
   //
+  // The following field and operator combinations are supported:
+  // name | `=`
+  // parent | '=', ':'
+  // resource_name | '=', ':'
+  // state | '=', ':'
+  // category | '=', ':'
+  // external_uri | '=', ':'
+  // event_time | `>`, `<`, `>=`, `<=`
+  // security_marks | '=', ':'
+  // source_properties | '=', ':', `>`, `<`, `>=`, `<=`
+  //
   // For example, `source_properties.size = 100` is a valid filter string.
   string filter = 2;
 
@@ -693,6 +752,16 @@ message ListFindingsRequest {
   // desc,source_properties.a_property". Redundant space characters in the
   // syntax are insignificant. "name desc,source_properties.a_property" and "
   // name     desc  ,   source_properties.a_property  " are equivalent.
+  //
+  // The following fields are supported:
+  // name
+  // parent
+  // state
+  // category
+  // resource_name
+  // event_time
+  // source_properties
+  // security_marks
   string order_by = 3;
 
   // Time used as a reference point when filtering findings. The filter is

packages/google-cloud-securitycenter/src/v1/doc/google/cloud/securitycenter/v1/doc_securitycenter_service.js

@@ -126,6 +126,18 @@ const GetSourceRequest = {
  *   * integer literals without quotes.
  *   * boolean literals `true` and `false` without quotes.
  *
+ *   The following field and operator combinations are supported:
+ *   name | `=`
+ *   update_time | `>`, `<`, `>=`, `<=`
+ *   iam_policy.policy_blob | '=', ':'
+ *   resource_properties | '=', ':', `>`, `<`, `>=`, `<=`
+ *   security_marks | '=', ':'
+ *   security_center_properties.resource_name | '=', ':'
+ *   security_center_properties.resource_type | '=', ':'
+ *   security_center_properties.resource_parent | '=', ':'
+ *   security_center_properties.resource_project | '=', ':'
+ *   security_center_properties.resource_owners | '=', ':'
+ *
  *   For example, `resource_properties.size = 100` is a valid filter string.
  *
  * @property {string} groupBy
@@ -264,6 +276,17 @@ const GroupAssetsResponse = {
  *   * integer literals without quotes.
  *   * boolean literals `true` and `false` without quotes.
  *
+ *   The following field and operator combinations are supported:
+ *   name | `=`
+ *   parent | '=', ':'
+ *   resource_name | '=', ':'
+ *   state | '=', ':'
+ *   category | '=', ':'
+ *   external_uri | '=', ':'
+ *   event_time | `>`, `<`, `>=`, `<=`
+ *   security_marks | '=', ':'
+ *   source_properties | '=', ':', `>`, `<`, `>=`, `<=`
+ *
  *   For example, `source_properties.size = 100` is a valid filter string.
  *
  * @property {string} groupBy
@@ -276,9 +299,12 @@ const GroupAssetsResponse = {
  *   * resource_name
  *   * category
  *   * state
- *   * state_change
  *   * parent
  *
+ *   The following fields are supported when compare_duration is set:
+ *
+ *   * state_change
+ *
  * @property {Object} readTime
  *   Time used as a reference point when filtering findings. The filter is
  *   limited to findings existing at the supplied time and their values are
@@ -459,6 +485,18 @@ const ListSourcesResponse = {
  *   * integer literals without quotes.
  *   * boolean literals `true` and `false` without quotes.
  *
+ *   The following are the allowed field and operator combinations:
+ *   name | `=`
+ *   update_time | `>`, `<`, `>=`, `<=`
+ *   iam_policy.policy_blob | '=', ':'
+ *   resource_properties | '=', ':', `>`, `<`, `>=`, `<=`
+ *   security_marks | '=', ':'
+ *   security_center_properties.resource_name | '=', ':'
+ *   security_center_properties.resource_type | '=', ':'
+ *   security_center_properties.resource_parent | '=', ':'
+ *   security_center_properties.resource_project | '=', ':'
+ *   security_center_properties.resource_owners | '=', ':'
+ *
  *   For example, `resource_properties.size = 100` is a valid filter string.
  *
  * @property {string} orderBy
@@ -471,6 +509,16 @@ const ListSourcesResponse = {
  *   syntax are insignificant. "name desc,resource_properties.a_property" and "
  *   name     desc  ,   resource_properties.a_property  " are equivalent.
  *
+ *   The following fields are supported:
+ *   name
+ *   update_time
+ *   resource_properties
+ *   security_marks
+ *   security_center_properties.resource_name
+ *   security_center_properties.resource_parent
+ *   security_center_properties.resource_project
+ *   security_center_properties.resource_type
+ *
  * @property {Object} readTime
  *   Time used as a reference point when filtering assets. The filter is limited
  *   to assets existing at the supplied time and their values are those at that
@@ -650,6 +698,17 @@ const ListAssetsResponse = {
  *   * integer literals without quotes.
  *   * boolean literals `true` and `false` without quotes.
  *
+ *   The following field and operator combinations are supported:
+ *   name | `=`
+ *   parent | '=', ':'
+ *   resource_name | '=', ':'
+ *   state | '=', ':'
+ *   category | '=', ':'
+ *   external_uri | '=', ':'
+ *   event_time | `>`, `<`, `>=`, `<=`
+ *   security_marks | '=', ':'
+ *   source_properties | '=', ':', `>`, `<`, `>=`, `<=`
+ *
  *   For example, `source_properties.size = 100` is a valid filter string.
  *
  * @property {string} orderBy
@@ -662,6 +721,16 @@ const ListAssetsResponse = {
  *   syntax are insignificant. "name desc,source_properties.a_property" and "
  *   name     desc  ,   source_properties.a_property  " are equivalent.
  *
+ *   The following fields are supported:
+ *   name
+ *   parent
+ *   state
+ *   category
+ *   resource_name
+ *   event_time
+ *   source_properties
+ *   security_marks
+ *
  * @property {Object} readTime
  *   Time used as a reference point when filtering findings. The filter is
  *   limited to findings existing at the supplied time and their values are