mirror of https://github.com/buster-so/buster.git
77 lines
2.1 KiB
TypeScript
77 lines
2.1 KiB
TypeScript
|
import type { DashboardConfig, VerificationStatus } from '@/api/asset_interfaces';
|
||
|
|
import type { ShareRequest } from '@/api/buster_socket/shared_interfaces';
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for dashboard list request parameters
|
||
|
|
*/
|
||
|
|
export interface DashboardsListRequest {
|
||
|
|
/** The page number to fetch */
|
||
|
|
page_token: number;
|
||
|
|
/** Number of items per page */
|
||
|
|
page_size: number;
|
||
|
|
/** Filter for dashboards shared with the current user */
|
||
|
|
shared_with_me?: boolean;
|
||
|
|
/** Filter for dashboards owned by the current user */
|
||
|
|
only_my_dashboards?: boolean;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for subscribing to a dashboard
|
||
|
|
*/
|
||
|
|
export interface DashboardSubscribeRequest {
|
||
|
|
/** The unique identifier of the dashboard */
|
||
|
|
id: string;
|
||
|
|
/** Optional password for accessing protected dashboards */
|
||
|
|
password?: string;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for unsubscribing from a specific dashboard
|
||
|
|
*/
|
||
|
|
export interface DashboardUnsubscribeRequest {
|
||
|
|
/** The unique identifier of the dashboard to unsubscribe from */
|
||
|
|
id: string;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for creating a new dashboard
|
||
|
|
*/
|
||
|
|
export interface DashboardCreateRequest {
|
||
|
|
/** The name of the dashboard */
|
||
|
|
name: string;
|
||
|
|
/** Optional description of the dashboard */
|
||
|
|
description?: string | null;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for updating a dashboard
|
||
|
|
*/
|
||
|
|
export interface DashboardUpdateRequest extends ShareRequest {
|
||
|
|
/** The unique identifier of the dashboard */
|
||
|
|
id: string;
|
||
|
|
/** New name for the dashboard */
|
||
|
|
name?: string;
|
||
|
|
/** New description for the dashboard */
|
||
|
|
description?: string | null;
|
||
|
|
/** Updated dashboard configuration */
|
||
|
|
config?: DashboardConfig;
|
||
|
|
/** Updated verification status */
|
||
|
|
status?: VerificationStatus;
|
||
|
|
/** Collection IDs to add the dashboard to */
|
||
|
|
add_to_collections?: string[];
|
||
|
|
/** Collection IDs to remove the dashboard from */
|
||
|
|
remove_from_collections?: string[];
|
||
|
|
/** User IDs to remove access from */
|
||
|
|
remove_users?: string[];
|
||
|
|
/** Array of metric IDs associated with the dashboard */
|
||
|
|
metrics?: string[];
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface for deleting dashboards
|
||
|
|
*/
|
||
|
|
export interface DashboardDeleteRequest {
|
||
|
|
/** Array of dashboard IDs to delete */
|
||
|
|
ids: string[];
|
||
|
|
}
|