Added filters to rule endpoints in security monitoring API (#632)

* Added filters api tests

* record

* Regenerate client from commit ca13c42 of spec repo

Co-authored-by: Dario Meloni <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: Hippolyte HENRY <[email protected]>
Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: 4 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.4.1.dev2",
-            "regenerated": "2020-12-29 08:51:05.500744",
-            "spec_repo_commit": "2554c85"
+            "regenerated": "2020-12-29 12:58:48.946979",
+            "spec_repo_commit": "ca13c42"
         },
         "v2": {
             "apigentools_version": "1.4.1.dev2",
-            "regenerated": "2020-12-29 08:51:12.443081",
-            "spec_repo_commit": "2554c85"
+            "regenerated": "2020-12-29 12:58:55.447918",
+            "spec_repo_commit": "ca13c42"
         }
     }
 }

api/v2/datadog/.openapi-generator/FILES

@@ -234,6 +234,8 @@ docs/RolesResponse.md
 docs/RolesSort.md
 docs/RolesType.md
 docs/SecurityMonitoringApi.md
+docs/SecurityMonitoringFilter.md
+docs/SecurityMonitoringFilterAction.md
 docs/SecurityMonitoringListRulesResponse.md
 docs/SecurityMonitoringRuleCase.md
 docs/SecurityMonitoringRuleCaseCreate.md
@@ -491,6 +493,8 @@ model_role_update_response_data.go
 model_roles_response.go
 model_roles_sort.go
 model_roles_type.go
+model_security_monitoring_filter.go
+model_security_monitoring_filter_action.go
 model_security_monitoring_list_rules_response.go
 model_security_monitoring_rule_case.go
 model_security_monitoring_rule_case_create.go

api/v2/datadog/README.md

@@ -360,6 +360,8 @@ Class | Method | HTTP request | Description
  - [RolesResponse](docs/RolesResponse.md)
  - [RolesSort](docs/RolesSort.md)
  - [RolesType](docs/RolesType.md)
+ - [SecurityMonitoringFilter](docs/SecurityMonitoringFilter.md)
+ - [SecurityMonitoringFilterAction](docs/SecurityMonitoringFilterAction.md)
  - [SecurityMonitoringListRulesResponse](docs/SecurityMonitoringListRulesResponse.md)
  - [SecurityMonitoringRuleCase](docs/SecurityMonitoringRuleCase.md)
  - [SecurityMonitoringRuleCaseCreate](docs/SecurityMonitoringRuleCaseCreate.md)

api/v2/datadog/api/openapi.yaml

@@ -8564,6 +8564,26 @@ components:
       type: string
       x-enum-varnames:
       - ROLES
+    SecurityMonitoringFilter:
+      description: The rule's suppression filter.
+      example:
+        query: query
+      properties:
+        action:
+          $ref: '#/components/schemas/SecurityMonitoringFilterAction'
+        query:
+          description: Query for selecting logs to apply the filtering action.
+          type: string
+      type: object
+    SecurityMonitoringFilterAction:
+      description: The type of filtering action.
+      enum:
+      - require
+      - suppress
+      type: string
+      x-enum-varnames:
+      - REQUIRE
+      - SUPPRESS
     SecurityMonitoringListRulesResponse:
       description: List of rules.
       example:
@@ -8579,6 +8599,9 @@ components:
             notifications:
             - notifications
             - notifications
+          filters:
+          - query: query
+          - query: query
           message: message
           queries:
           - distinctFields:
@@ -8622,6 +8645,9 @@ components:
             notifications:
             - notifications
             - notifications
+          filters:
+          - query: query
+          - query: query
           message: message
           queries:
           - distinctFields:
@@ -8722,6 +8748,9 @@ components:
         isEnabled: true
         name: ""
         options: {}
+        filters:
+        - query: query
+        - query: query
         message: ""
         queries: []
         tags:
@@ -8734,6 +8763,12 @@ components:
           items:
             $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
           type: array
+        filters:
+          description: Additional queries to filter matched events before they are
+            processed.
+          items:
+            $ref: '#/components/schemas/SecurityMonitoringFilter'
+          type: array
         isEnabled:
           description: Whether the rule is enabled.
           example: true
@@ -8964,6 +8999,9 @@ components:
           notifications:
           - notifications
           - notifications
+        filters:
+        - query: query
+        - query: query
         message: message
         queries:
         - distinctFields:
@@ -9010,6 +9048,12 @@ components:
           description: User ID of the user who created the rule.
           format: int64
           type: integer
+        filters:
+          description: Additional queries to filter matched events before they are
+            processed.
+          items:
+            $ref: '#/components/schemas/SecurityMonitoringFilter'
+          type: array
         id:
           description: The ID of the rule.
           type: string
@@ -9077,6 +9121,9 @@ components:
         isEnabled: true
         name: name
         options: {}
+        filters:
+        - query: query
+        - query: query
         message: message
         queries:
         - distinctFields:
@@ -9106,6 +9153,12 @@ components:
           items:
             $ref: '#/components/schemas/SecurityMonitoringRuleCase'
           type: array
+        filters:
+          description: Additional queries to filter matched events before they are
+            processed.
+          items:
+            $ref: '#/components/schemas/SecurityMonitoringFilter'
+          type: array
         isEnabled:
           description: Whether the rule is enabled.
           type: boolean

api/v2/datadog/docs/SecurityMonitoringFilter.md

@@ -0,0 +1,82 @@
+# SecurityMonitoringFilter
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**Action** | Pointer to [**SecurityMonitoringFilterAction**](SecurityMonitoringFilterAction.md) |  | [optional] 
+**Query** | Pointer to **string** | Query for selecting logs to apply the filtering action. | [optional] 
+
+## Methods
+
+### NewSecurityMonitoringFilter
+
+`func NewSecurityMonitoringFilter() *SecurityMonitoringFilter`
+
+NewSecurityMonitoringFilter instantiates a new SecurityMonitoringFilter object
+This constructor will assign default values to properties that have it defined,
+and makes sure properties required by API are set, but the set of arguments
+will change when the set of required properties is changed
+
+### NewSecurityMonitoringFilterWithDefaults
+
+`func NewSecurityMonitoringFilterWithDefaults() *SecurityMonitoringFilter`
+
+NewSecurityMonitoringFilterWithDefaults instantiates a new SecurityMonitoringFilter object
+This constructor will only assign default values to properties that have it defined,
+but it doesn't guarantee that properties required by API are set
+
+### GetAction
+
+`func (o *SecurityMonitoringFilter) GetAction() SecurityMonitoringFilterAction`
+
+GetAction returns the Action field if non-nil, zero value otherwise.
+
+### GetActionOk
+
+`func (o *SecurityMonitoringFilter) GetActionOk() (*SecurityMonitoringFilterAction, bool)`
+
+GetActionOk returns a tuple with the Action field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetAction
+
+`func (o *SecurityMonitoringFilter) SetAction(v SecurityMonitoringFilterAction)`
+
+SetAction sets Action field to given value.
+
+### HasAction
+
+`func (o *SecurityMonitoringFilter) HasAction() bool`
+
+HasAction returns a boolean if a field has been set.
+
+### GetQuery
+
+`func (o *SecurityMonitoringFilter) GetQuery() string`
+
+GetQuery returns the Query field if non-nil, zero value otherwise.
+
+### GetQueryOk
+
+`func (o *SecurityMonitoringFilter) GetQueryOk() (*string, bool)`
+
+GetQueryOk returns a tuple with the Query field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetQuery
+
+`func (o *SecurityMonitoringFilter) SetQuery(v string)`
+
+SetQuery sets Query field to given value.
+
+### HasQuery
+
+`func (o *SecurityMonitoringFilter) HasQuery() bool`
+
+HasQuery returns a boolean if a field has been set.
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

api/v2/datadog/docs/SecurityMonitoringFilterAction.md

@@ -0,0 +1,13 @@
+# SecurityMonitoringFilterAction
+
+## Enum
+
+
+* `REQUIRE` (value: `"require"`)
+
+* `SUPPRESS` (value: `"suppress"`)
+
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

api/v2/datadog/docs/SecurityMonitoringRuleCreatePayload.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Cases** | [**[]SecurityMonitoringRuleCaseCreate**](SecurityMonitoringRuleCaseCreate.md) | Cases for generating signals. | 
+**Filters** | Pointer to [**[]SecurityMonitoringFilter**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] 
 **IsEnabled** | **bool** | Whether the rule is enabled. | 
 **Message** | **string** | Message for generated signals. | 
 **Name** | **string** | The name of the rule. | 
@@ -51,6 +52,31 @@ and a boolean to check if the value has been set.
 SetCases sets Cases field to given value.
 
 
+### GetFilters
+
+`func (o *SecurityMonitoringRuleCreatePayload) GetFilters() []SecurityMonitoringFilter`
+
+GetFilters returns the Filters field if non-nil, zero value otherwise.
+
+### GetFiltersOk
+
+`func (o *SecurityMonitoringRuleCreatePayload) GetFiltersOk() (*[]SecurityMonitoringFilter, bool)`
+
+GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetFilters
+
+`func (o *SecurityMonitoringRuleCreatePayload) SetFilters(v []SecurityMonitoringFilter)`
+
+SetFilters sets Filters field to given value.
+
+### HasFilters
+
+`func (o *SecurityMonitoringRuleCreatePayload) HasFilters() bool`
+
+HasFilters returns a boolean if a field has been set.
+
 ### GetIsEnabled
 
 `func (o *SecurityMonitoringRuleCreatePayload) GetIsEnabled() bool`

api/v2/datadog/docs/SecurityMonitoringRuleResponse.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **Cases** | Pointer to [**[]SecurityMonitoringRuleCase**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | [optional] 
 **CreatedAt** | Pointer to **int64** | When the rule was created, timestamp in milliseconds. | [optional] 
 **CreationAuthorId** | Pointer to **int64** | User ID of the user who created the rule. | [optional] 
+**Filters** | Pointer to [**[]SecurityMonitoringFilter**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] 
 **Id** | Pointer to **string** | The ID of the rule. | [optional] 
 **IsDefault** | Pointer to **bool** | Whether the rule is included by default. | [optional] 
 **IsDeleted** | Pointer to **bool** | Whether the rule has been deleted. | [optional] 
@@ -112,6 +113,31 @@ SetCreationAuthorId sets CreationAuthorId field to given value.
 
 HasCreationAuthorId returns a boolean if a field has been set.
 
+### GetFilters
+
+`func (o *SecurityMonitoringRuleResponse) GetFilters() []SecurityMonitoringFilter`
+
+GetFilters returns the Filters field if non-nil, zero value otherwise.
+
+### GetFiltersOk
+
+`func (o *SecurityMonitoringRuleResponse) GetFiltersOk() (*[]SecurityMonitoringFilter, bool)`
+
+GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetFilters
+
+`func (o *SecurityMonitoringRuleResponse) SetFilters(v []SecurityMonitoringFilter)`
+
+SetFilters sets Filters field to given value.
+
+### HasFilters
+
+`func (o *SecurityMonitoringRuleResponse) HasFilters() bool`
+
+HasFilters returns a boolean if a field has been set.
+
 ### GetId
 
 `func (o *SecurityMonitoringRuleResponse) GetId() string`

api/v2/datadog/docs/SecurityMonitoringRuleUpdatePayload.md

@@ -5,6 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **Cases** | Pointer to [**[]SecurityMonitoringRuleCase**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | [optional] 
+**Filters** | Pointer to [**[]SecurityMonitoringFilter**](SecurityMonitoringFilter.md) | Additional queries to filter matched events before they are processed. | [optional] 
 **IsEnabled** | Pointer to **bool** | Whether the rule is enabled. | [optional] 
 **Message** | Pointer to **string** | Message for generated signals. | [optional] 
 **Name** | Pointer to **string** | Name of the rule. | [optional] 
@@ -56,6 +57,31 @@ SetCases sets Cases field to given value.
 
 HasCases returns a boolean if a field has been set.
 
+### GetFilters
+
+`func (o *SecurityMonitoringRuleUpdatePayload) GetFilters() []SecurityMonitoringFilter`
+
+GetFilters returns the Filters field if non-nil, zero value otherwise.
+
+### GetFiltersOk
+
+`func (o *SecurityMonitoringRuleUpdatePayload) GetFiltersOk() (*[]SecurityMonitoringFilter, bool)`
+
+GetFiltersOk returns a tuple with the Filters field if it's non-nil, zero value otherwise
+and a boolean to check if the value has been set.
+
+### SetFilters
+
+`func (o *SecurityMonitoringRuleUpdatePayload) SetFilters(v []SecurityMonitoringFilter)`
+
+SetFilters sets Filters field to given value.
+
+### HasFilters
+
+`func (o *SecurityMonitoringRuleUpdatePayload) HasFilters() bool`
+
+HasFilters returns a boolean if a field has been set.
+
 ### GetIsEnabled
 
 `func (o *SecurityMonitoringRuleUpdatePayload) GetIsEnabled() bool`