Skip to content

Commit fd367b2

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Standardize docs references to timeseries (#1509)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 857963b commit fd367b2

File tree

10 files changed

+22
-22
lines changed

10 files changed

+22
-22
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": "2024-02-06 09:57:38.258085",
8-
"spec_repo_commit": "3518f3a0"
7+
"regenerated": "2024-02-06 15:44:58.457905",
8+
"spec_repo_commit": "46672359"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-02-06 09:57:38.278952",
13-
"spec_repo_commit": "3518f3a0"
12+
"regenerated": "2024-02-06 15:44:58.472215",
13+
"spec_repo_commit": "46672359"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6328,7 +6328,7 @@ components:
63286328
description: The metrics' payload.
63296329
properties:
63306330
series:
6331-
description: A list of time series to submit to Datadog.
6331+
description: A list of timeseries to submit to Datadog.
63326332
example:
63336333
- metric: system.load.1
63346334
points:
@@ -6381,7 +6381,7 @@ components:
63816381
readOnly: true
63826382
type: string
63836383
pointlist:
6384-
description: List of points of the time series in milliseconds.
6384+
description: List of points of the timeseries in milliseconds.
63856385
example:
63866386
- - 1681683300000.0
63876387
- 77.62145685254418
@@ -10409,7 +10409,7 @@ components:
1040910409
- denominator
1041010410
type: object
1041110411
SLOHistoryMetricsSeries:
10412-
description: 'A representation of `metric` based SLO time series for the provided
10412+
description: 'A representation of `metric` based SLO timeseries for the provided
1041310413
queries.
1041410414

1041510415
This is the same response type from `batch_query` endpoint.'
@@ -10530,18 +10530,18 @@ components:
1053010530
type: string
1053110531
history:
1053210532
description: For `monitor` based SLOs, this includes the aggregated history
10533-
as arrays that include time series and uptime data where `0=monitor` is
10533+
as arrays that include timeseries and uptime data where `0=monitor` is
1053410534
in `OK` state and `1=monitor` is in `alert` state.
1053510535
example:
1053610536
- - 1579212382
1053710537
- 0
1053810538
items:
10539-
description: Represents an array time series data.
10539+
description: Represents an array timeseries data.
1054010540
example:
1054110541
- 1579212382
1054210542
- 0
1054310543
items:
10544-
description: A time series data point which is a tuple of (timestamp,
10544+
description: A timeseries data point which is a tuple of (timestamp,
1054510545
value).
1054610546
format: double
1054710547
type: number
@@ -10712,18 +10712,18 @@ components:
1071210712
type: string
1071310713
history:
1071410714
description: For `monitor` based SLOs, this includes the aggregated history
10715-
as arrays that include time series and uptime data where `0=monitor` is
10715+
as arrays that include timeseries and uptime data where `0=monitor` is
1071610716
in `OK` state and `1=monitor` is in `alert` state.
1071710717
example:
1071810718
- - 1579212382
1071910719
- 0
1072010720
items:
10721-
description: Represents an array time series data.
10721+
description: Represents an array timeseries data.
1072210722
example:
1072310723
- 1579212382
1072410724
- 0
1072510725
items:
10726-
description: A time series data point which is a tuple of (timestamp,
10726+
description: A timeseries data point which is a tuple of (timestamp,
1072710727
value).
1072810728
format: double
1072910729
type: number

.generator/schemas/v2/openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11083,7 +11083,7 @@ components:
1108311083
description: The metrics' payload.
1108411084
properties:
1108511085
series:
11086-
description: A list of time series to submit to Datadog.
11086+
description: A list of timeseries to submit to Datadog.
1108711087
example:
1108811088
- metric: system.load.1
1108911089
points:

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1212
*/
1313
export class MetricsPayload {
1414
/**
15-
* A list of time series to submit to Datadog.
15+
* A list of timeseries to submit to Datadog.
1616
*/
1717
"series": Array<Series>;
1818

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ export class MetricsQueryMetadata {
4040
*/
4141
"metric"?: string;
4242
/**
43-
* List of points of the time series in milliseconds.
43+
* List of points of the timeseries in milliseconds.
4444
*/
4545
"pointlist"?: Array<[number, number]>;
4646
/**

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1414
*/
1515
export class SLOHistoryMetrics {
1616
/**
17-
* A representation of `metric` based SLO time series for the provided queries.
17+
* A representation of `metric` based SLO timeseries for the provided queries.
1818
* This is the same response type from `batch_query` endpoint.
1919
*/
2020
"denominator": SLOHistoryMetricsSeries;
@@ -27,7 +27,7 @@ export class SLOHistoryMetrics {
2727
*/
2828
"message"?: string;
2929
/**
30-
* A representation of `metric` based SLO time series for the provided queries.
30+
* A representation of `metric` based SLO timeseries for the provided queries.
3131
* This is the same response type from `batch_query` endpoint.
3232
*/
3333
"numerator": SLOHistoryMetricsSeries;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { SLOHistoryMetricsSeriesMetadata } from "./SLOHistoryMetricsSeriesMetada
88
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
99

1010
/**
11-
* A representation of `metric` based SLO time series for the provided queries.
11+
* A representation of `metric` based SLO timeseries for the provided queries.
1212
* This is the same response type from `batch_query` endpoint.
1313
*/
1414
export class SLOHistoryMetricsSeries {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export class SLOHistoryMonitor {
2525
*/
2626
"group"?: string;
2727
/**
28-
* For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
28+
* For `monitor` based SLOs, this includes the aggregated history as arrays that include timeseries and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
2929
*/
3030
"history"?: Array<[number, number]>;
3131
/**

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ export class SLOHistorySLIData {
2525
*/
2626
"group"?: string;
2727
/**
28-
* For `monitor` based SLOs, this includes the aggregated history as arrays that include time series and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
28+
* For `monitor` based SLOs, this includes the aggregated history as arrays that include timeseries and uptime data where `0=monitor` is in `OK` state and `1=monitor` is in `alert` state.
2929
*/
3030
"history"?: Array<[number, number]>;
3131
/**

packages/datadog-api-client-v2/models/MetricPayload.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1212
*/
1313
export class MetricPayload {
1414
/**
15-
* A list of time series to submit to Datadog.
15+
* A list of timeseries to submit to Datadog.
1616
*/
1717
"series": Array<MetricSeries>;
1818

0 commit comments

Comments
 (0)