Skip to content

Commit 585dd56

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 15c0cf6c of spec repo
1 parent 38cc397 commit 585dd56

19 files changed

+746
-4
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-02-12 15:28:28.868571",
8-
"spec_repo_commit": "b56263de"
7+
"regenerated": "2025-02-12 17:30:32.427316",
8+
"spec_repo_commit": "15c0cf6c"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-02-12 15:28:28.883067",
13-
"spec_repo_commit": "b56263de"
12+
"regenerated": "2025-02-12 17:30:32.441725",
13+
"spec_repo_commit": "15c0cf6c"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

+111
Original file line numberDiff line numberDiff line change
@@ -12683,6 +12683,30 @@ components:
1268312683
$ref: '#/components/schemas/GetInterfacesData'
1268412684
type: array
1268512685
type: object
12686+
GetRuleVersionHistoryData:
12687+
description: Data for the rule version history.
12688+
properties:
12689+
attributes:
12690+
$ref: '#/components/schemas/RuleVersionHistory'
12691+
id:
12692+
description: ID of the rule.
12693+
type: string
12694+
type:
12695+
$ref: '#/components/schemas/GetRuleVersionHistoryDataType'
12696+
type: object
12697+
GetRuleVersionHistoryDataType:
12698+
description: Type of data.
12699+
enum:
12700+
- GetRuleVersionHistoryResponse
12701+
type: string
12702+
x-enum-varnames:
12703+
- GETRULEVERSIONHISTORYRESPONSE
12704+
GetRuleVersionHistoryResponse:
12705+
description: Response for getting the rule version history.
12706+
properties:
12707+
data:
12708+
$ref: '#/components/schemas/GetRuleVersionHistoryData'
12709+
type: object
1268612710
GetSBOMResponse:
1268712711
description: The expected response schema when getting an SBOM.
1268812712
properties:
@@ -23254,6 +23278,57 @@ components:
2325423278
example: John Doe
2325523279
type: string
2325623280
type: object
23281+
RuleVersionHistory:
23282+
description: Response object containing the version history of a rule.
23283+
properties:
23284+
count:
23285+
description: The number of rule versions.
23286+
format: int32
23287+
maximum: 2147483647
23288+
type: integer
23289+
data:
23290+
additionalProperties:
23291+
$ref: '#/components/schemas/RuleVersions'
23292+
description: A rule version with a list of updates.
23293+
description: The `RuleVersionHistory` `data`.
23294+
type: object
23295+
type: object
23296+
RuleVersionUpdate:
23297+
description: A change in a rule version.
23298+
properties:
23299+
change:
23300+
description: The new value of the field.
23301+
example: cloud_provider:aws
23302+
type: string
23303+
field:
23304+
description: The field that was changed.
23305+
example: Tags
23306+
type: string
23307+
type:
23308+
$ref: '#/components/schemas/RuleVersionUpdateType'
23309+
type: object
23310+
RuleVersionUpdateType:
23311+
description: The type of change.
23312+
enum:
23313+
- create
23314+
- update
23315+
- delete
23316+
type: string
23317+
x-enum-varnames:
23318+
- CREATE
23319+
- UPDATE
23320+
- DELETE
23321+
RuleVersions:
23322+
description: A rule version with a list of updates.
23323+
properties:
23324+
changes:
23325+
description: A list of changes.
23326+
items:
23327+
$ref: '#/components/schemas/RuleVersionUpdate'
23328+
type: array
23329+
rule:
23330+
$ref: '#/components/schemas/SecurityMonitoringRuleResponse'
23331+
type: object
2325723332
RumMetricCompute:
2325823333
description: The compute rule to compute the rum-based metric.
2325923334
properties:
@@ -45723,6 +45798,42 @@ paths:
4572345798
operator: OR
4572445799
permissions:
4572545800
- security_monitoring_rules_write
45801+
/api/v2/security_monitoring/rules/{rule_id}/version_history:
45802+
get:
45803+
description: Get a rule's version history.
45804+
operationId: GetRuleVersionHistory
45805+
parameters:
45806+
- $ref: '#/components/parameters/SecurityMonitoringRuleID'
45807+
- $ref: '#/components/parameters/PageSize'
45808+
- $ref: '#/components/parameters/PageNumber'
45809+
responses:
45810+
'200':
45811+
content:
45812+
application/json:
45813+
schema:
45814+
$ref: '#/components/schemas/GetRuleVersionHistoryResponse'
45815+
description: OK
45816+
'400':
45817+
$ref: '#/components/responses/BadRequestResponse'
45818+
'403':
45819+
$ref: '#/components/responses/NotAuthorizedResponse'
45820+
'404':
45821+
$ref: '#/components/responses/NotFoundResponse'
45822+
'429':
45823+
$ref: '#/components/responses/TooManyRequestsResponse'
45824+
security:
45825+
- apiKeyAuth: []
45826+
appKeyAuth: []
45827+
- AuthZ:
45828+
- security_monitoring_rules_read
45829+
summary: Get a rule's version history
45830+
tags:
45831+
- Security Monitoring
45832+
x-permission:
45833+
operator: OR
45834+
permissions:
45835+
- security_monitoring_rules_read
45836+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.'
4572645837
/api/v2/security_monitoring/signals:
4572745838
get:
4572845839
description: 'The list endpoint returns security signals that match a search

docs/datadog_api_client.v2.model.rst

+49
Original file line numberDiff line numberDiff line change
@@ -5184,6 +5184,27 @@ datadog\_api\_client.v2.model.get\_interfaces\_response module
51845184
:members:
51855185
:show-inheritance:
51865186

5187+
datadog\_api\_client.v2.model.get\_rule\_version\_history\_data module
5188+
----------------------------------------------------------------------
5189+
5190+
.. automodule:: datadog_api_client.v2.model.get_rule_version_history_data
5191+
:members:
5192+
:show-inheritance:
5193+
5194+
datadog\_api\_client.v2.model.get\_rule\_version\_history\_data\_type module
5195+
----------------------------------------------------------------------------
5196+
5197+
.. automodule:: datadog_api_client.v2.model.get_rule_version_history_data_type
5198+
:members:
5199+
:show-inheritance:
5200+
5201+
datadog\_api\_client.v2.model.get\_rule\_version\_history\_response module
5202+
--------------------------------------------------------------------------
5203+
5204+
.. automodule:: datadog_api_client.v2.model.get_rule_version_history_response
5205+
:members:
5206+
:show-inheritance:
5207+
51875208
datadog\_api\_client.v2.model.get\_sbom\_response module
51885209
--------------------------------------------------------
51895210

@@ -9853,6 +9874,34 @@ datadog\_api\_client.v2.model.rule\_user module
98539874
:members:
98549875
:show-inheritance:
98559876

9877+
datadog\_api\_client.v2.model.rule\_version\_history module
9878+
-----------------------------------------------------------
9879+
9880+
.. automodule:: datadog_api_client.v2.model.rule_version_history
9881+
:members:
9882+
:show-inheritance:
9883+
9884+
datadog\_api\_client.v2.model.rule\_version\_update module
9885+
----------------------------------------------------------
9886+
9887+
.. automodule:: datadog_api_client.v2.model.rule_version_update
9888+
:members:
9889+
:show-inheritance:
9890+
9891+
datadog\_api\_client.v2.model.rule\_version\_update\_type module
9892+
----------------------------------------------------------------
9893+
9894+
.. automodule:: datadog_api_client.v2.model.rule_version_update_type
9895+
:members:
9896+
:show-inheritance:
9897+
9898+
datadog\_api\_client.v2.model.rule\_versions module
9899+
---------------------------------------------------
9900+
9901+
.. automodule:: datadog_api_client.v2.model.rule_versions
9902+
:members:
9903+
:show-inheritance:
9904+
98569905
datadog\_api\_client.v2.model.rum\_aggregate\_bucket\_value module
98579906
------------------------------------------------------------------
98589907

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
"""
2+
Get a rule's version history returns "OK" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_rule_version_history"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = SecurityMonitoringApi(api_client)
12+
response = api_instance.get_rule_version_history(
13+
rule_id="rule_id",
14+
)
15+
16+
print(response)
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
"""
2+
Get rule version history returns "OK" response
3+
"""
4+
5+
from os import environ
6+
from datadog_api_client import ApiClient, Configuration
7+
from datadog_api_client.v2.api.security_monitoring_api import SecurityMonitoringApi
8+
9+
# there is a valid "security_rule" in the system
10+
SECURITY_RULE_ID = environ["SECURITY_RULE_ID"]
11+
12+
configuration = Configuration()
13+
configuration.unstable_operations["get_rule_version_history"] = True
14+
with ApiClient(configuration) as api_client:
15+
api_instance = SecurityMonitoringApi(api_client)
16+
response = api_instance.get_rule_version_history(
17+
rule_id=SECURITY_RULE_ID,
18+
)
19+
20+
print(response)

src/datadog_api_client/configuration.py

+1
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,7 @@ def __init__(
290290
"v2.delete_historical_job": False,
291291
"v2.get_finding": False,
292292
"v2.get_historical_job": False,
293+
"v2.get_rule_version_history": False,
293294
"v2.list_findings": False,
294295
"v2.list_historical_jobs": False,
295296
"v2.mute_findings": False,

src/datadog_api_client/v2/api/security_monitoring_api.py

+64
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@
6666
from datadog_api_client.v2.model.security_monitoring_rule_validate_payload import SecurityMonitoringRuleValidatePayload
6767
from datadog_api_client.v2.model.cloud_configuration_rule_payload import CloudConfigurationRulePayload
6868
from datadog_api_client.v2.model.security_monitoring_rule_update_payload import SecurityMonitoringRuleUpdatePayload
69+
from datadog_api_client.v2.model.get_rule_version_history_response import GetRuleVersionHistoryResponse
6970
from datadog_api_client.v2.model.security_monitoring_signals_list_response import SecurityMonitoringSignalsListResponse
7071
from datadog_api_client.v2.model.security_monitoring_signals_sort import SecurityMonitoringSignalsSort
7172
from datadog_api_client.v2.model.security_monitoring_signal import SecurityMonitoringSignal
@@ -556,6 +557,39 @@ def __init__(self, api_client=None):
556557
api_client=api_client,
557558
)
558559

560+
self._get_rule_version_history_endpoint = _Endpoint(
561+
settings={
562+
"response_type": (GetRuleVersionHistoryResponse,),
563+
"auth": ["apiKeyAuth", "appKeyAuth", "AuthZ"],
564+
"endpoint_path": "/api/v2/security_monitoring/rules/{rule_id}/version_history",
565+
"operation_id": "get_rule_version_history",
566+
"http_method": "GET",
567+
"version": "v2",
568+
},
569+
params_map={
570+
"rule_id": {
571+
"required": True,
572+
"openapi_types": (str,),
573+
"attribute": "rule_id",
574+
"location": "path",
575+
},
576+
"page_size": {
577+
"openapi_types": (int,),
578+
"attribute": "page[size]",
579+
"location": "query",
580+
},
581+
"page_number": {
582+
"openapi_types": (int,),
583+
"attribute": "page[number]",
584+
"location": "query",
585+
},
586+
},
587+
headers_map={
588+
"accept": ["application/json"],
589+
},
590+
api_client=api_client,
591+
)
592+
559593
self._get_sbom_endpoint = _Endpoint(
560594
settings={
561595
"response_type": (GetSBOMResponse,),
@@ -1958,6 +1992,36 @@ def get_historical_job(
19581992

19591993
return self._get_historical_job_endpoint.call_with_http_info(**kwargs)
19601994

1995+
def get_rule_version_history(
1996+
self,
1997+
rule_id: str,
1998+
*,
1999+
page_size: Union[int, UnsetType] = unset,
2000+
page_number: Union[int, UnsetType] = unset,
2001+
) -> GetRuleVersionHistoryResponse:
2002+
"""Get a rule's version history.
2003+
2004+
Get a rule's version history.
2005+
2006+
:param rule_id: The ID of the rule.
2007+
:type rule_id: str
2008+
:param page_size: Size for a given page. The maximum allowed value is 100.
2009+
:type page_size: int, optional
2010+
:param page_number: Specific page number to return.
2011+
:type page_number: int, optional
2012+
:rtype: GetRuleVersionHistoryResponse
2013+
"""
2014+
kwargs: Dict[str, Any] = {}
2015+
kwargs["rule_id"] = rule_id
2016+
2017+
if page_size is not unset:
2018+
kwargs["page_size"] = page_size
2019+
2020+
if page_number is not unset:
2021+
kwargs["page_number"] = page_number
2022+
2023+
return self._get_rule_version_history_endpoint.call_with_http_info(**kwargs)
2024+
19612025
def get_sbom(
19622026
self,
19632027
asset_type: AssetType,

0 commit comments

Comments
 (0)