datadog_api_client 1.1.0 → 1.2.0

data/docs/v1/UsersAPI.md

@@ -15,9 +15,10 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <UserResponse> create_user(body)
 
-Create a user
+Create a user for your organization.
 
-Create a user for your organization.  **Note**: Users can only be created with the admin access role if application keys belong to administrators.
+**Note**: Users can only be created with the admin access role
+if application keys belong to administrators.
 
 ### Examples
 
@@ -77,9 +78,10 @@ end
 
 > <UserDisableResponse> disable_user(user_handle)
 
-Disable a user
+Delete a user from an organization.
 
-Delete a user from an organization.  **Note**: This endpoint can only be used with application keys belonging to administrators.
+**Note**: This endpoint can only be used with application keys belonging to
+administrators.
 
 ### Examples
 
@@ -139,8 +141,6 @@ end
 
 > <UserResponse> get_user(user_handle)
 
-Get user details
-
 Get a user's details.
 
 ### Examples
@@ -201,8 +201,6 @@ end
 
 > <UserListResponse> list_users
 
-List all users
-
 List all users for your organization.
 
 ### Examples
@@ -260,9 +258,9 @@ This endpoint does not need any parameter.
 
 > <UserResponse> update_user(user_handle, body)
 
-Update a user
+Update a user information.
 
-Update a user information.  **Note**: It can only be used with application keys belonging to administrators.
+**Note**: It can only be used with application keys belonging to administrators.
 
 ### Examples
 

data/docs/v1/WidgetDefinition.md

@@ -38,7 +38,8 @@ DatadogAPIClient::V1::WidgetDefinition.openapi_one_of
 #   :'ServiceSummaryWidgetDefinition',
 #   :'TableWidgetDefinition',
 #   :'TimeseriesWidgetDefinition',
-#   :'ToplistWidgetDefinition'
+#   :'ToplistWidgetDefinition',
+#   :'TreeMapWidgetDefinition'
 # ]
 ```
 
@@ -91,5 +92,6 @@ DatadogAPIClient::V1::WidgetDefinition.build(data_that_doesnt_match)
 - `TableWidgetDefinition`
 - `TimeseriesWidgetDefinition`
 - `ToplistWidgetDefinition`
+- `TreeMapWidgetDefinition`
 - `nil` (if no type matches)
 

data/docs/v2/DashboardListsAPI.md

@@ -14,8 +14,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <DashboardListAddItemsResponse> create_dashboard_list_items(dashboard_list_id, body)
 
-Add Items to a Dashboard List
-
 Add dashboards to an existing dashboard list.
 
 ### Examples
@@ -78,8 +76,6 @@ end
 
 > <DashboardListDeleteItemsResponse> delete_dashboard_list_items(dashboard_list_id, body)
 
-Delete items from a dashboard list
-
 Delete dashboards from an existing dashboard list.
 
 ### Examples
@@ -142,8 +138,6 @@ end
 
 > <DashboardListItems> get_dashboard_list_items(dashboard_list_id)
 
-Get items of a Dashboard List
-
 Fetch the dashboard list’s dashboard definitions.
 
 ### Examples
@@ -204,8 +198,6 @@ end
 
 > <DashboardListUpdateItemsResponse> update_dashboard_list_items(dashboard_list_id, body)
 
-Update items of a dashboard list
-
 Update dashboards of an existing dashboard list.
 
 ### Examples

data/docs/v2/IncidentServicesAPI.md

@@ -15,8 +15,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <IncidentServiceResponse> create_incident_service(body)
 
-Create a new incident service
-
 Creates a new incident service.
 
 ### Examples
@@ -82,8 +80,6 @@ end
 
 > delete_incident_service(service_id)
 
-Delete an existing incident service
-
 Deletes an existing incident service.
 
 ### Examples
@@ -148,9 +144,8 @@ nil (empty response body)
 
 > <IncidentServiceResponse> get_incident_service(service_id, opts)
 
-Get details of an incident service
-
-Get details of an incident service. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services.
+Get details of an incident service. If the `include[users]` query parameter is provided,
+the included attribute will contain the users related to these incident services.
 
 ### Examples
 
@@ -219,8 +214,6 @@ end
 
 > <IncidentServicesResponse> list_incident_services(opts)
 
-Get a list of all incident services
-
 Get all incident services uploaded for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident services.
 
 ### Examples
@@ -294,8 +287,6 @@ end
 
 > <IncidentServiceResponse> update_incident_service(service_id, body)
 
-Update an existing incident service
-
 Updates an existing incident service. Only provide the attributes which should be updated as this request is a partial update.
 
 ### Examples

data/docs/v2/IncidentTeamsAPI.md

@@ -15,8 +15,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <IncidentTeamResponse> create_incident_team(body)
 
-Create a new incident team
-
 Creates a new incident team.
 
 ### Examples
@@ -82,8 +80,6 @@ end
 
 > delete_incident_team(team_id)
 
-Delete an existing incident team
-
 Deletes an existing incident team.
 
 ### Examples
@@ -148,9 +144,8 @@ nil (empty response body)
 
 > <IncidentTeamResponse> get_incident_team(team_id, opts)
 
-Get details of an incident team
-
-Get details of an incident team. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams.
+Get details of an incident team. If the `include[users]` query parameter is provided,
+the included attribute will contain the users related to these incident teams.
 
 ### Examples
 
@@ -219,8 +214,6 @@ end
 
 > <IncidentTeamsResponse> list_incident_teams(opts)
 
-Get a list of all incident teams
-
 Get all incident teams for the requesting user's organization. If the `include[users]` query parameter is provided, the included attribute will contain the users related to these incident teams.
 
 ### Examples
@@ -294,8 +287,6 @@ end
 
 > <IncidentTeamResponse> update_incident_team(team_id, body)
 
-Update an existing incident team
-
 Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update.
 
 ### Examples

data/docs/v2/IncidentsAPI.md

@@ -15,8 +15,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <IncidentResponse> create_incident(body)
 
-Create an incident
-
 Create an incident.
 
 ### Examples
@@ -82,8 +80,6 @@ end
 
 > delete_incident(incident_id)
 
-Delete an existing incident
-
 Deletes an existing incident from the users organization.
 
 ### Examples
@@ -148,8 +144,6 @@ nil (empty response body)
 
 > <IncidentResponse> get_incident(incident_id, opts)
 
-Get the details of an incident
-
 Get the details of an incident by `incident_id`.
 
 ### Examples
@@ -219,8 +213,6 @@ end
 
 > <IncidentsResponse> list_incidents(opts)
 
-Get a list of incidents
-
 Get all incidents for the user's organization.
 
 ### Examples
@@ -292,8 +284,6 @@ end
 
 > <IncidentResponse> update_incident(incident_id, body)
 
-Update an existing incident
-
 Updates an incident. Provide only the attributes that should be updated as this request is a partial update.
 
 ### Examples

data/docs/v2/KeyManagementAPI.md

@@ -10,6 +10,7 @@ All URIs are relative to *https://api.datadoghq.com*
 | [**delete_application_key**](KeyManagementAPI.md#delete_application_key) | **DELETE** /api/v2/application_keys/{app_key_id} | Delete an application key |
 | [**delete_current_user_application_key**](KeyManagementAPI.md#delete_current_user_application_key) | **DELETE** /api/v2/current_user/application_keys/{app_key_id} | Delete an application key owned by current user |
 | [**get_api_key**](KeyManagementAPI.md#get_api_key) | **GET** /api/v2/api_keys/{api_key_id} | Get API key |
+| [**get_application_key**](KeyManagementAPI.md#get_application_key) | **GET** /api/v2/application_keys/{app_key_id} | Get an application key |
 | [**get_current_user_application_key**](KeyManagementAPI.md#get_current_user_application_key) | **GET** /api/v2/current_user/application_keys/{app_key_id} | Get one application key owned by current user |
 | [**list_api_keys**](KeyManagementAPI.md#list_api_keys) | **GET** /api/v2/api_keys | Get all API keys |
 | [**list_application_keys**](KeyManagementAPI.md#list_application_keys) | **GET** /api/v2/application_keys | Get all application keys |
@@ -23,8 +24,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <APIKeyResponse> create_api_key(body)
 
-Create an API key
-
 Create an API key.
 
 ### Examples
@@ -87,8 +86,6 @@ end
 
 Create an application key for current user
 
-Create an application key for current user
-
 ### Examples
 
 ```ruby
@@ -147,8 +144,6 @@ end
 
 > delete_api_key(api_key_id)
 
-Delete an API key
-
 Delete an API key.
 
 ### Examples
@@ -210,8 +205,6 @@ nil (empty response body)
 
 Delete an application key
 
-Delete an application key
-
 ### Examples
 
 ```ruby
@@ -271,8 +264,6 @@ nil (empty response body)
 
 Delete an application key owned by current user
 
-Delete an application key owned by current user
-
 ### Examples
 
 ```ruby
@@ -330,8 +321,6 @@ nil (empty response body)
 
 > <APIKeyResponse> get_api_key(api_key_id, opts)
 
-Get API key
-
 Get an API key.
 
 ### Examples
@@ -392,12 +381,74 @@ end
 - **Accept**: application/json
 
 
+## get_application_key
+
+> <ApplicationKeyResponse> get_application_key(app_key_id, opts)
+
+Get an application key for your org.
+
+### Examples
+
+```ruby
+require 'datadog_api_client'
+api_instance = DatadogAPIClient::V2::KeyManagementAPI.new
+app_key_id = 'app_key_id_example' # String | The ID of the application key.
+opts = {
+  include: 'owned_by' # String | Resource path for related resources to include in the response. Only `owned_by` is supported.
+}
+
+begin
+  # Get an application key
+  result = api_instance.get_application_key(app_key_id, opts)
+  p result
+rescue DatadogAPIClient::V2::APIError => e
+  puts "Error when calling KeyManagementAPI->get_application_key: #{e}"
+end
+```
+
+#### Using the get_application_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ApplicationKeyResponse>, Integer, Hash)> get_application_key_with_http_info(app_key_id, opts)
+
+```ruby
+begin
+  # Get an application key
+  data, status_code, headers = api_instance.get_application_key_with_http_info(app_key_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ApplicationKeyResponse>
+rescue DatadogAPIClient::V2::APIError => e
+  puts "Error when calling KeyManagementAPI->get_application_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_key_id** | **String** | The ID of the application key. |  |
+| **include** | **String** | Resource path for related resources to include in the response. Only &#x60;owned_by&#x60; is supported. | [optional] |
+
+### Return type
+
+[**ApplicationKeyResponse**](ApplicationKeyResponse.md)
+
+### Authorization
+
+[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_current_user_application_key
 
 > <ApplicationKeyResponse> get_current_user_application_key(app_key_id)
 
-Get one application key owned by current user
-
 Get an application key owned by current user
 
 ### Examples
@@ -458,8 +509,6 @@ end
 
 > <APIKeysResponse> list_api_keys(opts)
 
-Get all API keys
-
 List all API keys available for your account.
 
 ### Examples
@@ -538,8 +587,6 @@ end
 
 > <ListApplicationKeysResponse> list_application_keys(opts)
 
-Get all application keys
-
 List all application keys available for your org
 
 ### Examples
@@ -612,8 +659,6 @@ end
 
 > <ListApplicationKeysResponse> list_current_user_application_keys(opts)
 
-Get all application keys owned by current user
-
 List all application keys available for current user
 
 ### Examples
@@ -686,8 +731,6 @@ end
 
 > <APIKeyResponse> update_api_key(api_key_id, body)
 
-Edit an API key
-
 Update an API key.
 
 ### Examples
@@ -752,8 +795,6 @@ end
 
 Edit an application key
 
-Edit an application key
-
 ### Examples
 
 ```ruby
@@ -816,8 +857,6 @@ end
 
 Edit an application key owned by current user
 
-Edit an application key owned by current user
-
 ### Examples
 
 ```ruby

data/docs/v2/LogsAPI.md

@@ -13,8 +13,6 @@ All URIs are relative to *https://api.datadoghq.com*
 
 > <LogsAggregateResponse> aggregate_logs(body)
 
-Aggregate events
-
 The API endpoint to aggregate events into buckets and compute metrics and timeseries.
 
 ### Examples
@@ -75,9 +73,17 @@ end
 
 > <LogsListResponse> list_logs(opts)
 
-Search logs
+List endpoint returns logs that match a log search query.
+[Results are paginated][1].
+
+Use this endpoint to build complex logs filtering and search.
+
+**If you are considering archiving logs for your organization,
+consider use of the Datadog archive capabilities instead of the log list API.
+See [Datadog Logs Archive documentation][2].**
 
-List endpoint returns logs that match a log search query. [Results are paginated][1].  Use this endpoint to build complex logs filtering and search.  **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].**  [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
+[1]: /logs/guide/collect-multiple-logs-with-pagination
+[2]: https://docs.datadoghq.com/logs/archives
 
 ### Examples
 
@@ -139,9 +145,17 @@ end
 
 > <LogsListResponse> list_logs_get(opts)
 
-Get a list of logs
+List endpoint returns logs that match a log search query.
+[Results are paginated][1].
+
+Use this endpoint to see your latest logs.
+
+**If you are considering archiving logs for your organization,
+consider use of the Datadog archive capabilities instead of the log list API.
+See [Datadog Logs Archive documentation][2].**
 
-List endpoint returns logs that match a log search query. [Results are paginated][1].  Use this endpoint to see your latest logs.  **If you are considering archiving logs for your organization, consider use of the Datadog archive capabilities instead of the log list API. See [Datadog Logs Archive documentation][2].**  [1]: /logs/guide/collect-multiple-logs-with-pagination [2]: https://docs.datadoghq.com/logs/archives
+[1]: /logs/guide/collect-multiple-logs-with-pagination
+[2]: https://docs.datadoghq.com/logs/archives
 
 ### Examples