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

Add support for dashboard bulk delete, restore endpoints #501

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.4.1.dev11",
"regenerated": "2021-07-15 15:54:38.956828",
"spec_repo_commit": "18eae8f"
"regenerated": "2021-07-16 07:35:29.024585",
"spec_repo_commit": "3333df2"
},
"v2": {
"apigentools_version": "1.4.1.dev11",
"regenerated": "2021-07-15 15:55:05.776227",
"spec_repo_commit": "18eae8f"
"regenerated": "2021-07-16 07:35:56.451726",
"spec_repo_commit": "3333df2"
}
}
}
13 changes: 13 additions & 0 deletions docs/v1/DashboardBulkActionData.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DashboardBulkActionData

Dashboard bulk action request data.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Dashboard resource ID. |
**type** | [**DashboardResourceType**](DashboardResourceType.md) | |

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


12 changes: 12 additions & 0 deletions docs/v1/DashboardBulkActionDataList.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DashboardBulkActionDataList

List of dashboard bulk action request data objects.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | [**[DashboardBulkActionData]**](DashboardBulkActionData.md) | List of dashboard bulk action request data objects. |

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


12 changes: 12 additions & 0 deletions docs/v1/DashboardBulkDeleteRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DashboardBulkDeleteRequest

Dashboard bulk delete request body.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**DashboardBulkActionDataList**](DashboardBulkActionDataList.md) | |

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


12 changes: 12 additions & 0 deletions docs/v1/DashboardResourceType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DashboardResourceType

Dashboard resource type.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | Dashboard resource type. | defaults to "dashboard", must be one of ["dashboard", ]

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


12 changes: 12 additions & 0 deletions docs/v1/DashboardRestoreRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# DashboardRestoreRequest

Dashboard restore request body.

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | [**DashboardBulkActionDataList**](DashboardBulkActionDataList.md) | |

[[Back to Model list]](README.md#documentation-for-models) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to README]](README.md)


144 changes: 144 additions & 0 deletions docs/v1/DashboardsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**create_dashboard**](DashboardsApi.md#create_dashboard) | **POST** /api/v1/dashboard | Create a new dashboard
[**delete_dashboard**](DashboardsApi.md#delete_dashboard) | **DELETE** /api/v1/dashboard/{dashboard_id} | Delete a dashboard
[**delete_dashboards**](DashboardsApi.md#delete_dashboards) | **DELETE** /api/v1/dashboard | Delete dashboards
[**get_dashboard**](DashboardsApi.md#get_dashboard) | **GET** /api/v1/dashboard/{dashboard_id} | Get a dashboard
[**list_dashboards**](DashboardsApi.md#list_dashboards) | **GET** /api/v1/dashboard | Get all dashboards
[**restore_dashboards**](DashboardsApi.md#restore_dashboards) | **PATCH** /api/v1/dashboard | Restore deleted dashboards
[**update_dashboard**](DashboardsApi.md#update_dashboard) | **PUT** /api/v1/dashboard/{dashboard_id} | Update a dashboard


Expand Down Expand Up @@ -188,6 +190,77 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)

# **delete_dashboards**
> delete_dashboards(body)

Delete dashboards using the specified IDs. If there are any failures, no dashboards will be deleted (partial success is not allowed).

### Example

* Api Key Authentication (apiKeyAuth):
* Api Key Authentication (appKeyAuth):
```python
import os
from dateutil.parser import parse as dateutil_parser
from datadog_api_client.v1 import ApiClient, ApiException, Configuration
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration()

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
body = DashboardBulkDeleteRequest(
data=DashboardBulkActionDataList([
DashboardBulkActionData(
id="123-abc-456",
type=DashboardResourceType("dashboard"),
),
]),
) # DashboardBulkDeleteRequest | Delete dashboards request body.

# example passing only required values which don't have defaults set
try:
# Delete dashboards
api_instance.delete_dashboards(body)
except ApiException as e:
print("Exception when calling DashboardsApi->delete_dashboards: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DashboardBulkDeleteRequest**](DashboardBulkDeleteRequest.md)| Delete dashboards request body. |

### Return type

void (empty response body)

### Authorization

[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
**400** | Bad Request | - |
**403** | Forbidden | - |
**404** | Dashboards Not Found | - |

[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)

# **get_dashboard**
> Dashboard get_dashboard(dashboard_id)

Expand Down Expand Up @@ -319,6 +392,77 @@ Name | Type | Description | Notes

[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)

# **restore_dashboards**
> restore_dashboards(body)

Restore dashboards using the specified IDs. If there are any failures, no dashboards will be restored (partial success is not allowed).

### Example

* Api Key Authentication (apiKeyAuth):
* Api Key Authentication (appKeyAuth):
```python
import os
from dateutil.parser import parse as dateutil_parser
from datadog_api_client.v1 import ApiClient, ApiException, Configuration
from datadog_api_client.v1.api import dashboards_api
from datadog_api_client.v1.models import *
from pprint import pprint
# See configuration.py for a list of all supported configuration parameters.
configuration = Configuration()

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = dashboards_api.DashboardsApi(api_client)
body = DashboardRestoreRequest(
data=DashboardBulkActionDataList([
DashboardBulkActionData(
id="123-abc-456",
type=DashboardResourceType("dashboard"),
),
]),
) # DashboardRestoreRequest | Restore dashboards request body.

# example passing only required values which don't have defaults set
try:
# Restore deleted dashboards
api_instance.restore_dashboards(body)
except ApiException as e:
print("Exception when calling DashboardsApi->restore_dashboards: %s\n" % e)
```


### Parameters

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**DashboardRestoreRequest**](DashboardRestoreRequest.md)| Restore dashboards request body. |

### Return type

void (empty response body)

### Authorization

[apiKeyAuth](README.md#apiKeyAuth), [appKeyAuth](README.md#appKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | No Content | - |
**400** | Bad Request | - |
**403** | Forbidden | - |
**404** | Dashboards Not Found | - |

[[Back to top]](#) [[Back to API list]](README.md#documentation-for-api-endpoints) [[Back to Model list]](README.md#documentation-for-models) [[Back to README]](README.md)

# **update_dashboard**
> Dashboard update_dashboard(dashboard_id, body)

Expand Down
7 changes: 7 additions & 0 deletions docs/v1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,10 @@ Class | Method | HTTP request | Description
*DashboardListsApi* | [**update_dashboard_list**](DashboardListsApi.md#update_dashboard_list) | **PUT** /api/v1/dashboard/lists/manual/{list_id} | Update a dashboard list
*DashboardsApi* | [**create_dashboard**](DashboardsApi.md#create_dashboard) | **POST** /api/v1/dashboard | Create a new dashboard
*DashboardsApi* | [**delete_dashboard**](DashboardsApi.md#delete_dashboard) | **DELETE** /api/v1/dashboard/{dashboard_id} | Delete a dashboard
*DashboardsApi* | [**delete_dashboards**](DashboardsApi.md#delete_dashboards) | **DELETE** /api/v1/dashboard | Delete dashboards
*DashboardsApi* | [**get_dashboard**](DashboardsApi.md#get_dashboard) | **GET** /api/v1/dashboard/{dashboard_id} | Get a dashboard
*DashboardsApi* | [**list_dashboards**](DashboardsApi.md#list_dashboards) | **GET** /api/v1/dashboard | Get all dashboards
*DashboardsApi* | [**restore_dashboards**](DashboardsApi.md#restore_dashboards) | **PATCH** /api/v1/dashboard | Restore deleted dashboards
*DashboardsApi* | [**update_dashboard**](DashboardsApi.md#update_dashboard) | **PUT** /api/v1/dashboard/{dashboard_id} | Update a dashboard
*DowntimesApi* | [**cancel_downtime**](DowntimesApi.md#cancel_downtime) | **DELETE** /api/v1/downtime/{downtime_id} | Cancel a downtime
*DowntimesApi* | [**cancel_downtimes_by_scope**](DowntimesApi.md#cancel_downtimes_by_scope) | **POST** /api/v1/downtime/cancel/by_scope | Cancel downtimes by scope
Expand Down Expand Up @@ -337,12 +339,17 @@ Class | Method | HTTP request | Description
- [ContentEncoding](ContentEncoding.md)
- [Creator](Creator.md)
- [Dashboard](Dashboard.md)
- [DashboardBulkActionData](DashboardBulkActionData.md)
- [DashboardBulkActionDataList](DashboardBulkActionDataList.md)
- [DashboardBulkDeleteRequest](DashboardBulkDeleteRequest.md)
- [DashboardDeleteResponse](DashboardDeleteResponse.md)
- [DashboardLayoutType](DashboardLayoutType.md)
- [DashboardList](DashboardList.md)
- [DashboardListDeleteResponse](DashboardListDeleteResponse.md)
- [DashboardListListResponse](DashboardListListResponse.md)
- [DashboardReflowType](DashboardReflowType.md)
- [DashboardResourceType](DashboardResourceType.md)
- [DashboardRestoreRequest](DashboardRestoreRequest.md)
- [DashboardSummary](DashboardSummary.md)
- [DashboardSummaryDefinition](DashboardSummaryDefinition.md)
- [DashboardTemplateVariable](DashboardTemplateVariable.md)
Expand Down
Loading