8000 Regenerate client from commit 302f87a7 of spec repo · DataDog/documentation@54c5211 · GitHub
[go: up one dir, main page]
Skip to content

Commit 54c5211

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 302f87a7 of spec repo
1 parent bb549bf commit 54c5211

File tree

6 files changed

+197
-15
lines changed

6 files changed

+197
-15
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
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-05-14 15:46:38.896407",
8-
8000 "spec_repo_commit": "64f5e7ee"
7+
"regenerated": "2025-05-16 10:39:49.707394",
8+
"spec_repo_commit": "302f87a7"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-14 15:46:48.228708",
13-
"spec_repo_commit": "64f5e7ee"
12+
"regenerated": "2025-05-16 10:39:58.927087",
13+
"spec_repo_commit": "302f87a7"
1414
}
1515
}
1616
}

‎content/en/api/v2/security-monitoring/examples.json

Lines changed: 3 additions & 1 deletion
Large diffs are not rendered by default.

‎data/api/v2/full_spec.yaml

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15055,6 +15055,10 @@ components:
1505515055
FindingAttributes:
1505615056
description: The JSON:API attributes of the finding.
1505715057
properties:
15058+
datadog_link:
15059+
$ref: '#/components/schemas/FindingDatadogLink'
15060+
description:
15061+
$ref: '#/components/schemas/FindingDescription'
1505815062
evaluation:
1505915063
$ref: '#/components/schemas/FindingEvaluation'
1506015064
evaluation_changed_at:
@@ -15076,6 +15080,25 @@ components:
1507615080
vulnerability_type:
1507715081
$ref: '#/components/schemas/FindingVulnerabilityType'
1507815082
type: object
15083+
FindingDatadogLink:
15084+
description: The Datadog relative link for this finding.
15085+
example: /security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview
15086+
type: string
15087+
FindingDescription:
15088+
description: The description and remediation steps for this finding.
15089+
example: '## Remediation
15090+
15091+
15092+
### From the console
15093+
15094+
15095+
1. Go to Storage Account
15096+
15097+
2. For each Storage Account, navigate to Data Protection
15098+
15099+
3. Select Set soft delete enabled and enter the number of days to retain soft
15100+
deleted data.'
15101+
type: string
1507915102
FindingEvaluation:
1508015103
description: The evaluation of the finding.
1508115104
enum:
@@ -54554,13 +54577,18 @@ paths:
5455454577
the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery
5455554578
parameters must be only among the documented ones and with values of correct
5455654579
types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`)
54557-
are not allowed.\n\n### Response\n\nThe response includes an array of finding
54558-
objects, pagination metadata, and a count of items that match the query.\n\nEach
54559-
finding object contains the following:\n\n- The finding ID that can be used
54560-
in a `GetFinding` request to retrieve the full finding details.\n- Core attributes,
54561-
including status, evaluation, high-level resource details, muted state, and
54562-
rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time
54563- stamps.\n- An array of associated tags.\n"
54580+
are not allowed.\n\n### Additional Extension\n\nAdditional extension fields
54581+
are available for some findings.\n\nThe data is available by including the
54582+
query parameter `?detailed_findings=true` in the request.\n\nThe following
54583+
fields are available for findings:\n- `description`: The description and remediation
54584+
steps for this finding.\n- `datadog_link`: The Datadog relative link for this
54585+
finding.\n\n### Response\n\nThe response includes an array of finding objects,
54586+
pagination metadata, and a count of items that match the query.\n\nEach finding
54587+
object contains the following:\n\n- The finding ID that can be used in a `GetFinding`
54588+
request to retrieve the full finding details.\n- Core attributes, including
54589+
status, evaluation, high-level resource details, muted state, and rule details.\n-
54590+
`evaluation_changed_at` and `resource_discovery_date` time stamps.\n- An array
54591+
of associated tags.\n"
5456454592
operationId: ListFindings
5456554593
parameters:
5456654594
- description: Limit the number of findings returned. Must be <= 1000.
@@ -54663,6 +54691,14 @@ paths:
5466354691
items:
5466454692
$ref: '#/components/schemas/FindingVulnerabilityType'
5466554693
type: array
54694+
- description: Return additional fields for some findings.
54695+
example:
54696+
- true
54697+
in: query
54698+
name: detailed_findings
54699+
required: false
54700+
schema:
54701+
type: boolean
5466654702
responses:
5466754703
'200':
5466854704
content:

‎data/api/v2/full_spec_deref.json

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86932,6 +86932,16 @@
8693286932
"attributes": {
8693386933
"description": "The JSON:API attributes of the finding.",
8693486934
"properties": {
86935+
"datadog_link": {
86936+
"description": "The Datadog relative link for this finding.",
86937+
"example": "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview",
86938+
"type": "string"
86939+
},
86940+
"description": {
86941+
"description": "The description and remediation steps for this finding.",
86942+
"example": "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain F438 soft deleted data.",
86943+
"type": "string"
86944+
},
8693586945
"evaluation": {
8693686946
"description": "The evaluation of the finding.",
8693786947
"enum": [
@@ -87117,6 +87127,16 @@
8711787127
"FindingAttributes": {
8711887128
"description": "The JSON:API attributes of the finding.",
8711987129
"properties": {
87130+
"datadog_link": {
87131+
"description": "The Datadog relative link for this finding.",
87132+
"example": "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview",
87133+
"type": "string"
87134+
},
87135+
"description": {
87136+
"description": "The description and remediation steps for this finding.",
87137+
"example": "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data.",
87138+
"type": "string"
87139+
},
8712087140
"evaluation": {
8712187141
"description": "The evaluation of the finding.",
8712287142
"enum": [
@@ -87279,6 +87299,16 @@
8727987299
},
8728087300
"type": "object"
8728187301
},
87302+
"FindingDatadogLink": {
87303+
"description": "The Datadog relative link for this finding.",
87304+
"example": "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview",
87305+
"type": "string"
87306+
},
87307+
"FindingDescription": {
87308+
"description": "The description and remediation steps for this finding.",
87309+
"example": "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data.",
87310+
"type": "string"
87311+
},
8728287312
"FindingEvaluation": {
8728387313
"description": "The evaluation of the finding.",
8728487314
"enum": [
@@ -135275,6 +135305,16 @@
135275135305
"attributes": {
135276135306
"description": "The JSON:API attributes of the finding.",
135277135307
"properties": {
135308+
"datadog_link": {
135309+
"description": "The Datadog relative link for this finding.",
135310+
"example": "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview",
135311+
"type": "string"
135312+
},
135313+
"description": {
135314+
"description": "The description and remediation steps for this finding.",
135315+
"example": "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data.",
135316+
"type": "string"
135317+
},
135278135318
"evaluation": {
135279135319
"description": "The evaluation of the finding.",
135280135320
"enum": [
@@ -135520,6 +135560,16 @@
135520135560
"attributes": {
135521135561
"description": "The JSON:API attributes of the finding.",
135522135562
"properties": {
135563+
"datadog_link": {
135564+
"description": "The Datadog relative link for this finding.",
135565+
"example": "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview",
135566+
"type": "string"
135567+
},
135568+
"description": {
135569+
"description": "The description and remediation steps for this finding.",
135570+
"example": "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data.",
135571+
"type": "string"
135572+
},
135523135573
"evaluation": {
135524135574
"description": "The evaluation of the finding.",
135525135575
"enum": [
@@ -426556,7 +426606,7 @@
426556426606
},
426557426607
"/api/v2/posture_management/findings": {
426558426608
"get": {
426559-
"description": "Get a list of findings. These include both misconfigurations and identity risks.\n\n**Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`\n\n### Filtering\n\nFilters can be applied by appending query parameters to the URL.\n\n - Using a single filter: `?filter[attribute_key]=attribute_value`\n - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere, `attribute_key` can be any of the filter keys described further below.\n\nQuery parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.\n\nYou can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.\n\nThe operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.\n\n### Response\n\nThe response includes an array of finding objects, pagination metadata, and a count of items that match the query.\n\nEach finding object contains the following:\n\n- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.\n- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time stamps.\n- An array of associated tags.\n",
426609+
"description": "Get a list of findings. These include both misconfigurations and identity risks.\n\n**Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`\n\n### Filtering\n\nFilters can be applied by appending query parameters to the URL.\n\n - Using a single filter: `?filter[attribute_key]=attribute_value`\n - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere, `attribute_key` can be any of the filter keys described further below.\n\nQuery parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.\n\nYou can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.\n\nThe operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.\n\n### Additional Extension\n\nAdditional extension fields are available for some findings.\n\nThe data is available by including the query parameter `?detailed_findings=true` in the request.\n\nThe following fields are available for findings:\n- `description`: The description and remediation steps for this finding.\n- `datadog_link`: The Datadog relative link for this finding.\n\n### Response\n\nThe response includes an array of finding objects, pagination metadata, and a count of items that match the query.\n\nEach finding object contains the following:\n\n- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.\n- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time stamps.\n- An array of associated tags.\n",
426560426610
"operationId": "ListFindings",
426561426611
"parameters": [
426562426612
{
@@ -426736,6 +426786,18 @@
426736426786
},
426737426787
"type": "array"
426738426788
}
426789+
},
426790+
{
426791+
"description": "Return additional fields for some findings.",
426792+
"example": [
426793+
true
426794+
],
426795+
"in": "query",
426796+
"name": "detailed_findings",
426797+
"required": false,
426798+
"schema": {
426799+
"type": "boolean"
426800+
}
426739426801
}
426740426802
],
426741426803
"responses": {
@@ -426753,6 +426815,16 @@
426753426815
"attributes": {
426754426816
"description": "The JSON:API attributes of the finding.",
426755426817
"properties": {
426818+
"datadog_link": {
426819+
"description": "The Datadog relative link for this finding.",
426820+
"example": "/security/compliance?panels=cpfinding%7Cevent%7CruleId%3Adef-000-u5t%7CresourceId%3Ae8c9ab7c52ebd7bf2fdb4db641082d7d%7CtabId%3Aoverview",
426821+
"type": "string"
426822+
},
426823+
"description": {
426824+
"description": "The description and remediation steps for this finding.",
426825+
"example": "## Remediation\n\n### From the console\n\n1. Go to Storage Account\n2. For each Storage Account, navigate to Data Protection\n3. Select Set soft delete enabled and enter the number of days to retain soft deleted data.",
426826+
"type": "string"
426827+
},
426756426828
"evaluation": {
426757426829
"description": "The evaluation of the finding.",
426758426830
"enum": [

‎data/api/v2/translate_actions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1404,7 +1404,7 @@
14041404
"summary": "List permissions"
14051405
},
14061406
"ListFindings": {
1407-
"description": "Get a list of findings. These include both misconfigurations and identity risks.\n\n**Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`\n\n### Filtering\n\nFilters can be applied by appending query parameters to the URL.\n\n - Using a single filter: `?filter[attribute_key]=attribute_value`\n - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere, `attribute_key` can be any of the filter keys described further below.\n\nQuery parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.\n\nYou can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.\n\nThe operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.\n\n### Response\n\nThe response includes an array of finding objects, pagination metadata, and a count of items that match the query.\n\nEach finding object contains the following:\n\n- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.\n- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time stamps.\n- An array of associated tags.\n",
1407+
&quo 512C t;description": "Get a list of findings. These include both misconfigurations and identity risks.\n\n**Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`\n\n### Filtering\n\nFilters can be applied by appending query parameters to the URL.\n\n - Using a single filter: `?filter[attribute_key]=attribute_value`\n - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere, `attribute_key` can be any of the filter keys described further below.\n\nQuery parameters of type `integer` support comparison operators (`>`, `>=`, `<`, `<=`). This is particularly useful when filtering by `evaluation_changed_at` or `resource_discovery_timestamp`. For example: `?filter[evaluation_changed_at]=>20123123121`.\n\nYou can also use the negation operator on strings. For example, use `filter[resource_type]=-aws*` to filter for any non-AWS resources.\n\nThe operator must come after the equal sign. For example, to filter with the `>=` operator, add the operator after the equal sign: `filter[evaluation_changed_at]=>=1678809373257`.\n\nQuery parameters must be only among the documented ones and with values of correct types. Duplicated query parameters (e.g. `filter[status]=low&filter[status]=info`) are not allowed.\n\n### Additional Extension\n\nAdditional extension fields are available for some findings.\n\nThe data is available by including the query parameter `?detailed_findings=true` in the request.\n\nThe following fields are available for findings:\n- `description`: The description and remediation steps for this finding.\n- `datadog_link`: The Datadog relative link for this finding.\n\n### Response\n\nThe response includes an array of finding objects, pagination metadata, and a count of items that match the query.\n\nEach finding object contains the following:\n\n- The finding ID that can be used in a `GetFinding` request to retrieve the full finding details.\n- Core attributes, including status, evaluation, high-level resource details, muted state, and rule details.\n- `evaluation_changed_at` and `resource_discovery_date` time stamps.\n- An array of associated tags.\n",
14081408
"summary": "List findings"
14091409
},
14101410
"MuteFindings": {

0 commit comments

Comments
 (0)
0