Skip to content

Commit 4049c4a

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit b3d1b873 of spec repo
1 parent 4e5bce8 commit 4049c4a

15 files changed

+706
-15
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-01-15 18:03:11.180859",
8-
"spec_repo_commit": "e54847a1"
7+
"regenerated": "2025-01-16 16:29:00.243268",
8+
"spec_repo_commit": "b3d1b873"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-01-15 18:03:11.196723",
13-
"spec_repo_commit": "e54847a1"
12+
"regenerated": "2025-01-16 16:29:00.257838",
13+
"spec_repo_commit": "b3d1b873"
1414
}
1515
}
1616
}

‎.generator/schemas/v2/openapi.yaml

+165
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,20 @@ components:
297297
required: false
298298
schema:
299299
$ref: '#/components/schemas/RelationType'
300+
FrameworkHandle:
301+
description: The framework handle
302+
in: path
303+
name: handle
304+
required: true
305+
schema:
306+
type: string
307+
FrameworkVersion:
308+
description: The framework version
309+
in: path
310+
name: version
311+
required: true
312+
schema:
313+
type: string
300314
GCPSTSServiceAccountID:
301315
description: Your GCP STS enabled service account's unique ID.
302316
in: path
@@ -7145,6 +7159,10 @@ components:
71457159
type: string
71467160
x-enum-varnames:
71477161
- APPDEFINITIONS
7162+
CreateCustomFrameworkRequest:
7163+
$ref: '#/components/schemas/FrameworkData'
7164+
description: Create a custom framework.
7165+
type: object
71487166
CreateDataDeletionRequestBody:
71497167
description: Object needed to create a data deletion request.
71507168
properties:
@@ -11936,6 +11954,72 @@ components:
1193611954
order:
1193711955
$ref: '#/components/schemas/QuerySortOrder'
1193811956
type: object
11957+
FrameworkControl:
11958+
description: Framework Control.
11959+
properties:
11960+
name:
11961+
description: Control Name.
11962+
example: ''
11963+
type: string
11964+
rule_ids:
11965+
description: Rule IDs.
11966+
example:
11967+
- ''
11968+
items:
11969+
type: string
11970+
type: array
11971+
required:
11972+
- name
11973+
- rule_ids
11974+
type: object
11975+
FrameworkData:
11976+
description: Framework Data.
11977+
properties:
11978+
description:
11979+
description: Framework Description
11980+
type: string
11981+
handle:
11982+
description: Framework Handle
11983+
example: ''
11984+
type: string
11985+
icon_url:
11986+
description: Framework Icon URL
11987+
type: string
11988+
name:
11989+
description: Framework Name
11990+
example: ''
11991+
type: string
11992+
requirements:
11993+
description: Framework Requirements
11994+
items:
11995+
$ref: '#/components/schemas/FrameworkRequirement'
11996+
type: array
11997+
version:
11998+
description: Framework Version
11999+
example: ''
12000+
type: string
12001+
required:
12002+
- handle
12003+
- version
12004+
- name
12005+
- requirements
12006+
type: object
12007+
FrameworkRequirement:
12008+
description: Framework Requirement.
12009+
properties:
12010+
controls:
12011+
description: Requirement Controls.
12012+
items:
12013+
$ref: '#/components/schemas/FrameworkControl'
12014+
type: array
12015+
name:
12016+
description: Requirement Name.
12017+
example: ''
12018+
type: string
12019+
required:
12020+
- name
12021+
- controls
12022+
type: object
1193912023
FullAPIKey:
1194012024
description: Datadog API key.
1194112025
properties:
@@ -28953,6 +29037,10 @@ components:
2895329037
deployment:
2895429038
$ref: '#/components/schemas/DeploymentRelationship'
2895529039
type: object
29040+
UpdateCustomFrameworkRequest:
29041+
$ref: '#/components/schemas/FrameworkData'
29042+
description: Update a custom framework.
29043+
type: object
2895629044
UpdateOpenAPIResponse:
2895729045
description: Response for `UpdateOpenAPI`.
2895829046
properties:
@@ -33028,6 +33116,83 @@ paths:
3302833116
operator: OR
3302933117
permissions:
3303033118
- ci_visibility_read
33119+
/api/v2/cloud_security_management/custom_frameworks:
33120+
post:
33121+
description: Create a custom framework.
33122+
operationId: CreateCustomFramework
33123+
requestBody:
33124+
content:
33125+
application/json:
33126+
schema:
33127+
$ref: '#/components/schemas/CreateCustomFrameworkRequest'
33128+
required: true
33129+
responses:
33130+
'200':
33131+
description: OK
33132+
'400':
33133+
$ref: '#/components/responses/BadRequestResponse'
33134+
'429':
33135+
$ref: '#/components/responses/TooManyRequestsResponse'
33136+
'500':
33137+
$ref: '#/components/responses/BadRequestResponse'
33138+
security:
33139+
- apiKeyAuth: []
33140+
appKeyAuth: []
33141+
- AuthZ:
33142+
- security_monitoring_rules_read
33143+
- security_monitoring_rules_write
33144+
summary: Create a custom framework
33145+
tags:
33146+
- Security Monitoring
33147+
x-codegen-request-body-name: body
33148+
x-permission:
33149+
operator: AND
33150+
permissions:
33151+
- security_monitoring_rules_read
33152+
- security_monitoring_rules_write
33153+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
33154+
33155+
Please check the documentation regularly for updates.'
33156+
/api/v2/cloud_security_management/custom_frameworks/{handle}/{version}:
33157+
put:
33158+
description: Update a custom framework.
33159+
operationId: UpdateCustomFramework
33160+
parameters:
33161+
- $ref: '#/components/parameters/FrameworkHandle'
33162+
- $ref: '#/components/parameters/FrameworkVersion'
33163+
requestBody:
33164+
content:
33165+
application/json:
33166+
schema:
33167+
$ref: '#/components/schemas/UpdateCustomFrameworkRequest'
33168+
required: true
33169+
responses:
33170+
'200':
33171+
description: OK
33172+
'400':
33173+
$ref: '#/components/responses/BadRequestResponse'
33174+
'429':
33175+
$ref: '#/components/responses/TooManyRequestsResponse'
33176+
'500':
33177+
$ref: '#/components/responses/BadRequestResponse'
33178+
security:
33179+
- apiKeyAuth: []
33180+
appKeyAuth: []
33181+
- AuthZ:
33182+
- security_monitoring_rules_read
33183+
- security_monitoring_rules_write
33184+
summary: Update a custom framework
33185+
tags:
33186+
- Security Monitoring
33187+
x-codegen-request-body-name: body
33188+
x-permission:
33189+
operator: AND
33190+
permissions:
33191+
- security_monitoring_rules_read
33192+
- security_monitoring_rules_write
33193+
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
33194+
33195+
Please check the documentation regularly for updates.'
3303133196
/api/v2/container_images:
3303233197
get:
3303333198
description: Get all Container Images for your organization.

‎docs/datadog_api_client.v2.model.rst

+28
Original file line numberDiff line numberDiff line change
@@ -2727,6 +2727,13 @@ datadog\_api\_client.v2.model.create\_app\_response\_data\_type module
27272727
:members:
27282728
:show-inheritance:
27292729

2730+
datadog\_api\_client.v2.model.create\_custom\_framework\_request module
2731+
-----------------------------------------------------------------------
2732+
2733+
.. automodule:: datadog_api_client.v2.model.create_custom_framework_request
2734+
:members:
2735+
:show-inheritance:
2736+
27302737
datadog\_api\_client.v2.model.create\_data\_deletion\_request\_body module
27312738
--------------------------------------------------------------------------
27322739

@@ -4883,6 +4890,20 @@ datadog\_api\_client.v2.model.formula\_limit module
48834890
:members:
48844891
:show-inheritance:
48854892

4893+
datadog\_api\_client.v2.model.framework\_control module
4894+
-------------------------------------------------------
4895+
4896+
.. automodule:: datadog_api_client.v2.model.framework_control
4897+
:members:
4898+
:show-inheritance:
4899+
4900+
datadog\_api\_client.v2.model.framework\_requirement module
4901+
-----------------------------------------------------------
4902+
4903+
.. automodule:: datadog_api_client.v2.model.framework_requirement
4904+
:members:
4905+
:show-inheritance:
4906+
48864907
datadog\_api\_client.v2.model.full\_api\_key module
48874908
---------------------------------------------------
48884909

@@ -12744,6 +12765,13 @@ datadog\_api\_client.v2.model.update\_app\_response\_relationship module
1274412765
:members:
1274512766
:show-inheritance:
1274612767

12768+
datadog\_api\_client.v2.model.update\_custom\_framework\_request module
12769+
-----------------------------------------------------------------------
12770+
12771+
.. automodule:: datadog_api_client.v2.model.update_custom_framework_request
12772+
:members:
12773+
:show-inheritance:
12774+
1274712775
datadog\_api\_client.v2.model.update\_open\_api\_response module
1274812776
----------------------------------------------------------------
1274912777

‎examples/v2/security-monitoring/CreateCustomFramework.py

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
"""
2+
Create a custom framework 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+
from datadog_api_client.v2.model.create_custom_framework_request import CreateCustomFrameworkRequest
8+
from datadog_api_client.v2.model.framework_control import FrameworkControl
9+
from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement
10+
11+
body = CreateCustomFrameworkRequest(
12+
handle="",
13+
name="",
14+
requirements=[
15+
FrameworkRequirement(
16+
controls=[
17+
FrameworkControl(
18+
name="",
19+
rule_ids=[
20+
"",
21+
],
22+
),
23+
],
24+
name="",
25+
),
26+
],
27+
version="",
28+
)
29+
30+
configuration = Configuration()
31+
configuration.unstable_operations["create_custom_framework"] = True
32+
with ApiClient(configuration) as api_client:
33+
api_instance = SecurityMonitoringApi(api_client)
34+
api_instance.create_custom_framework(body=body)

‎examples/v2/security-monitoring/UpdateCustomFramework.py

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
"""
2+
Update a custom framework 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+
from datadog_api_client.v2.model.framework_control import FrameworkControl
8+
from datadog_api_client.v2.model.framework_requirement import FrameworkRequirement
9+
from datadog_api_client.v2.model.update_custom_framework_request import UpdateCustomFrameworkRequest
10+
11+
body = UpdateCustomFrameworkRequest(
12+
handle="",
13+
name="",
14+
requirements=[
15+
FrameworkRequirement(
16+
controls=[
17+
FrameworkControl(
18+
name="",
19+
rule_ids=[
20+
"",
21+
],
22+
),
23+
],
24+
name="",
25+
),
26+
],
27+
version="",
28+
)
29+
30+
configuration = Configuration()
31+
configuration.unstable_operations["update_custom_framework"] = True
32+
with ApiClient(configuration) as api_client:
33+
api_instance = SecurityMonitoringApi(api_client)
34+
api_instance.update_custom_framework(handle="handle", version="version", body=body)

‎src/datadog_api_client/configuration.py

+13-11
Original file line numberDiff line numberDiff line change
@@ -249,6 +249,19 @@ def __init__(
249249
"v2.get_app": False,
250250
"v2.list_apps": False,
251251
"v2.update_app": False,
252+
"v2.cancel_historical_job": False,
253+
"v2.convert_job_result_to_signal": False,
254+
"v2.create_custom_framework": False,
255+
"v2.delete_historical_job": False,
256+
"v2.get_finding": False,
257+
"v2.get_historical_job": False,
258+
"v2.list_findings": False,
259+
"v2.list_historical_jobs": False,
260+
"v2.list_vulnerabilities": False,
261+
"v2.list_vulnerable_assets": False,
262+
"v2.mute_findings": False,
263+
"v2.run_historical_job": False,
264+
"v2.update_custom_framework": False,
252265
"v2.get_active_billing_dimensions": False,
253266
"v2.get_billing_dimension_mapping": False,
254267
"v2.get_monthly_cost_attribution": False,
@@ -288,17 +301,6 @@ def __init__(
288301
"v2.list_aws_namespaces": False,
289302
"v2.update_aws_account": False,
290303
"v2.list_aws_logs_services": False,
291-
"v2.cancel_historical_job": False,
292-
"v2.convert_job_result_to_signal": False,
293-
"v2.delete_historical_job": False,
294-
"v2.get_finding": False,
295-
"v2.get_historical_job": False,
296-
"v2.list_findings": False,
297-
"v2.list_historical_jobs": False,
298-
"v2.list_vulnerabilities": False,
299-
"v2.list_vulnerable_assets": False,
300-
"v2.mute_findings": False,
301-
"v2.run_historical_job": False,
302304
"v2.create_scorecard_outcomes_batch": False,
303305
"v2.create_scorecard_rule": False,
304306
"v2.delete_scorecard_rule": False,

0 commit comments

Comments
 (0)