Skip to content

Commit b4fb840

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Standardize docs references to timeseries (#2374)
Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
1 parent 70bbd46 commit b4fb840

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:30.083303",
8-
"spec_repo_commit": "3518f3a0"
7+
"regenerated": "2024-02-06 15:44:58.838323",
8+
"spec_repo_commit": "46672359"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-02-06 09:57:30.098574",
13-
"spec_repo_commit": "3518f3a0"
12+
"regenerated": "2024-02-06 15:44:58.868035",
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:

‎api/datadogV1/model_metrics_payload.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212

1313
// MetricsPayload The metrics' payload.
1414
type MetricsPayload struct {
15-
// A list of time series to submit to Datadog.
15+
// A list of timeseries to submit to Datadog.
1616
Series []Series `json:"series"`
1717
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1818
UnparsedObject map[string]interface{} `json:"-"`

‎api/datadogV1/model_metrics_query_metadata.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ type MetricsQueryMetadata struct {
2424
Length *int64 `json:"length,omitempty"`
2525
// Metric name.
2626
Metric *string `json:"metric,omitempty"`
27-
// List of points of the time series in milliseconds.
27+
// List of points of the timeseries in milliseconds.
2828
Pointlist [][]*float64 `json:"pointlist,omitempty"`
2929
// The index of the series' query within the request.
3030
QueryIndex *int64 `json:"query_index,omitempty"`

‎api/datadogV1/model_slo_history_metrics.go‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ import (
1414
//
1515
// This is not included in responses for `monitor` based SLOs.
1616
type SLOHistoryMetrics struct {
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
Denominator SLOHistoryMetricsSeries `json:"denominator"`
2020
// The aggregated query interval for the series data. It's implicit based on the query time window.
2121
Interval int64 `json:"interval"`
2222
// Optional message if there are specific query issues/warnings.
2323
Message *string `json:"message,omitempty"`
24-
// A representation of `metric` based SLO time series for the provided queries.
24+
// A representation of `metric` based SLO timeseries for the provided queries.
2525
// This is the same response type from `batch_query` endpoint.
2626
Numerator SLOHistoryMetricsSeries `json:"numerator"`
2727
// The combined numerator and denominator query CSV.

‎api/datadogV1/model_slo_history_metrics_series.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import (
1010
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
1111
)
1212

13-
// SLOHistoryMetricsSeries A representation of `metric` based SLO time series for the provided queries.
13+
// SLOHistoryMetricsSeries A representation of `metric` based SLO timeseries for the provided queries.
1414
// This is the same response type from `batch_query` endpoint.
1515
type SLOHistoryMetricsSeries struct {
1616
// Count of submitted metrics.

‎api/datadogV1/model_slo_history_monitor.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type SLOHistoryMonitor struct {
1717
Errors []SLOHistoryResponseErrorWithType `json:"errors,omitempty"`
1818
// For groups in a grouped SLO, this is the group name.
1919
Group *string `json:"group,omitempty"`
20-
// 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.
20+
// 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.
2121
History [][]float64 `json:"history,omitempty"`
2222
// For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
2323
MonitorModified *int64 `json:"monitor_modified,omitempty"`

‎api/datadogV1/model_slo_history_sli_data.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ type SLOHistorySLIData struct {
1717
Errors []SLOHistoryResponseErrorWithType `json:"errors,omitempty"`
1818
// For groups in a grouped SLO, this is the group name.
1919
Group *string `json:"group,omitempty"`
20-
// 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.
20+
// 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.
2121
History [][]float64 `json:"history,omitempty"`
2222
// For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
2323
MonitorModified *int64 `json:"monitor_modified,omitempty"`

‎api/datadogV2/model_metric_payload.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212

1313
// MetricPayload The metrics' payload.
1414
type MetricPayload struct {
15-
// A list of time series to submit to Datadog.
15+
// A list of timeseries to submit to Datadog.
1616
Series []MetricSeries `json:"series"`
1717
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
1818
UnparsedObject map[string]interface{} `json:"-"`

0 commit comments

Comments
 (0)