datadog_api_client 1.1.0 → 1.2.0

data/docs/v1/ResponseMetaAttributes.md

@@ -0,0 +1,18 @@
+# DatadogAPIClient::V1::ResponseMetaAttributes
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | [**Pagination**](Pagination.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'datadog_api_client/v1'
+
+instance = DatadogAPIClient::V1::ResponseMetaAttributes.new(
+  page: null
+)
+```
+

data/docs/v1/SLOCorrectionListResponse.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **data** | [**Array<SLOCorrection>**](SLOCorrection.md) | The list of of SLO corrections objects | [optional] |
+| **meta** | [**ResponseMetaAttributes**](ResponseMetaAttributes.md) |  | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'datadog_api_client/v1'
 
 instance = DatadogAPIClient::V1::SLOCorrectionListResponse.new(
-  data: null
+  data: null,
+  meta: null
 )
 ```
 

data/docs/v1/SLOHistoryMetricsSeriesMetadata.md

@@ -22,7 +22,7 @@ instance = DatadogAPIClient::V1::SLOHistoryMetricsSeriesMetadata.new(
   metric: null,
   query_index: null,
   scope: null,
-  unit: [{"family":"bytes","scale_factor":1.0,"name":"byte","short_name":"B","plural":"bytes","id":2},null]
+  unit: [{"family":"bytes","id":2,"name":"byte","plural":"bytes","scale_factor":1.0,"short_name":"B"},null]
 )
 ```
 

data/docs/v1/ServiceChecksAPI.md

@@ -11,9 +11,9 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <IntakePayloadAccepted> submit_service_check(body)
 
-Submit a Service Check
+Submit a list of Service Checks.
 
-Submit a list of Service Checks.  **Note**: A valid API key is required.
+**Note**: A valid API key is required.
 
 ### Examples
 

data/docs/v1/ServiceLevelObjectiveCorrectionsAPI.md

@@ -15,8 +15,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <SLOCorrectionResponse> create_slo_correction(body)
 
-Create an SLO correction
-
 Create an SLO Correction
 
 ### Examples
@@ -82,8 +80,6 @@ end
 
 > delete_slo_correction(slo_correction_id)
 
-Delete an SLO correction
-
 Permanently delete the specified SLO correction object
 
 ### Examples
@@ -148,8 +144,6 @@ nil (empty response body)
 
 > <SLOCorrectionResponse> get_slo_correction(slo_correction_id)
 
-Get an SLO correction for an SLO
-
 Get an SLO correction
 
 ### Examples
@@ -215,8 +209,6 @@ end
 
 > <SLOCorrectionListResponse> list_slo_correction
 
-Get all SLO corrections
-
 Get all Service Level Objective corrections
 
 ### Examples
@@ -279,8 +271,6 @@ This endpoint does not need any parameter.
 
 > <SLOCorrectionResponse> update_slo_correction(slo_correction_id, body)
 
-Update an SLO correction
-
 Update the specified SLO correction object object
 
 ### Examples

data/docs/v1/ServiceLevelObjectivesAPI.md

@@ -18,9 +18,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <CheckCanDeleteSLOResponse> check_can_delete_slo(ids)
 
-Check if SLOs can be safely deleted
-
-Check if an SLO can be safely deleted. For example, assure an SLO can be deleted without disrupting a dashboard.
+Check if an SLO can be safely deleted. For example,
+assure an SLO can be deleted without disrupting a dashboard.
 
 ### Examples
 
@@ -80,8 +79,6 @@ end
 
 > <SLOListResponse> create_slo(body)
 
-Create an SLO object
-
 Create a service level objective object.
 
 ### Examples
@@ -142,9 +139,10 @@ end
 
 > <SLODeleteResponse> delete_slo(slo_id, opts)
 
-Delete an SLO
+Permanently delete the specified service level objective object.
 
-Permanently delete the specified service level objective object.  If an SLO is used in a dashboard, the `DELETE /v1/slo/` endpoint returns a 409 conflict error because the SLO is referenced in a dashboard.
+If an SLO is used in a dashboard, the `DELETE /v1/slo/` endpoint returns
+a 409 conflict error because the SLO is referenced in a dashboard.
 
 ### Examples
 
@@ -208,9 +206,11 @@ end
 
 > <SLOBulkDeleteResponse> delete_slo_timeframe_in_bulk(body)
 
-Bulk Delete SLO Timeframes
+Delete (or partially delete) multiple service level objective objects.
 
-Delete (or partially delete) multiple service level objective objects.  This endpoint facilitates deletion of one or more thresholds for one or more service level objective objects. If all thresholds are deleted, the service level objective object is deleted as well.
+This endpoint facilitates deletion of one or more thresholds for one or more
+service level objective objects. If all thresholds are deleted, the service level
+objective object is deleted as well.
 
 ### Examples
 
@@ -270,8 +270,6 @@ end
 
 > <SLOResponse> get_slo(slo_id, opts)
 
-Get an SLO's details
-
 Get a service level objective object.
 
 ### Examples
@@ -336,9 +334,14 @@ end
 
 > <SLOHistoryResponse> get_slo_history(slo_id, from_ts, to_ts, opts)
 
-Get an SLO's history
+Get a specific SLO’s history, regardless of its SLO type.
 
-Get a specific SLO’s history, regardless of its SLO type.  The detailed history data is structured according to the source data type. For example, metric data is included for event SLOs that use the metric source, and monitor SLO types include the monitor transition history.  **Note:** There are different response formats for event based and time based SLOs. Examples of both are shown.
+The detailed history data is structured according to the source data type.
+For example, metric data is included for event SLOs that use
+the metric source, and monitor SLO types include the monitor transition history.
+
+**Note:** There are different response formats for event based and time based SLOs.
+Examples of both are shown.
 
 ### Examples
 
@@ -354,7 +357,7 @@ slo_id = 'slo_id_example' # String | The ID of the service level objective objec
 from_ts = 789 # Integer | The `from` timestamp for the query window in epoch seconds.
 to_ts = 789 # Integer | The `to` timestamp for the query window in epoch seconds.
 opts = {
-  target: 1.2 # Float | The SLO target. If `target` is passed in, the response will include the error budget that remains.
+  target: 1.2 # Float | The SLO target. If `target` is passed in, the response will include the remaining error budget and a timeframe value of `custom`.
 }
 
 begin
@@ -391,7 +394,7 @@ end
 | **slo_id** | **String** | The ID of the service level objective object. |  |
 | **from_ts** | **Integer** | The &#x60;from&#x60; timestamp for the query window in epoch seconds. |  |
 | **to_ts** | **Integer** | The &#x60;to&#x60; timestamp for the query window in epoch seconds. |  |
-| **target** | **Float** | The SLO target. If &#x60;target&#x60; is passed in, the response will include the error budget that remains. | [optional] |
+| **target** | **Float** | The SLO target. If &#x60;target&#x60; is passed in, the response will include the remaining error budget and a timeframe value of &#x60;custom&#x60;. | [optional] |
 
 ### Return type
 
@@ -411,8 +414,6 @@ end
 
 > <SLOListResponse> list_slos(opts)
 
-Get all SLOs
-
 Get a list of service level objective objects for your organization.
 
 ### Examples
@@ -424,7 +425,9 @@ opts = {
   ids: 'id1, id2, id3', # String | A comma separated list of the IDs of the service level objectives objects.
   query: 'monitor', # String | The query string to filter results based on SLO names.
   tags_query: 'env:prod', # String | The query string to filter results based on a single SLO tag.
-  metrics_query: 'aws.elb.request_count' # String | The query string to filter results based on SLO numerator and denominator.
+  metrics_query: 'aws.elb.request_count', # String | The query string to filter results based on SLO numerator and denominator.
+  limit: 789, # Integer | The number of SLOs to return in the response.
+  offset: 789 # Integer | The specific offset to use as the beginning of the returned response.
 }
 
 begin
@@ -462,6 +465,8 @@ end
 | **query** | **String** | The query string to filter results based on SLO names. | [optional] |
 | **tags_query** | **String** | The query string to filter results based on a single SLO tag. | [optional] |
 | **metrics_query** | **String** | The query string to filter results based on SLO numerator and denominator. | [optional] |
+| **limit** | **Integer** | The number of SLOs to return in the response. | [optional] |
+| **offset** | **Integer** | The specific offset to use as the beginning of the returned response. | [optional] |
 
 ### Return type
 
@@ -481,8 +486,6 @@ end
 
 > <SLOListResponse> update_slo(slo_id, body)
 
-Update an SLO
-
 Update the specified service level objective object.
 
 ### Examples

data/docs/v1/SlackIntegrationAPI.md

@@ -15,8 +15,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <SlackIntegrationChannel> create_slack_integration_channel(account_name, body)
 
-Create a Slack integration channel
-
 Add a channel to your Datadog-Slack integration.
 
 ### Examples
@@ -79,8 +77,6 @@ end
 
 > <SlackIntegrationChannel> get_slack_integration_channel(account_name, channel_name)
 
-Get a Slack integration channel
-
 Get a channel configured for your Datadog-Slack integration.
 
 ### Examples
@@ -143,8 +139,6 @@ end
 
 > <Array<SlackIntegrationChannel>> get_slack_integration_channels(account_name)
 
-Get all channels in a Slack integration
-
 Get a list of all channels configured for your Datadog-Slack integration.
 
 ### Examples
@@ -205,8 +199,6 @@ end
 
 > remove_slack_integration_channel(account_name, channel_name)
 
-Remove a Slack integration channel
-
 Remove a channel from your Datadog-Slack integration.
 
 ### Examples
@@ -268,8 +260,6 @@ nil (empty response body)
 
 > <SlackIntegrationChannel> update_slack_integration_channel(account_name, channel_name, body)
 
-Update a Slack integration channel
-
 Update a channel used in your Datadog-Slack integration.
 
 ### Examples

data/docs/v1/SnapshotsAPI.md

@@ -11,9 +11,8 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <GraphSnapshot> get_graph_snapshot(start, _end, opts)
 
-Take graph snapshots
-
-Take graph snapshots. **Note**: When a snapshot is created, there is some delay before it is available.
+Take graph snapshots.
+**Note**: When a snapshot is created, there is some delay before it is available.
 
 ### Examples
 

data/docs/v1/SyntheticsAPI.md

@@ -35,8 +35,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <SyntheticsGlobalVariable> create_global_variable(body)
 
-Create a global variable
-
 Create a Synthetics global variable.
 
 ### Examples
@@ -97,8 +95,6 @@ end
 
 > <SyntheticsPrivateLocationCreationResponse> create_private_location(body)
 
-Create a private location
-
 Create a new Synthetics private location.
 
 ### Examples
@@ -159,8 +155,6 @@ end
 
 > <SyntheticsAPITest> create_synthetics_api_test(body)
 
-Create an API test
-
 Create a Synthetic API test.
 
 ### Examples
@@ -221,8 +215,6 @@ end
 
 > <SyntheticsBrowserTest> create_synthetics_browser_test(body)
 
-Create a browser test
-
 Create a Synthetic browser test.
 
 ### Examples
@@ -283,8 +275,6 @@ end
 
 > delete_global_variable(variable_id)
 
-Delete a global variable
-
 Delete a Synthetics global variable.
 
 ### Examples
@@ -344,8 +334,6 @@ nil (empty response body)
 
 > delete_private_location(location_id)
 
-Delete a private location
-
 Delete a Synthetics private location.
 
 ### Examples
@@ -405,8 +393,6 @@ nil (empty response body)
 
 > <SyntheticsDeleteTestsResponse> delete_tests(body)
 
-Delete tests
-
 Delete multiple Synthetic tests by ID.
 
 ### Examples
@@ -467,8 +453,6 @@ end
 
 > <SyntheticsGlobalVariable> edit_global_variable(variable_id, body)
 
-Edit a global variable
-
 Edit a Synthetics global variable.
 
 ### Examples
@@ -531,9 +515,8 @@ end
 
 > <SyntheticsAPITest> get_api_test(public_id)
 
-Get an API test
-
-Get the detailed configuration associated with a Synthetic API test.
+Get the detailed configuration associated with
+a Synthetic API test.
 
 ### Examples
 
@@ -593,8 +576,6 @@ end
 
 > <SyntheticsGetAPITestLatestResultsResponse> get_api_test_latest_results(public_id, opts)
 
-Get an API test's latest results summaries
-
 Get the last 50 test results summaries for a given Synthetics API test.
 
 ### Examples
@@ -663,8 +644,6 @@ end
 
 > <SyntheticsAPITestResultFull> get_api_test_result(public_id, result_id)
 
-Get an API test result
-
 Get a specific full result from a given (API) Synthetic test.
 
 ### Examples
@@ -727,9 +706,8 @@ end
 
 > <SyntheticsBrowserTest> get_browser_test(public_id)
 
-Get a browser test
-
-Get the detailed configuration (including steps) associated with a Synthetic browser test.
+Get the detailed configuration (including steps) associated with
+a Synthetic browser test.
 
 ### Examples
 
@@ -789,8 +767,6 @@ end
 
 > <SyntheticsGetBrowserTestLatestResultsResponse> get_browser_test_latest_results(public_id, opts)
 
-Get a browser test's latest results summaries
-
 Get the last 50 test results summaries for a given Synthetics Browser test.
 
 ### Examples
@@ -859,8 +835,6 @@ end
 
 > <SyntheticsBrowserTestResultFull> get_browser_test_result(public_id, result_id)
 
-Get a browser test result
-
 Get a specific full result from a given (browser) Synthetic test.
 
 ### Examples
@@ -923,8 +897,6 @@ end
 
 > <SyntheticsGlobalVariable> get_global_variable(variable_id)
 
-Get a global variable
-
 Get the detailed configuration of a global variable.
 
 ### Examples
@@ -985,8 +957,6 @@ end
 
 > <SyntheticsPrivateLocation> get_private_location(location_id)
 
-Get a private location
-
 Get a Synthetics private location.
 
 ### Examples
@@ -1047,8 +1017,6 @@ end
 
 > <SyntheticsTestDetails> get_test(public_id)
 
-Get a test configuration
-
 Get the detailed configuration associated with a Synthetics test.
 
 ### Examples
@@ -1109,8 +1077,6 @@ end
 
 > <SyntheticsListGlobalVariablesResponse> list_global_variables
 
-Get all global variables
-
 Get the list of all Synthetics global variables.
 
 ### Examples
@@ -1168,9 +1134,8 @@ This endpoint does not need any parameter.
 
 > <SyntheticsLocations> list_locations
 
-Get all locations (public and private)
-
-Get the list of public and private locations available for Synthetic tests. No arguments required.
+Get the list of public and private locations available for Synthetic
+tests. No arguments required.
 
 ### Examples
 
@@ -1227,8 +1192,6 @@ This endpoint does not need any parameter.
 
 > <SyntheticsListTestsResponse> list_tests
 
-Get the list of all tests
-
 Get the list of all Synthetic tests.
 
 ### Examples
@@ -1286,8 +1249,6 @@ This endpoint does not need any parameter.
 
 > <SyntheticsTriggerCITestsResponse> trigger_ci_tests(body)
 
-Trigger tests from CI/CD pipelines
-
 Trigger a set of Synthetics tests for continuous integration.
 
 ### Examples
@@ -1348,8 +1309,6 @@ end
 
 > <SyntheticsAPITest> update_api_test(public_id, body)
 
-Edit an API test
-
 Edit the configuration of a Synthetic API test.
 
 ### Examples
@@ -1412,8 +1371,6 @@ end
 
 > <SyntheticsBrowserTest> update_browser_test(public_id, body)
 
-Edit a browser test
-
 Edit the configuration of a Synthetic browser test.
 
 ### Examples
@@ -1476,8 +1433,6 @@ end
 
 > <SyntheticsPrivateLocation> update_private_location(location_id, body)
 
-Edit a private location
-
 Edit a Synthetics private location.
 
 ### Examples
@@ -1540,8 +1495,6 @@ end
 
 > Boolean update_test_pause_status(public_id, body)
 
-Pause or start a test
-
 Pause or start a Synthetics test by changing the status.
 
 ### Examples