Skip to content

Commit 93b7cb4

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add custom/rulesets endpoints (#3067)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent d7f1f88 commit 93b7cb4

File tree

49 files changed

+4389
-1
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+4389
-1
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 1057 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/datadog_api_client.v2.model.rst‎

Lines changed: 217 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1124,6 +1124,13 @@ datadog\_api\_client.v2.model.arbitrary\_rule\_response\_data\_type module
11241124
:members:
11251125
:show-inheritance:
11261126

1127+
datadog\_api\_client.v2.model.argument module
1128+
---------------------------------------------
1129+
1130+
.. automodule:: datadog_api_client.v2.model.argument
1131+
:members:
1132+
:show-inheritance:
1133+
11271134
datadog\_api\_client.v2.model.asana\_access\_token module
11281135
---------------------------------------------------------
11291136

@@ -6675,6 +6682,181 @@ datadog\_api\_client.v2.model.custom\_framework\_without\_requirements module
66756682
:members:
66766683
:show-inheritance:
66776684

6685+
datadog\_api\_client.v2.model.custom\_rule module
6686+
-------------------------------------------------
6687+
6688+
.. automodule:: datadog_api_client.v2.model.custom_rule
6689+
:members:
6690+
:show-inheritance:
6691+
6692+
datadog\_api\_client.v2.model.custom\_rule\_data\_type module
6693+
-------------------------------------------------------------
6694+
6695+
.. automodule:: datadog_api_client.v2.model.custom_rule_data_type
6696+
:members:
6697+
:show-inheritance:
6698+
6699+
datadog\_api\_client.v2.model.custom\_rule\_request module
6700+
----------------------------------------------------------
6701+
6702+
.. automodule:: datadog_api_client.v2.model.custom_rule_request
6703+
:members:
6704+
:show-inheritance:
6705+
6706+
datadog\_api\_client.v2.model.custom\_rule\_request\_data module
6707+
----------------------------------------------------------------
6708+
6709+
.. automodule:: datadog_api_client.v2.model.custom_rule_request_data
6710+
:members:
6711+
:show-inheritance:
6712+
6713+
datadog\_api\_client.v2.model.custom\_rule\_request\_data\_attributes module
6714+
----------------------------------------------------------------------------
6715+
6716+
.. automodule:: datadog_api_client.v2.model.custom_rule_request_data_attributes
6717+
:members:
6718+
:show-inheritance:
6719+
6720+
datadog\_api\_client.v2.model.custom\_rule\_response module
6721+
-----------------------------------------------------------
6722+
6723+
.. automodule:: datadog_api_client.v2.model.custom_rule_response
6724+
:members:
6725+
:show-inheritance:
6726+
6727+
datadog\_api\_client.v2.model.custom\_rule\_response\_data module
6728+
-----------------------------------------------------------------
6729+
6730+
.. automodule:: datadog_api_client.v2.model.custom_rule_response_data
6731+
:members:
6732+
:show-inheritance:
6733+
6734+
datadog\_api\_client.v2.model.custom\_rule\_revision module
6735+
-----------------------------------------------------------
6736+
6737+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision
6738+
:members:
6739+
:show-inheritance:
6740+
6741+
datadog\_api\_client.v2.model.custom\_rule\_revision\_attributes module
6742+
-----------------------------------------------------------------------
6743+
6744+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_attributes
6745+
:members:
6746+
:show-inheritance:
6747+
6748+
datadog\_api\_client.v2.model.custom\_rule\_revision\_attributes\_category module
6749+
---------------------------------------------------------------------------------
6750+
6751+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_attributes_category
6752+
:members:
6753+
:show-inheritance:
6754+
6755+
datadog\_api\_client.v2.model.custom\_rule\_revision\_attributes\_severity module
6756+
---------------------------------------------------------------------------------
6757+
6758+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_attributes_severity
6759+
:members:
6760+
:show-inheritance:
6761+
6762+
datadog\_api\_client.v2.model.custom\_rule\_revision\_data\_type module
6763+
-----------------------------------------------------------------------
6764+
6765+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_data_type
6766+
:members:
6767+
:show-inheritance:
6768+
6769+
datadog\_api\_client.v2.model.custom\_rule\_revision\_input\_attributes module
6770+
------------------------------------------------------------------------------
6771+
6772+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_input_attributes
6773+
:members:
6774+
:show-inheritance:
6775+
6776+
datadog\_api\_client.v2.model.custom\_rule\_revision\_request module
6777+
--------------------------------------------------------------------
6778+
6779+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_request
6780+
:members:
6781+
:show-inheritance:
6782+
6783+
datadog\_api\_client.v2.model.custom\_rule\_revision\_request\_data module
6784+
--------------------------------------------------------------------------
6785+
6786+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_request_data
6787+
:members:
6788+
:show-inheritance:
6789+
6790+
datadog\_api\_client.v2.model.custom\_rule\_revision\_response module
6791+
---------------------------------------------------------------------
6792+
6793+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_response
6794+
:members:
6795+
:show-inheritance:
6796+
6797+
datadog\_api\_client.v2.model.custom\_rule\_revision\_test module
6798+
-----------------------------------------------------------------
6799+
6800+
.. automodule:: datadog_api_client.v2.model.custom_rule_revision_test
6801+
:members:
6802+
:show-inheritance:
6803+
6804+
datadog\_api\_client.v2.model.custom\_rule\_revisions\_response module
6805+
----------------------------------------------------------------------
6806+
6807+
.. automodule:: datadog_api_client.v2.model.custom_rule_revisions_response
6808+
:members:
6809+
:show-inheritance:
6810+
6811+
datadog\_api\_client.v2.model.custom\_ruleset module
6812+
----------------------------------------------------
6813+
6814+
.. automodule:: datadog_api_client.v2.model.custom_ruleset
6815+
:members:
6816+
:show-inheritance:
6817+
6818+
datadog\_api\_client.v2.model.custom\_ruleset\_attributes module
6819+
----------------------------------------------------------------
6820+
6821+
.. automodule:: datadog_api_client.v2.model.custom_ruleset_attributes
6822+
:members:
6823+
:show-inheritance:
6824+
6825+
datadog\_api\_client.v2.model.custom\_ruleset\_data\_type module
6826+
----------------------------------------------------------------
6827+
6828+
.. automodule:: datadog_api_client.v2.model.custom_ruleset_data_type
6829+
:members:
6830+
:show-inheritance:
6831+
6832+
datadog\_api\_client.v2.model.custom\_ruleset\_request module
6833+
-------------------------------------------------------------
6834+
6835+
.. automodule:: datadog_api_client.v2.model.custom_ruleset_request
6836+
:members:
6837+
:show-inheritance:
6838+
6839+
datadog\_api\_client.v2.model.custom\_ruleset\_request\_data module
6840+
-------------------------------------------------------------------
6841+
6842+
.. automodule:: datadog_api_client.v2.model.custom_ruleset_request_data
6843+
:members:
6844+
:show-inheritance:
6845+
6846+
datadog\_api\_client.v2.model.custom\_ruleset\_request\_data\_attributes module
6847+
-------------------------------------------------------------------------------
6848+
6849+
.. automodule:: datadog_api_client.v2.model.custom_ruleset_request_data_attributes
6850+
:members:
6851+
:show-inheritance:
6852+
6853+
datadog\_api\_client.v2.model.custom\_ruleset\_response module
6854+
--------------------------------------------------------------
6855+
6856+
.. automodule:: datadog_api_client.v2.model.custom_ruleset_response
6857+
:members:
6858+
:show-inheritance:
6859+
66786860
datadog\_api\_client.v2.model.cvss module
66796861
-----------------------------------------
66806862

@@ -13325,6 +13507,13 @@ datadog\_api\_client.v2.model.kind\_response\_meta module
1332513507
:members:
1332613508
:show-inheritance:
1332713509

13510+
datadog\_api\_client.v2.model.language module
13511+
---------------------------------------------
13512+
13513+
.. automodule:: datadog_api_client.v2.model.language
13514+
:members:
13515+
:show-inheritance:
13516+
1332813517
datadog\_api\_client.v2.model.launch\_darkly\_api\_key module
1332913518
-------------------------------------------------------------
1333013519

@@ -20297,6 +20486,34 @@ datadog\_api\_client.v2.model.retry\_strategy\_linear module
2029720486
:members:
2029820487
:show-inheritance:
2029920488

20489+
datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_data\_type module
20490+
-------------------------------------------------------------------------------
20491+
20492+
.. automodule:: datadog_api_client.v2.model.revert_custom_rule_revision_data_type
20493+
:members:
20494+
:show-inheritance:
20495+
20496+
datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request module
20497+
----------------------------------------------------------------------------
20498+
20499+
.. automodule:: datadog_api_client.v2.model.revert_custom_rule_revision_request
20500+
:members:
20501+
:show-inheritance:
20502+
20503+
datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request\_data module
20504+
----------------------------------------------------------------------------------
20505+
20506+
.. automodule:: datadog_api_client.v2.model.revert_custom_rule_revision_request_data
20507+
:members:
20508+
:show-inheritance:
20509+
20510+
datadog\_api\_client.v2.model.revert\_custom\_rule\_revision\_request\_data\_attributes module
20511+
----------------------------------------------------------------------------------------------
20512+
20513+
.. automodule:: datadog_api_client.v2.model.revert_custom_rule_revision_request_data_attributes
20514+
:members:
20515+
:show-inheritance:
20516+
2030020517
datadog\_api\_client.v2.model.role module
2030120518
-----------------------------------------
2030220519

‎examples/v2/static-analysis/CreateCustomRule.py‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
"""
2+
Create Custom Rule returns "Successfully created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
7+
from datadog_api_client.v2.model.custom_rule_data_type import CustomRuleDataType
8+
from datadog_api_client.v2.model.custom_rule_request import CustomRuleRequest
9+
from datadog_api_client.v2.model.custom_rule_request_data import CustomRuleRequestData
10+
from datadog_api_client.v2.model.custom_rule_request_data_attributes import CustomRuleRequestDataAttributes
11+
12+
body = CustomRuleRequest(
13+
data=CustomRuleRequestData(
14+
attributes=CustomRuleRequestDataAttributes(),
15+
type=CustomRuleDataType.CUSTOM_RULE,
16+
),
17+
)
18+
19+
configuration = Configuration()
20+
configuration.unstable_operations["create_custom_rule"] = True
21+
with ApiClient(configuration) as api_client:
22+
api_instance = StaticAnalysisApi(api_client)
23+
response = api_instance.create_custom_rule(ruleset_name="ruleset_name", body=body)
24+
25+
print(response)

‎examples/v2/static-analysis/CreateCustomRuleRevision.py‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
"""
2+
Create Custom Rule Revision returns "Successfully created" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
7+
from datadog_api_client.v2.model.argument import Argument
8+
from datadog_api_client.v2.model.custom_rule_revision_attributes_category import CustomRuleRevisionAttributesCategory
9+
from datadog_api_client.v2.model.custom_rule_revision_attributes_severity import CustomRuleRevisionAttributesSeverity
10+
from datadog_api_client.v2.model.custom_rule_revision_data_type import CustomRuleRevisionDataType
11+
from datadog_api_client.v2.model.custom_rule_revision_input_attributes import CustomRuleRevisionInputAttributes
12+
from datadog_api_client.v2.model.custom_rule_revision_request import CustomRuleRevisionRequest
13+
from datadog_api_client.v2.model.custom_rule_revision_request_data import CustomRuleRevisionRequestData
14+
from datadog_api_client.v2.model.custom_rule_revision_test import CustomRuleRevisionTest
15+
from datadog_api_client.v2.model.language import Language
16+
17+
body = CustomRuleRevisionRequest(
18+
data=CustomRuleRevisionRequestData(
19+
attributes=CustomRuleRevisionInputAttributes(
20+
arguments=[
21+
Argument(
22+
description="YXJndW1lbnQgZGVzY3JpcHRpb24=",
23+
name="YXJndW1lbnRfbmFtZQ==",
24+
),
25+
],
26+
category=CustomRuleRevisionAttributesCategory.SECURITY,
27+
code="Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
28+
creation_message="Initial revision",
29+
cve="CVE-2024-1234",
30+
cwe="CWE-79",
31+
description="bG9uZyBkZXNjcmlwdGlvbg==",
32+
documentation_url="https://docs.example.com/rules/my-rule",
33+
is_published=False,
34+
is_testing=False,
35+
language=Language.PYTHON,
36+
severity=CustomRuleRevisionAttributesSeverity.ERROR,
37+
short_description="c2hvcnQgZGVzY3JpcHRpb24=",
38+
should_use_ai_fix=False,
39+
tags=[
40+
"security",
41+
"custom",
42+
],
43+
tests=[
44+
CustomRuleRevisionTest(
45+
annotation_count=1,
46+
code="Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
47+
filename="test.yaml",
48+
),
49+
],
50+
tree_sitter_query="Y29uZHVjdG9yOgogICAgLSBkZXBsb3lfb25seTogdHJ1ZQ==",
51+
),
52+
type=CustomRuleRevisionDataType.CUSTOM_RULE_REVISION,
53+
),
54+
)
55+
56+
configuration = Configuration()
57+
configuration.unstable_operations["create_custom_rule_revision"] = True
58+
with ApiClient(configuration) as api_client:
59+
api_instance = StaticAnalysisApi(api_client)
60+
api_instance.create_custom_rule_revision(ruleset_name="ruleset_name", rule_name="rule_name", body=body)

‎examples/v2/static-analysis/DeleteCustomRule.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""
2+
Delete Custom Rule returns "Successfully deleted" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["delete_custom_rule"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = StaticAnalysisApi(api_client)
12+
api_instance.delete_custom_rule(
13+
ruleset_name="ruleset_name",
14+
rule_name="rule_name",
15+
)

‎examples/v2/static-analysis/DeleteCustomRuleset.py‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
"""
2+
Delete Custom Ruleset returns "Successfully deleted" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["delete_custom_ruleset"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = StaticAnalysisApi(api_client)
12+
api_instance.delete_custom_ruleset(
13+
ruleset_name="ruleset_name",
14+
)

‎examples/v2/static-analysis/GetCustomRule.py‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
"""
2+
Show Custom Rule returns "Successful response" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_custom_rule"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = StaticAnalysisApi(api_client)
12+
response = api_instance.get_custom_rule(
13+
ruleset_name="ruleset_name",
14+
rule_name="rule_name",
15+
)
16+
17+
print(response)

‎examples/v2/static-analysis/GetCustomRuleRevision.py‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
"""
2+
Show Custom Rule Revision returns "Successful response" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.static_analysis_api import StaticAnalysisApi
7+
8+
configuration = Configuration()
9+
configuration.unstable_operations["get_custom_rule_revision"] = True
10+
with ApiClient(configuration) as api_client:
11+
api_instance = StaticAnalysisApi(api_client)
12+
response = api_instance.get_custom_rule_revision(
13+
ruleset_name="ruleset_name",
14+
rule_name="rule_name",
15+
id="id",
16+
)
17+
18+
print(response)

0 commit comments

Comments
 (0)