Skip to content

Commit 9ee43e8

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Update documentation for App Sec SCA (#1710)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 7dbe2a4 commit 9ee43e8

9 files changed

+133
-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": "2024-07-26 18:27:50.250491",
8-
"spec_repo_commit": "7e92b530"
7+
"regenerated": "2024-07-26 19:06:12.505492",
8+
"spec_repo_commit": "44cf4afe"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-07-26 18:27:50.268852",
13-
"spec_repo_commit": "7e92b530"
12+
"regenerated": "2024-07-26 19:06:12.524483",
13+
"spec_repo_commit": "44cf4afe"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

+48
Original file line numberDiff line numberDiff line change
@@ -4216,6 +4216,7 @@ components:
42164216
- profiled_host_usage
42174217
- rum_browser_mobile_sessions_usage
42184218
- rum_replay_sessions_usage
4219+
- sca_fargate_usage
42194220
- sds_scanned_bytes_usage
42204221
- serverless_apps_usage
42214222
- siem_analyzed_logs_add_on_usage
@@ -4288,6 +4289,7 @@ components:
42884289
- PROFILED_HOST_USAGE
42894290
- RUM_BROWSER_MOBILE_SESSIONS_USAGE
42904291
- RUM_REPLAY_SESSIONS_USAGE
4292+
- SCA_FARGATE_USAGE
42914293
- SDS_SCANNED_BYTES_USAGE
42924294
- SERVERLESS_APPS_USAGE
42934295
- SIEM_ANALYZED_LOGS_ADD_ON_USAGE
@@ -7991,6 +7993,8 @@ components:
79917993
- siem_ingested_bytes_percentage
79927994
- workflow_executions_usage
79937995
- workflow_executions_percentage
7996+
- sca_fargate_usage
7997+
- sca_fargate_percentage
79947998
- '*'
79957999
type: string
79968000
x-enum-varnames:
@@ -8130,6 +8134,8 @@ components:
81308134
- SIEM_INGESTED_BYTES_PERCENTAGE
81318135
- WORKFLOW_EXECUTIONS_USAGE
81328136
- WORKFLOW_EXECUTIONS_PERCENTAGE
8137+
- SCA_FARGATE_USAGE
8138+
- SCA_FARGATE_PERCENTAGE
81338139
- ALL
81348140
MonthlyUsageAttributionValues:
81358141
description: Fields in Usage Summary by tag(s).
@@ -8639,6 +8645,16 @@ components:
86398645
description: The total RUM Session Replay usage by tag(s).
86408646
format: double
86418647
type: number
8648+
sca_fargate_percentage:
8649+
description: The percentage of Software Composition Analysis Fargate task
8650+
usage by tag(s).
8651+
format: double
8652+
type: number
8653+
sca_fargate_usage:
8654+
description: The total Software Composition Analysis Fargate task usage
8655+
by tag(s).
8656+
format: double
8657+
type: number
86428658
sds_scanned_bytes_percentage:
86438659
description: The percentage of Sensitive Data Scanner usage by tag(s).
86448660
format: double
@@ -19256,6 +19272,17 @@ components:
1925619272
1st, 2024).
1925719273
format: int64
1925819274
type: integer
19275+
sca_fargate_count_avg:
19276+
description: Shows the average of all Software Composition Analysis Fargate
19277+
tasks over all hours in the current date for the given org.
19278+
format: int64
19279+
type: integer
19280+
sca_fargate_count_hwm:
19281+
description: Shows the sum of the high-water marks of all Software Composition
19282+
Analysis Fargate tasks over all hours in the current date for the given
19283+
org.
19284+
format: int64
19285+
type: integer
1925919286
sds_apm_scanned_bytes_sum:
1926019287
description: Sum of all APM bytes scanned with sensitive data scanner over
1926119288
all hours in the current date for all organizations.
@@ -19964,6 +19991,17 @@ components:
1996419991
1st, 2024).
1996519992
format: int64
1996619993
type: integer
19994+
sca_fargate_count_avg:
19995+
description: Shows the average of all Software Composition Analysis Fargate
19996+
tasks over all hours in the current date for the given org.
19997+
format: int64
19998+
type: integer
19999+
sca_fargate_count_hwm:
20000+
description: Shows the sum of the high-water marks of all Software Composition
20001+
Analysis Fargate tasks over all hours in the current date for the given
20002+
org.
20003+
format: int64
20004+
type: integer
1996720005
sds_apm_scanned_bytes_sum:
1996820006
description: Sum of all APM bytes scanned with sensitive data scanner over
1996920007
all hours in the current date for the given org.
@@ -20707,6 +20745,16 @@ components:
2070720745
October 1st, 2024).
2070820746
format: int64
2070920747
type: integer
20748+
sca_fargate_count_avg_sum:
20749+
description: Shows the average of all Software Composition Analysis Fargate
20750+
tasks over all hours in the current months for all organizations.
20751+
format: int64
20752+
type: integer
20753+
sca_fargate_count_hwm_sum:
20754+
description: Shows the sum of the high-water marks of all Software Composition
20755+
Analysis Fargate tasks over all hours in the current months for all organizations.
20756+
format: int64
20757+
type: integer
2071020758
sds_apm_scanned_bytes_sum:
2071120759
description: Sum of all APM bytes scanned with sensitive data scanner in
2071220760
the current month for all organizations.

packages/datadog-api-client-v1/models/HourlyUsageAttributionUsageType.ts

+2
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ export type HourlyUsageAttributionUsageType =
7373
| typeof PROFILED_HOST_USAGE
7474
| typeof RUM_BROWSER_MOBILE_SESSIONS_USAGE
7575
| typeof RUM_REPLAY_SESSIONS_USAGE
76+
| typeof SCA_FARGATE_USAGE
7677
| typeof SDS_SCANNED_BYTES_USAGE
7778
| typeof SERVERLESS_APPS_USAGE
7879
| typeof SIEM_ANALYZED_LOGS_ADD_ON_USAGE
@@ -152,6 +153,7 @@ export const PROFILED_HOST_USAGE = "profiled_host_usage";
152153
export const RUM_BROWSER_MOBILE_SESSIONS_USAGE =
153154
"rum_browser_mobile_sessions_usage";
154155
export const RUM_REPLAY_SESSIONS_USAGE = "rum_replay_sessions_usage";
156+
export const SCA_FARGATE_USAGE = "sca_fargate_usage";
155157
export const SDS_SCANNED_BYTES_USAGE = "sds_scanned_bytes_usage";
156158
export const SERVERLESS_APPS_USAGE = "serverless_apps_usage";
157159
export const SIEM_ANALYZED_LOGS_ADD_ON_USAGE =

packages/datadog-api-client-v1/models/MonthlyUsageAttributionSupportedMetrics.ts

+4
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,8 @@ export type MonthlyUsageAttributionSupportedMetrics =
147147
| typeof SIEM_INGESTED_BYTES_PERCENTAGE
148148
| typeof WORKFLOW_EXECUTIONS_USAGE
149149
| typeof WORKFLOW_EXECUTIONS_PERCENTAGE
150+
| typeof SCA_FARGATE_USAGE
151+
| typeof SCA_FARGATE_PERCENTAGE
150152
| typeof ALL
151153
| UnparsedObject;
152154
export const API_USAGE = "api_usage";
@@ -312,4 +314,6 @@ export const SIEM_INGESTED_BYTES_USAGE = "siem_ingested_bytes_usage";
312314
export const SIEM_INGESTED_BYTES_PERCENTAGE = "siem_ingested_bytes_percentage";
313315
export const WORKFLOW_EXECUTIONS_USAGE = "workflow_executions_usage";
314316
export const WORKFLOW_EXECUTIONS_PERCENTAGE = "workflow_executions_percentage";
317+
export const SCA_FARGATE_USAGE = "sca_fargate_usage";
318+
export const SCA_FARGATE_PERCENTAGE = "sca_fargate_percentage";
315319
export const ALL = "*";

packages/datadog-api-client-v1/models/MonthlyUsageAttributionValues.ts

+18
Original file line numberDiff line numberDiff line change
@@ -490,6 +490,14 @@ export class MonthlyUsageAttributionValues {
490490
* The total RUM Session Replay usage by tag(s).
491491
*/
492492
"rumReplaySessionsUsage"?: number;
493+
/**
494+
* The percentage of Software Composition Analysis Fargate task usage by tag(s).
495+
*/
496+
"scaFargatePercentage"?: number;
497+
/**
498+
* The total Software Composition Analysis Fargate task usage by tag(s).
499+
*/
500+
"scaFargateUsage"?: number;
493501
/**
494502
* The percentage of Sensitive Data Scanner usage by tag(s).
495503
*/
@@ -1171,6 +1179,16 @@ export class MonthlyUsageAttributionValues {
11711179
type: "number",
11721180
format: "double",
11731181
},
1182+
scaFargatePercentage: {
1183+
baseName: "sca_fargate_percentage",
1184+
type: "number",
1185+
format: "double",
1186+
},
1187+
scaFargateUsage: {
1188+
baseName: "sca_fargate_usage",
1189+
type: "number",
1190+
format: "double",
1191+
},
11741192
sdsScannedBytesPercentage: {
11751193
baseName: "sds_scanned_bytes_percentage",
11761194
type: "number",

packages/datadog-api-client-v1/models/ObjectSerializer.ts

+3
Original file line numberDiff line numberDiff line change
@@ -831,6 +831,7 @@ const enumsMap: { [key: string]: any[] } = {
831831
"profiled_host_usage",
832832
"rum_browser_mobile_sessions_usage",
833833
"rum_replay_sessions_usage",
834+
"sca_fargate_usage",
834835
"sds_scanned_bytes_usage",
835836
"serverless_apps_usage",
836837
"siem_analyzed_logs_add_on_usage",
@@ -1104,6 +1105,8 @@ const enumsMap: { [key: string]: any[] } = {
11041105
"siem_ingested_bytes_percentage",
11051106
"workflow_executions_usage",
11061107
"workflow_executions_percentage",
1108+
"sca_fargate_usage",
1109+
"sca_fargate_percentage",
11071110
"*",
11081111
],
11091112
NoteWidgetDefinitionType: ["note"],

packages/datadog-api-client-v1/models/UsageSummaryDate.ts

+18
Original file line numberDiff line numberDiff line change
@@ -443,6 +443,14 @@ export class UsageSummaryDate {
443443
* Shows the sum of all browser and mobile RUM units over all hours in the current date for all organizations (To be deprecated on October 1st, 2024).
444444
*/
445445
"rumUnitsSum"?: number;
446+
/**
447+
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
448+
*/
449+
"scaFargateCountAvg"?: number;
450+
/**
451+
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
452+
*/
453+
"scaFargateCountHwm"?: number;
446454
/**
447455
* Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for all organizations.
448456
*/
@@ -1075,6 +1083,16 @@ export class UsageSummaryDate {
10751083
type: "number",
10761084
format: "int64",
10771085
},
1086+
scaFargateCountAvg: {
1087+
baseName: "sca_fargate_count_avg",
1088+
type: "number",
1089+
format: "int64",
1090+
},
1091+
scaFargateCountHwm: {
1092+
baseName: "sca_fargate_count_hwm",
1093+
type: "number",
1094+
format: "int64",
1095+
},
10781096
sdsApmScannedBytesSum: {
10791097
baseName: "sds_apm_scanned_bytes_sum",
10801098
type: "number",

packages/datadog-api-client-v1/models/UsageSummaryDateOrg.ts

+18
Original file line numberDiff line numberDiff line change
@@ -466,6 +466,14 @@ export class UsageSummaryDateOrg {
466466
* Shows the sum of all browser and mobile RUM units over all hours in the current date for the given org (To be deprecated on October 1st, 2024).
467467
*/
468468
"rumUnitsSum"?: number;
469+
/**
470+
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
471+
*/
472+
"scaFargateCountAvg"?: number;
473+
/**
474+
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current date for the given org.
475+
*/
476+
"scaFargateCountHwm"?: number;
469477
/**
470478
* Sum of all APM bytes scanned with sensitive data scanner over all hours in the current date for the given org.
471479
*/
@@ -1123,6 +1131,16 @@ export class UsageSummaryDateOrg {
11231131
type: "number",
11241132
format: "int64",
11251133
},
1134+
scaFargateCountAvg: {
1135+
baseName: "sca_fargate_count_avg",
1136+
type: "number",
1137+
format: "int64",
1138+
},
1139+
scaFargateCountHwm: {
1140+
baseName: "sca_fargate_count_hwm",
1141+
type: "number",
1142+
format: "int64",
1143+
},
11261144
sdsApmScannedBytesSum: {
11271145
baseName: "sds_apm_scanned_bytes_sum",
11281146
type: "number",

packages/datadog-api-client-v1/models/UsageSummaryResponse.ts

+18
Original file line numberDiff line numberDiff line change
@@ -480,6 +480,14 @@ export class UsageSummaryResponse {
480480
* Shows the sum of all browser and mobile RUM units over all hours in the current month for all organizations (To be deprecated on October 1st, 2024).
481481
*/
482482
"rumUnitsAggSum"?: number;
483+
/**
484+
* Shows the average of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.
485+
*/
486+
"scaFargateCountAvgSum"?: number;
487+
/**
488+
* Shows the sum of the high-water marks of all Software Composition Analysis Fargate tasks over all hours in the current months for all organizations.
489+
*/
490+
"scaFargateCountHwmSum"?: number;
483491
/**
484492
* Sum of all APM bytes scanned with sensitive data scanner in the current month for all organizations.
485493
*/
@@ -1165,6 +1173,16 @@ export class UsageSummaryResponse {
11651173
type: "number",
11661174
format: "int64",
11671175
},
1176+
scaFargateCountAvgSum: {
1177+
baseName: "sca_fargate_count_avg_sum",
1178+
type: "number",
1179+
format: "int64",
1180+
},
1181+
scaFargateCountHwmSum: {
1182+
baseName: "sca_fargate_count_hwm_sum",
1183+
type: "number",
1184+
format: "int64",
1185+
},
11681186
sdsApmScannedBytesSum: {
11691187
baseName: "sds_apm_scanned_bytes_sum",
11701188
type: "number",

0 commit comments

Comments
 (0)