Skip to content

Commit

Permalink
Regenerate client from commit c2a87e35 of spec repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ci.datadog-api-spec committed Nov 26, 2024
1 parent 5f290e0 commit 7209c09
Show file tree
Hide file tree
Showing 20 changed files with 46 additions and 45 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-11-25 19:59:41.593757",
"spec_repo_commit": "3c840607"
"regenerated": "2024-11-26 10:15:55.222073",
"spec_repo_commit": "c2a87e35"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-11-25 19:59:41.612823",
"spec_repo_commit": "3c840607"
"regenerated": "2024-11-26 10:15:55.241394",
"spec_repo_commit": "c2a87e35"
}
}
}
29 changes: 15 additions & 14 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13495,7 +13495,7 @@ components:
$ref: '#/components/schemas/SecurityMonitoringStandardRuleQuery'
type: array
referenceTables:
description: Reference tables for the rule.
description: Reference tables used in the queries.
items:
$ref: '#/components/schemas/SecurityMonitoringReferenceTable'
type: array
Expand All @@ -13505,8 +13505,8 @@ components:
type: string
type: array
thirdPartyCases:
description: Cases for generating results from third-party rules. Only available
for third-party rules.
description: Cases for generating results from third-party detection method.
Only available for third-party detection method.
example: []
items:
$ref: '#/components/schemas/SecurityMonitoringThirdPartyRuleCaseCreate'
Expand Down Expand Up @@ -21191,7 +21191,7 @@ components:
$ref: '#/components/schemas/ResponseMetaAttributes'
type: object
SecurityMonitoringReferenceTable:
description: Reference table for the rule.
description: Reference tables used in the queries.
properties:
checkPresence:
description: Whether to include or exclude the matched values.
Expand All @@ -21203,7 +21203,7 @@ components:
description: The field in the log to match against the reference table.
type: string
ruleQueryName:
description: The name of the rule query to apply the reference table to.
description: The name of the query to apply the reference table to.
type: string
tableName:
description: The name of the reference table.
Expand Down Expand Up @@ -21234,7 +21234,7 @@ components:
description: Case when signal is generated.
properties:
condition:
description: 'A rule case contains logical operations (`>`,`>=`, `&&`, `||`)
description: 'A case contains logical operations (`>`,`>=`, `&&`, `||`)
to determine if a signal should be generated

based on the event counts in the previously defined queries.'
Expand All @@ -21243,7 +21243,7 @@ components:
description: Name of the case.
type: string
notifications:
description: Notification targets for each rule case.
description: Notification targets.
items:
description: Notification.
type: string
Expand Down Expand Up @@ -21305,7 +21305,8 @@ components:
description: 'A time window is specified to match when at least one of the cases
matches true. This is a sliding window

and evaluates in real time. For third party rules, this field is not used.'
and evaluates in real time. For third party detection method, this field is
not used.'
enum:
- 0
- 60
Expand Down Expand Up @@ -21334,7 +21335,7 @@ components:
x-enum-varnames:
- LOG4SHELL
SecurityMonitoringRuleImpossibleTravelOptions:
description: Options on impossible travel rules.
description: Options on impossible travel detection method.
properties:
baselineUserLocations:
$ref: '#/components/schemas/SecurityMonitoringRuleImpossibleTravelOptionsBaselineUserLocations'
Expand All @@ -21350,7 +21351,7 @@ components:
SecurityMonitoringRuleKeepAlive:
description: "Once a signal is generated, the signal will remain \u201Copen\u201D
if a case is matched at least once within\nthis keep alive window. For third
party rules, this field is not used."
party detection method, this field is not used."
enum:
- 0
- 60
Expand Down Expand Up @@ -21408,7 +21409,7 @@ components:
- TWELVE_HOURS
- ONE_DAY
SecurityMonitoringRuleNewValueOptions:
description: Options on new value rules.
description: Options on new value detection method.
properties:
forgetAfter:
$ref: '#/components/schemas/SecurityMonitoringRuleNewValueOptionsForgetAfter'
Expand Down Expand Up @@ -21478,7 +21479,7 @@ components:
- ZERO_OCCURRENCES
- ONE_OCCURRENCE
SecurityMonitoringRuleOptions:
description: Options on rules.
description: Options.
properties:
complianceRuleOptions:
$ref: '#/components/schemas/CloudConfigurationComplianceRuleOptions'
Expand Down Expand Up @@ -21620,7 +21621,7 @@ components:
type: array
type: object
SecurityMonitoringRuleThirdPartyOptions:
description: Options on third party rules.
description: Options on third party detection method.
properties:
defaultNotifications:
description: Notification targets for the logs that do not correspond to
Expand Down Expand Up @@ -23016,7 +23017,7 @@ components:
description: Name of the case.
type: string
notifications:
description: Notification targets for each rule case.
description: Notification targets for each case.
items:
description: Notification.
type: string
Expand Down
6 changes: 3 additions & 3 deletions api/datadogV2/model_job_definition.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ type JobDefinition struct {
Message string `json:"message"`
// Job name.
Name string `json:"name"`
// Options on rules.
// Options.
Options *SecurityMonitoringRuleOptions `json:"options,omitempty"`
// Queries for selecting logs analyzed by the job.
Queries []SecurityMonitoringStandardRuleQuery `json:"queries"`
// Reference tables for the rule.
// Reference tables used in the queries.
ReferenceTables []SecurityMonitoringReferenceTable `json:"referenceTables,omitempty"`
// Tags for generated signals.
Tags []string `json:"tags,omitempty"`
// Cases for generating results from third-party rules. Only available for third-party rules.
// Cases for generating results from third-party detection method. Only available for third-party detection method.
ThirdPartyCases []SecurityMonitoringThirdPartyRuleCaseCreate `json:"thirdPartyCases,omitempty"`
// Ending time of data analyzed by the job.
To int64 `json:"to"`
Expand Down
4 changes: 2 additions & 2 deletions api/datadogV2/model_security_monitoring_reference_table.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ import (
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
)

// SecurityMonitoringReferenceTable Reference table for the rule.
// SecurityMonitoringReferenceTable Reference tables used in the queries.
type SecurityMonitoringReferenceTable struct {
// Whether to include or exclude the matched values.
CheckPresence *bool `json:"checkPresence,omitempty"`
// The name of the column in the reference table.
ColumnName *string `json:"columnName,omitempty"`
// The field in the log to match against the reference table.
LogFieldPath *string `json:"logFieldPath,omitempty"`
// The name of the rule query to apply the reference table to.
// The name of the query to apply the reference table to.
RuleQueryName *string `json:"ruleQueryName,omitempty"`
// The name of the reference table.
TableName *string `json:"tableName,omitempty"`
Expand Down
4 changes: 2 additions & 2 deletions api/datadogV2/model_security_monitoring_rule_case_create.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ import (

// SecurityMonitoringRuleCaseCreate Case when signal is generated.
type SecurityMonitoringRuleCaseCreate struct {
// A rule case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated
// A case contains logical operations (`>`,`>=`, `&&`, `||`) to determine if a signal should be generated
// based on the event counts in the previously defined queries.
Condition *string `json:"condition,omitempty"`
// Name of the case.
Name *string `json:"name,omitempty"`
// Notification targets for each rule case.
// Notification targets.
Notifications []string `json:"notifications,omitempty"`
// Severity of the Security Signal.
Status SecurityMonitoringRuleSeverity `json:"status"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
)

// SecurityMonitoringRuleEvaluationWindow A time window is specified to match when at least one of the cases matches true. This is a sliding window
// and evaluates in real time. For third party rules, this field is not used.
// and evaluates in real time. For third party detection method, this field is not used.
type SecurityMonitoringRuleEvaluationWindow int32

// List of SecurityMonitoringRuleEvaluationWindow.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
)

// SecurityMonitoringRuleImpossibleTravelOptions Options on impossible travel rules.
// SecurityMonitoringRuleImpossibleTravelOptions Options on impossible travel detection method.
type SecurityMonitoringRuleImpossibleTravelOptions struct {
// If true, signals are suppressed for the first 24 hours. In that time, Datadog learns the user's regular
// access locations. This can be helpful to reduce noise and infer VPN usage or credentialed API access.
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV2/model_security_monitoring_rule_keep_alive.go
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import (
)

// SecurityMonitoringRuleKeepAlive Once a signal is generated, the signal will remain “open” if a case is matched at least once within
// this keep alive window. For third party rules, this field is not used.
// this keep alive window. For third party detection method, this field is not used.
type SecurityMonitoringRuleKeepAlive int32

// List of SecurityMonitoringRuleKeepAlive.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
)

// SecurityMonitoringRuleNewValueOptions Options on new value rules.
// SecurityMonitoringRuleNewValueOptions Options on new value detection method.
type SecurityMonitoringRuleNewValueOptions struct {
// The duration in days after which a learned value is forgotten.
ForgetAfter *SecurityMonitoringRuleNewValueOptionsForgetAfter `json:"forgetAfter,omitempty"`
Expand Down
12 changes: 6 additions & 6 deletions api/datadogV2/model_security_monitoring_rule_options.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
)

// SecurityMonitoringRuleOptions Options on rules.
// SecurityMonitoringRuleOptions Options.
type SecurityMonitoringRuleOptions struct {
// Options for cloud_configuration rules.
// Fields `resourceType` and `regoRule` are mandatory when managing custom `cloud_configuration` rules.
Expand All @@ -21,21 +21,21 @@ type SecurityMonitoringRuleOptions struct {
// The detection method.
DetectionMethod *SecurityMonitoringRuleDetectionMethod `json:"detectionMethod,omitempty"`
// A time window is specified to match when at least one of the cases matches true. This is a sliding window
// and evaluates in real time. For third party rules, this field is not used.
// and evaluates in real time. For third party detection method, this field is not used.
EvaluationWindow *SecurityMonitoringRuleEvaluationWindow `json:"evaluationWindow,omitempty"`
// Hardcoded evaluator type.
HardcodedEvaluatorType *SecurityMonitoringRuleHardcodedEvaluatorType `json:"hardcodedEvaluatorType,omitempty"`
// Options on impossible travel rules.
// Options on impossible travel detection method.
ImpossibleTravelOptions *SecurityMonitoringRuleImpossibleTravelOptions `json:"impossibleTravelOptions,omitempty"`
// Once a signal is generated, the signal will remain “open” if a case is matched at least once within
// this keep alive window. For third party rules, this field is not used.
// this keep alive window. For third party detection method, this field is not used.
KeepAlive *SecurityMonitoringRuleKeepAlive `json:"keepAlive,omitempty"`
// A signal will “close” regardless of the query being matched once the time exceeds the maximum duration.
// This time is calculated from the first seen timestamp.
MaxSignalDuration *SecurityMonitoringRuleMaxSignalDuration `json:"maxSignalDuration,omitempty"`
// Options on new value rules.
// Options on new value detection method.
NewValueOptions *SecurityMonitoringRuleNewValueOptions `json:"newValueOptions,omitempty"`
// Options on third party rules.
// Options on third party detection method.
ThirdPartyRuleOptions *SecurityMonitoringRuleThirdPartyOptions `json:"thirdPartyRuleOptions,omitempty"`
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
UnparsedObject map[string]interface{} `json:"-"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import (
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
)

// SecurityMonitoringRuleThirdPartyOptions Options on third party rules.
// SecurityMonitoringRuleThirdPartyOptions Options on third party detection method.
type SecurityMonitoringRuleThirdPartyOptions struct {
// Notification targets for the logs that do not correspond to any of the cases.
DefaultNotifications []string `json:"defaultNotifications,omitempty"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type SecurityMonitoringRuleUpdatePayload struct {
Message *string `json:"message,omitempty"`
// Name of the rule.
Name *string `json:"name,omitempty"`
// Options on rules.
// Options.
Options *SecurityMonitoringRuleOptions `json:"options,omitempty"`
// Queries for selecting logs which are part of the rule.
Queries []SecurityMonitoringRuleQuery `json:"queries,omitempty"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type SecurityMonitoringSignalRuleCreatePayload struct {
Message string `json:"message"`
// The name of the rule.
Name string `json:"name"`
// Options on rules.
// Options.
Options SecurityMonitoringRuleOptions `json:"options"`
// Queries for selecting signals which are part of the rule.
Queries []SecurityMonitoringSignalRuleQuery `json:"queries"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type SecurityMonitoringSignalRulePayload struct {
Message string `json:"message"`
// The name of the rule.
Name string `json:"name"`
// Options on rules.
// Options.
Options SecurityMonitoringRuleOptions `json:"options"`
// Queries for selecting signals which are part of the rule.
Queries []SecurityMonitoringSignalRuleQuery `json:"queries"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ type SecurityMonitoringSignalRuleResponse struct {
Message *string `json:"message,omitempty"`
// The name of the rule.
Name *string `json:"name,omitempty"`
// Options on rules.
// Options.
Options *SecurityMonitoringRuleOptions `json:"options,omitempty"`
// Queries for selecting logs which are part of the rule.
Queries []SecurityMonitoringSignalRuleResponseQuery `json:"queries,omitempty"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type SecurityMonitoringStandardRuleCreatePayload struct {
Message string `json:"message"`
// The name of the rule.
Name string `json:"name"`
// Options on rules.
// Options.
Options SecurityMonitoringRuleOptions `json:"options"`
// Queries for selecting logs which are part of the rule.
Queries []SecurityMonitoringStandardRuleQuery `json:"queries"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type SecurityMonitoringStandardRulePayload struct {
Message string `json:"message"`
// The name of the rule.
Name string `json:"name"`
// Options on rules.
// Options.
Options SecurityMonitoringRuleOptions `json:"options"`
// Queries for selecting logs which are part of the rule.
Queries []SecurityMonitoringStandardRuleQuery `json:"queries"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ type SecurityMonitoringStandardRuleResponse struct {
Message *string `json:"message,omitempty"`
// The name of the rule.
Name *string `json:"name,omitempty"`
// Options on rules.
// Options.
Options *SecurityMonitoringRuleOptions `json:"options,omitempty"`
// Queries for selecting logs which are part of the rule.
Queries []SecurityMonitoringStandardRuleQuery `json:"queries,omitempty"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type SecurityMonitoringStandardRuleTestPayload struct {
Message string `json:"message"`
// The name of the rule.
Name string `json:"name"`
// Options on rules.
// Options.
Options SecurityMonitoringRuleOptions `json:"options"`
// Queries for selecting logs which are part of the rule.
Queries []SecurityMonitoringStandardRuleQuery `json:"queries"`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
type SecurityMonitoringThirdPartyRuleCaseCreate struct {
// Name of the case.
Name *string `json:"name,omitempty"`
// Notification targets for each rule case.
// Notification targets for each case.
Notifications []string `json:"notifications,omitempty"`
// A query to map a third party event to this case.
Query *string `json:"query,omitempty"`
Expand Down

0 comments on commit 7209c09

Please sign in to comment.