Skip to content

Add Dashboards List V2 endpoints to spec #2367

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

Add Dashboards List V2 endpoints to spec #2367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
312 changes: 0 additions & 312 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1350,64 +1350,6 @@ components:
x-enum-varnames:
- ORDERED
- FREE
DashboardList:
description: Your Datadog Dashboards.
properties:
author:
$ref: '#/components/schemas/Creator'
created:
description: Date of creation of the dashboard list.
format: date-time
readOnly: true
type: string
dashboard_count:
description: The number of dashboards in the list.
format: int64
readOnly: true
type: integer
id:
description: The ID of the dashboard list.
format: int64
readOnly: true
type: integer
is_favorite:
description: Whether or not the list is in the favorites.
readOnly: true
type: boolean
modified:
description: Date of last edition of the dashboard list.
format: date-time
readOnly: true
type: string
name:
description: The name of the dashboard list.
example: My Dashboard
type: string
type:
description: The type of dashboard list.
example: manual_dashboard_list
readOnly: true
type: string
required:
- name
type: object
DashboardListDeleteResponse:
description: Deleted dashboard details.
properties:
deleted_dashboard_list_id:
description: ID of the deleted dashboard list.
format: int64
type: integer
type: object
DashboardListListResponse:
description: Information on your dashboard lists.
properties:
dashboard_lists:
description: List of all your dashboard lists.
items:
$ref: '#/components/schemas/DashboardList'
type: array
type: object
DashboardReflowType:
description: 'Reflow type for a **new dashboard layout** dashboard. Set this
only when layout type is ''ordered''.
Expand Down Expand Up @@ -25172,253 +25114,6 @@ paths:
- name: dashboard_id
source: id
type: unsafe
/api/v1/dashboard/lists/manual:
get:
description: Fetch all of your existing dashboard list definitions.
operationId: ListDashboardLists
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardListListResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- dashboards_read
summary: Get all dashboard lists
tags:
- Dashboard Lists
x-menu-order: 1
x-permission:
operator: OR
permissions:
- dashboards_read
x-undo:
type: safe
post:
description: Create an empty dashboard list.
operationId: CreateDashboardList
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardList'
description: Create a dashboard list request body.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardList'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- dashboards_write
summary: Create a dashboard list
tags:
- Dashboard Lists
x-codegen-request-body-name: body
x-given:
dashboard_list:
parameters:
- name: body
value: "{\n \"name\": \"{{ unique }}\"\n}"
step: there is a valid "dashboard_list" in the system
x-menu-order: 2
x-permission:
operator: OR
permissions:
- dashboards_write
x-undo:
operationId: DeleteDashboardList
parameters:
- name: list_id
source: id
type: unsafe
/api/v1/dashboard/lists/manual/{list_id}:
delete:
description: Delete a dashboard list.
operationId: DeleteDashboardList
parameters:
- description: ID of the dashboard list to delete.
in: path
name: list_id
required: true
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardListDeleteResponse'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- dashboards_write
summary: Delete a dashboard list
tags:
- Dashboard Lists
x-menu-order: 5
x-permission:
operator: OR
permissions:
- dashboards_write
x-undo:
type: idempotent
get:
description: Fetch an existing dashboard list's definition.
operationId: GetDashboardList
parameters:
- description: ID of the dashboard list to fetch.
in: path
name: list_id
required: true
schema:
format: int64
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardList'
description: OK
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- dashboards_read
summary: Get a dashboard list
tags:
- Dashboard Lists
x-menu-order: 3
x-permission:
operator: OR
permissions:
- dashboards_read
x-undo:
type: safe
put:
description: Update the name of a dashboard list.
operationId: UpdateDashboardList
parameters:
- description: ID of the dashboard list to update.
in: path
name: list_id
required: true
schema:
format: int64
type: integer
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardList'
description: Update a dashboard list request body.
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DashboardList'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ:
- dashboards_write
summary: Update a dashboard list
tags:
- Dashboard Lists
x-codegen-request-body-name: body
x-menu-order: 4
x-permission:
operator: OR
permissions:
- dashboards_write
x-undo:
type: idempotent
/api/v1/dashboard/public:
post:
description: Share a specified private dashboard, generating a URL at which
Expand Down Expand Up @@ -38010,13 +37705,6 @@ tags:
externalDocs:
url: https://docs.datadoghq.com/integrations/azure
name: Azure Integration
- description: 'Interact with your dashboard lists through the API to

organize, find, and share all of your dashboards with your team and

organization.'
name: Dashboard Lists
x-deprecated: true
- description: Manage all your dashboards, as well as access to your shared dashboards,
through the API. See the [Dashboards page](https://docs.datadoghq.com/dashboards/)
for more information.
Expand Down
Loading
Loading