Skip to content

Commit 912b015

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Standardize docs references to timeseries (#1719)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 31d5446 commit 912b015

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.488544",
8-
"spec_repo_commit": "3518f3a0"
7+
"regenerated": "2024-02-06 15:45:08.603113",
8+
"spec_repo_commit": "46672359"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-02-06 09:57:38.506381",
13-
"spec_repo_commit": "3518f3a0"
12+
"regenerated": "2024-02-06 15:45:08.619048",
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:

lib/datadog_api_client/v1/models/metrics_payload.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module DatadogAPIClient::V1
2121
class MetricsPayload
2222
include BaseGenericModel
2323

24-
# A list of time series to submit to Datadog.
24+
# A list of timeseries to submit to Datadog.
2525
attr_reader :series
2626

2727
# Attribute mapping from ruby-style variable name to JSON key.

lib/datadog_api_client/v1/models/metrics_query_metadata.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ class MetricsQueryMetadata
4242
# Metric name.
4343
attr_accessor :metric
4444

45-
# List of points of the time series in milliseconds.
45+
# List of points of the timeseries in milliseconds.
4646
attr_accessor :pointlist
4747

4848
# The index of the series' query within the request.

lib/datadog_api_client/v1/models/slo_history_metrics.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module DatadogAPIClient::V1
2323
class SLOHistoryMetrics
2424
include BaseGenericModel
2525

26-
# A representation of `metric` based SLO time series for the provided queries.
26+
# A representation of `metric` based SLO timeseries for the provided queries.
2727
# This is the same response type from `batch_query` endpoint.
2828
attr_reader :denominator
2929

@@ -33,7 +33,7 @@ class SLOHistoryMetrics
3333
# Optional message if there are specific query issues/warnings.
3434
attr_accessor :message
3535

36-
# A representation of `metric` based SLO time series for the provided queries.
36+
# A representation of `metric` based SLO timeseries for the provided queries.
3737
# This is the same response type from `batch_query` endpoint.
3838
attr_reader :numerator
3939

lib/datadog_api_client/v1/models/slo_history_metrics_series.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
require 'time'
1818

1919
module DatadogAPIClient::V1
20-
# A representation of `metric` based SLO time series for the provided queries.
20+
# A representation of `metric` based SLO timeseries for the provided queries.
2121
# This is the same response type from `batch_query` endpoint.
2222
class SLOHistoryMetricsSeries
2323
include BaseGenericModel

lib/datadog_api_client/v1/models/slo_history_monitor.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class SLOHistoryMonitor
3131
# For groups in a grouped SLO, this is the group name.
3232
attr_accessor :group
3333

34-
# 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.
34+
# 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.
3535
attr_accessor :history
3636

3737
# For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

lib/datadog_api_client/v1/models/slo_history_sli_data.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ class SLOHistorySLIData
3131
# For groups in a grouped SLO, this is the group name.
3232
attr_accessor :group
3333

34-
# 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.
34+
# 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.
3535
attr_accessor :history
3636

3737
# For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.

lib/datadog_api_client/v2/models/metric_payload.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
2121
class MetricPayload
2222
include BaseGenericModel
2323

24-
# A list of time series to submit to Datadog.
24+
# A list of timeseries to submit to Datadog.
2525
attr_reader :series
2626

2727
# Attribute mapping from ruby-style variable name to JSON key.

0 commit comments

Comments
 (0)