[CreateRuleDoc] Adding query and status as required

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.2.0",
-            "regenerated": "2020-07-31 08:09:38.931974",
-            "spec_repo_commit": "049bffd"
+            "regenerated": "2020-07-31 09:08:38.165187",
+            "spec_repo_commit": "8f4a24d"
         },
         "v2": {
             "apigentools_version": "1.2.0",
-            "regenerated": "2020-07-31 08:09:45.354418",
-            "spec_repo_commit": "049bffd"
+            "regenerated": "2020-07-31 09:08:44.350930",
+            "spec_repo_commit": "8f4a24d"
         }
     }
 }

.openapi-generator/FILES

@@ -113,12 +113,14 @@ docs/RolesType.md
 docs/SecurityMonitoringApi.md
 docs/SecurityMonitoringListRulesResponse.md
 docs/SecurityMonitoringRuleCase.md
+docs/SecurityMonitoringRuleCaseCreate.md
 docs/SecurityMonitoringRuleCreatePayload.md
 docs/SecurityMonitoringRuleEvaluationWindow.md
 docs/SecurityMonitoringRuleKeepAlive.md
 docs/SecurityMonitoringRuleMaxSignalDuration.md
 docs/SecurityMonitoringRuleOptions.md
 docs/SecurityMonitoringRuleQuery.md
+docs/SecurityMonitoringRuleQueryCreate.md
 docs/SecurityMonitoringRuleResponse.md
 docs/SecurityMonitoringRuleSeverity.md
 docs/SecurityMonitoringRuleUpdatePayload.md
@@ -280,12 +282,14 @@ src/main/java/com/datadog/api/v2/client/model/RolesSort.java
 src/main/java/com/datadog/api/v2/client/model/RolesType.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringListRulesResponse.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCase.java
+src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCaseCreate.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCreatePayload.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleEvaluationWindow.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleKeepAlive.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleMaxSignalDuration.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleOptions.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleQuery.java
+src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleQueryCreate.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleResponse.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleSeverity.java
 src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleUpdatePayload.java
@@ -416,12 +420,14 @@ src/test/java/com/datadog/api/v2/client/model/RolesResponseTest.java
 src/test/java/com/datadog/api/v2/client/model/RolesSortTest.java
 src/test/java/com/datadog/api/v2/client/model/RolesTypeTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringListRulesResponseTest.java
+src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCaseCreateTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCaseTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCreatePayloadTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleEvaluationWindowTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleKeepAliveTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleMaxSignalDurationTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleOptionsTest.java
+src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleQueryCreateTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleQueryTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleResponseTest.java
 src/test/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleSeverityTest.java

api/openapi.yaml

@@ -60,7 +60,7 @@ tags:
     read access on a specific log index to a role can be done in Datadog from the
     [Pipelines page](https://app.datadoghq.com/logs/pipelines).
   name: Roles
-- description: Detection Rules for generating signals
+- description: Detection Rules for generating signals.
   name: Security Monitoring
 - description: Create, edit, and disable users.
   externalDocs:
@@ -3811,7 +3811,7 @@ components:
       x-enum-varnames:
       - ROLES
     SecurityMonitoringListRulesResponse:
-      description: List of rules
+      description: List of rules.
       example:
         data:
         - cases:
@@ -3920,21 +3920,43 @@ components:
       properties:
         condition:
           description: |-
-            A rule case contains logical operations (>, >=, &&, ||) to determine if a signal should be generated
+            A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated
             based on the event counts in the previously defined queries.
           type: string
         name:
           description: Name of the case.
           type: string
         notifications:
-          description: Notification targets for each rule case
+          description: Notification targets for each rule case.
           items:
-            description: Notification
+            description: Notification.
             type: string
           type: array
         status:
           $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
       type: object
+    SecurityMonitoringRuleCaseCreate:
+      description: Case when signal is generated.
+      properties:
+        condition:
+          description: |-
+            A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated
+            based on the event counts in the previously defined queries.
+          type: string
+        name:
+          description: Name of the case.
+          type: string
+        notifications:
+          description: Notification targets for each rule case.
+          items:
+            description: Notification.
+            type: string
+          type: array
+        status:
+          $ref: '#/components/schemas/SecurityMonitoringRuleSeverity'
+      required:
+      - status
+      type: object
     SecurityMonitoringRuleCreatePayload:
       description: Create a new rule.
       example:
@@ -3952,7 +3974,7 @@ components:
           description: Cases for generating signals.
           example: []
           items:
-            $ref: '#/components/schemas/SecurityMonitoringRuleCase'
+            $ref: '#/components/schemas/SecurityMonitoringRuleCaseCreate'
           type: array
         isEnabled:
           description: Whether the rule is enabled.
@@ -3962,23 +3984,23 @@ components:
           description: Message for generated signals.
           type: string
         name:
-          description: The name of the rule
+          description: The name of the rule.
           type: string
         options:
           $ref: '#/components/schemas/SecurityMonitoringRuleOptions'
         queries:
           description: Queries for selecting logs which are part of the rule.
           example: []
           items:
-            $ref: '#/components/schemas/SecurityMonitoringRuleQuery'
+            $ref: '#/components/schemas/SecurityMonitoringRuleQueryCreate'
           type: array
         tags:
           description: Tags for generated signals.
           example:
           - env:prod
           - team:security
           items:
-            description: Tag
+            description: Tag.
             type: string
           type: array
       required:
@@ -3988,7 +4010,6 @@ components:
       - name
       - options
       - queries
-      - tags
       type: object
     SecurityMonitoringRuleEvaluationWindow:
       description: |-
@@ -4096,24 +4117,48 @@ components:
         distinctFields:
           description: Field for which the cardinality is measured. Sent as an array.
           items:
-            description: Field
+            description: Field.
             type: string
           type: array
         groupByFields:
           description: Fields to group by.
           items:
-            description: Field
+            description: Field.
             type: string
           type: array
         name:
-          description: Name of the query
+          description: Name of the query.
           type: string
         query:
-          description: Query to run on logs
+          description: Query to run on logs.
           type: string
       type: object
+    SecurityMonitoringRuleQueryCreate:
+      description: Query for matching rule.
+      properties:
+        distinctFields:
+          description: Field for which the cardinality is measured. Sent as an array.
+          items:
+            description: Field.
+            type: string
+          type: array
+        groupByFields:
+          description: Fields to group by.
+          items:
+            description: Field.
+            type: string
+          type: array
+        name:
+          description: Name of the query.
+          type: string
+        query:
+          description: Query to run on logs.
+          type: string
+      required:
+      - query
+      type: object
     SecurityMonitoringRuleResponse:
-      description: Detection rule
+      description: Detection rule.
       example:
         cases:
         - condition: condition
@@ -4198,7 +4243,7 @@ components:
         tags:
           description: Tags for generated signals.
           items:
-            description: Tag
+            description: Tag.
             type: string
           type: array
         version:
@@ -4283,7 +4328,7 @@ components:
         tags:
           description: Tags for generated signals.
           items:
-            description: Tag
+            description: Tag.
             type: string
           type: array
       type: object

api_docs/v2/SecurityMonitoringListRulesResponse.md

@@ -2,7 +2,7 @@
 
 # SecurityMonitoringListRulesResponse
 
-List of rules
+List of rules.
 ## Properties
 
 Name | Type | Description | Notes

api_docs/v2/SecurityMonitoringRuleCase.md

@@ -7,9 +7,9 @@ Case when signal is generated.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**condition** | **String** | A rule case contains logical operations (>, >=, &&, ||) to determine if a signal should be generated based on the event counts in the previously defined queries. |  [optional]
+**condition** | **String** | A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated based on the event counts in the previously defined queries. |  [optional]
 **name** | **String** | Name of the case. |  [optional]
-**notifications** | **List<String>** | Notification targets for each rule case |  [optional]
+**notifications** | **List<String>** | Notification targets for each rule case. |  [optional]
 **status** | [**SecurityMonitoringRuleSeverity**](SecurityMonitoringRuleSeverity.md) |  |  [optional]
 
 

api_docs/v2/SecurityMonitoringRuleCaseCreate.md

@@ -0,0 +1,16 @@
+
+
+# SecurityMonitoringRuleCaseCreate
+
+Case when signal is generated.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**condition** | **String** | A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated based on the event counts in the previously defined queries. |  [optional]
+**name** | **String** | Name of the case. |  [optional]
+**notifications** | **List<String>** | Notification targets for each rule case. |  [optional]
+**status** | [**SecurityMonitoringRuleSeverity**](SecurityMonitoringRuleSeverity.md) |  | 
+
+
+

api_docs/v2/SecurityMonitoringRuleCreatePayload.md

@@ -7,13 +7,13 @@ Create a new rule.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**cases** | [**List<SecurityMonitoringRuleCase>**](SecurityMonitoringRuleCase.md) | Cases for generating signals. | 
+**cases** | [**List<SecurityMonitoringRuleCaseCreate>**](SecurityMonitoringRuleCaseCreate.md) | Cases for generating signals. | 
 **isEnabled** | **Boolean** | Whether the rule is enabled. | 
 **message** | **String** | Message for generated signals. | 
-**name** | **String** | The name of the rule | 
+**name** | **String** | The name of the rule. | 
 **options** | [**SecurityMonitoringRuleOptions**](SecurityMonitoringRuleOptions.md) |  | 
-**queries** | [**List<SecurityMonitoringRuleQuery>**](SecurityMonitoringRuleQuery.md) | Queries for selecting logs which are part of the rule. | 
-**tags** | **List<String>** | Tags for generated signals. | 
+**queries** | [**List<SecurityMonitoringRuleQueryCreate>**](SecurityMonitoringRuleQueryCreate.md) | Queries for selecting logs which are part of the rule. | 
+**tags** | **List<String>** | Tags for generated signals. |  [optional]
 
 
 

api_docs/v2/SecurityMonitoringRuleQuery.md

@@ -9,8 +9,8 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **distinctFields** | **List<String>** | Field for which the cardinality is measured. Sent as an array. |  [optional]
 **groupByFields** | **List<String>** | Fields to group by. |  [optional]
-**name** | **String** | Name of the query |  [optional]
-**query** | **String** | Query to run on logs |  [optional]
+**name** | **String** | Name of the query. |  [optional]
+**query** | **String** | Query to run on logs. |  [optional]
 
 
 

api_docs/v2/SecurityMonitoringRuleQueryCreate.md

@@ -0,0 +1,16 @@
+
+
+# SecurityMonitoringRuleQueryCreate
+
+Query for matching rule.
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**distinctFields** | **List<String>** | Field for which the cardinality is measured. Sent as an array. |  [optional]
+**groupByFields** | **List<String>** | Fields to group by. |  [optional]
+**name** | **String** | Name of the query. |  [optional]
+**query** | **String** | Query to run on logs. | 
+
+
+

api_docs/v2/SecurityMonitoringRuleResponse.md

@@ -2,7 +2,7 @@
 
 # SecurityMonitoringRuleResponse
 
-Detection rule
+Detection rule.
 ## Properties
 
 Name | Type | Description | Notes

src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringListRulesResponse.java

@@ -31,9 +31,9 @@
 
 
 /**
- * List of rules
+ * List of rules.
  */
-@ApiModel(description = "List of rules")
+@ApiModel(description = "List of rules.")
 @JsonPropertyOrder({
   SecurityMonitoringListRulesResponse.JSON_PROPERTY_DATA,
   SecurityMonitoringListRulesResponse.JSON_PROPERTY_META

src/main/java/com/datadog/api/v2/client/model/SecurityMonitoringRuleCase.java

@@ -60,11 +60,11 @@ public SecurityMonitoringRuleCase condition(String condition) {
   }
 
    /**
-   * A rule case contains logical operations (>, >=, &&, ||) to determine if a signal should be generated based on the event counts in the previously defined queries.
+   * A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated based on the event counts in the previously defined queries.
    * @return condition
   **/
   @javax.annotation.Nullable
-  @ApiModelProperty(value = "A rule case contains logical operations (>, >=, &&, ||) to determine if a signal should be generated based on the event counts in the previously defined queries.")
+  @ApiModelProperty(value = "A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated based on the event counts in the previously defined queries.")
   @JsonProperty(JSON_PROPERTY_CONDITION)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
 
@@ -116,11 +116,11 @@ public SecurityMonitoringRuleCase addNotificationsItem(String notificationsItem)
   }
 
    /**
-   * Notification targets for each rule case
+   * Notification targets for each rule case.
    * @return notifications
   **/
   @javax.annotation.Nullable
-  @ApiModelProperty(value = "Notification targets for each rule case")
+  @ApiModelProperty(value = "Notification targets for each rule case.")
   @JsonProperty(JSON_PROPERTY_NOTIFICATIONS)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)