Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize docs references to timeseries #1858

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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:39.026179",
"spec_repo_commit": "3518f3a0"
"regenerated": "2024-02-06 15:45:01.688361",
"spec_repo_commit": "46672359"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-02-06 09:57:39.062425",
"spec_repo_commit": "3518f3a0"
"regenerated": "2024-02-06 15:45:01.704595",
"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 src/datadog_api_client/v1/model/metrics_payload.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ def __init__(self_, series: List[Series], **kwargs):
"""
The metrics' payload.

:param series: A list of time series to submit to Datadog.
:param series: A list of timeseries to submit to Datadog.
:type series: [Series]
"""
super().__init__(kwargs)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ def __init__(
:param metric: Metric name.
:type metric: str, optional

:param pointlist: List of points of the time series in milliseconds.
:param pointlist: List of points of the timeseries in milliseconds.
:type pointlist: [Point], optional

:param query_index: The index of the series' query within the request.
Expand Down
4 changes: 2 additions & 2 deletions src/datadog_api_client/v1/model/slo_history_metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ def __init__(

This is not included in responses for ``monitor`` based SLOs.

:param denominator: A representation of ``metric`` based SLO time series for the provided queries.
:param denominator: A representation of ``metric`` based SLO timeseries for the provided queries.
This is the same response type from ``batch_query`` endpoint.
:type denominator: SLOHistoryMetricsSeries

Expand All @@ -71,7 +71,7 @@ def __init__(
:param message: Optional message if there are specific query issues/warnings.
:type message: str, optional

:param numerator: A representation of ``metric`` based SLO time series for the provided queries.
:param numerator: A representation of ``metric`` based SLO timeseries for the provided queries.
This is the same response type from ``batch_query`` endpoint.
:type numerator: SLOHistoryMetricsSeries

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ def __init__(
**kwargs,
):
"""
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.

:param count: Count of submitted metrics.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v1/model/slo_history_monitor.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def __init__(
:param group: For groups in a grouped SLO, this is the group name.
:type group: str, optional

:param history: 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.
:param history: 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.
:type history: [[float]], optional

:param monitor_modified: For ``monitor`` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v1/model/slo_history_sli_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def __init__(
:param group: For groups in a grouped SLO, this is the group name.
:type group: str, optional

:param history: 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.
:param history: 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.
:type history: [[float]], optional

:param monitor_modified: For ``monitor`` based SLOs, this is the last modified timestamp in epoch seconds of the monitor.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/model/metric_payload.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ def __init__(self_, series: List[MetricSeries], **kwargs):
"""
The metrics' payload.

:param series: A list of time series to submit to Datadog.
:param series: A list of timeseries to submit to Datadog.
:type series: [MetricSeries]
"""
super().__init__(kwargs)
Expand Down
Loading