Skip to content

Commit

Permalink
Standardize docs references to timeseries (#2374)
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec committed Feb 6, 2024
1 parent 70bbd46 commit b4fb840
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 22 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-02-06 09:57:30.083303",
"spec_repo_commit": "3518f3a0"
"regenerated": "2024-02-06 15:44:58.838323",
"spec_repo_commit": "46672359"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-02-06 09:57:30.098574",
"spec_repo_commit": "3518f3a0"
"regenerated": "2024-02-06 15:44:58.868035",
"spec_repo_commit": "46672359"
}
}
}
18 changes: 9 additions & 9 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6328,7 +6328,7 @@ components:
description: The metrics' payload.
properties:
series:
description: A list of time series to submit to Datadog.
description: A list of timeseries to submit to Datadog.
example:
- metric: system.load.1
points:
Expand Down Expand Up @@ -6381,7 +6381,7 @@ components:
readOnly: true
type: string
pointlist:
description: List of points of the time series in milliseconds.
description: List of points of the timeseries in milliseconds.
example:
- - 1681683300000.0
- 77.62145685254418
Expand Down Expand Up @@ -10409,7 +10409,7 @@ components:
- denominator
type: object
SLOHistoryMetricsSeries:
description: 'A representation of `metric` based SLO time series for the provided
description: 'A representation of `metric` based SLO timeseries for the provided
queries.

This is the same response type from `batch_query` endpoint.'
Expand Down Expand Up @@ -10530,18 +10530,18 @@ components:
type: string
history:
description: For `monitor` based SLOs, this includes the aggregated history
as arrays that include time series and uptime data where `0=monitor` is
as arrays that include timeseries and uptime data where `0=monitor` is
in `OK` state and `1=monitor` is in `alert` state.
example:
- - 1579212382
- 0
items:
description: Represents an array time series data.
description: Represents an array timeseries data.
example:
- 1579212382
- 0
items:
description: A time series data point which is a tuple of (timestamp,
description: A timeseries data point which is a tuple of (timestamp,
value).
format: double
type: number
Expand Down Expand Up @@ -10712,18 +10712,18 @@ components:
type: string
history:
description: For `monitor` based SLOs, this includes the aggregated history
as arrays that include time series and uptime data where `0=monitor` is
as arrays that include timeseries and uptime data where `0=monitor` is
in `OK` state and `1=monitor` is in `alert` state.
example:
- - 1579212382
- 0
items:
description: Represents an array time series data.
description: Represents an array timeseries data.
example:
- 1579212382
- 0
items:
description: A time series data point which is a tuple of (timestamp,
description: A timeseries data point which is a tuple of (timestamp,
value).
format: double
type: number
Expand Down
2 changes: 1 addition & 1 deletion .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11083,7 +11083,7 @@ components:
description: The metrics' payload.
properties:
series:
description: A list of time series to submit to Datadog.
description: A list of timeseries to submit to Datadog.
example:
- metric: system.load.1
points:
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_metrics_payload.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (

// MetricsPayload The metrics' payload.
type MetricsPayload struct {
// A list of time series to submit to Datadog.
// A list of timeseries to submit to Datadog.
Series []Series `json:"series"`
// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
UnparsedObject map[string]interface{} `json:"-"`
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_metrics_query_metadata.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ type MetricsQueryMetadata struct {
Length *int64 `json:"length,omitempty"`
// Metric name.
Metric *string `json:"metric,omitempty"`
// List of points of the time series in milliseconds.
// List of points of the timeseries in milliseconds.
Pointlist [][]*float64 `json:"pointlist,omitempty"`
// The index of the series' query within the request.
QueryIndex *int64 `json:"query_index,omitempty"`
Expand Down
4 changes: 2 additions & 2 deletions api/datadogV1/model_slo_history_metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ import (
//
// This is not included in responses for `monitor` based SLOs.
type SLOHistoryMetrics struct {
// A representation of `metric` based SLO time series for the provided queries.
// A representation of `metric` based SLO timeseries for the provided queries.
// This is the same response type from `batch_query` endpoint.
Denominator SLOHistoryMetricsSeries `json:"denominator"`
// The aggregated query interval for the series data. It's implicit based on the query time window.
Interval int64 `json:"interval"`
// Optional message if there are specific query issues/warnings.
Message *string `json:"message,omitempty"`
// A representation of `metric` based SLO time series for the provided queries.
// A representation of `metric` based SLO timeseries for the provided queries.
// This is the same response type from `batch_query` endpoint.
Numerator SLOHistoryMetricsSeries `json:"numerator"`
// The combined numerator and denominator query CSV.
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_slo_history_metrics_series.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
)

// SLOHistoryMetricsSeries A representation of `metric` based SLO time series for the provided queries.
// SLOHistoryMetricsSeries A representation of `metric` based SLO timeseries for the provided queries.
// This is the same response type from `batch_query` endpoint.
type SLOHistoryMetricsSeries struct {
// Count of submitted metrics.
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_slo_history_monitor.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ type SLOHistoryMonitor struct {
Errors []SLOHistoryResponseErrorWithType `json:"errors,omitempty"`
// For groups in a grouped SLO, this is the group name.
Group *string `json:"group,omitempty"`
// 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.
// 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.
History [][]float64 `json:"history,omitempty"`
// For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
MonitorModified *int64 `json:"monitor_modified,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV1/model_slo_history_sli_data.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ type SLOHistorySLIData struct {
Errors []SLOHistoryResponseErrorWithType `json:"errors,omitempty"`
// For groups in a grouped SLO, this is the group name.
Group *string `json:"group,omitempty"`
// 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.
// 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.
History [][]float64 `json:"history,omitempty"`
// For `monitor` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
MonitorModified *int64 `json:"monitor_modified,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion api/datadogV2/model_metric_payload.go
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import (

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

0 comments on commit b4fb840

Please sign in to comment.