@meshery/schemas 1.2.10 → 1.2.12

package/dist/constructs/v1beta2/view/View.d.ts

@@ -1,810 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-interface paths {
-    "/api/content/views": {
-        /** Returns a paginated list of views accessible to the user. */
-        get: operations["getViews"];
-        /** Creates a new view with the given filters and metadata. */
-        post: operations["createView"];
-    };
-    "/api/content/view/share": {
-        /**
-         * Shares a view with a list of email addresses. When `share` is true, the
-         * view's visibility is flipped to public and an invitation email is sent
-         * to each recipient. When `share` is false, visibility is reverted to
-         * private. Only the owner of the view (or a provider admin) may change
-         * its sharing mode.
-         */
-        post: operations["shareView"];
-    };
-    "/api/content/views/{viewId}": {
-        /** Returns a single view by its unique identifier. */
-        get: operations["getViewById"];
-        /** Updates an existing view with new filters, metadata, or visibility. */
-        put: operations["updateView"];
-        /** Soft-deletes a view by its unique identifier. */
-        delete: operations["deleteView"];
-    };
-}
-interface components {
-    schemas: {
-        /**
-         * MesheryView
-         * @description A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views
-         * @example {
-         *   "id": "00000000-0000-0000-0000-000000000000",
-         *   "name": "My Kubernetes View",
-         *   "visibility": "private",
-         *   "filters": {},
-         *   "metadata": {},
-         *   "userId": "00000000-0000-0000-0000-000000000000",
-         *   "createdAt": "0001-01-01T00:00:00Z",
-         *   "updatedAt": "0001-01-01T00:00:00Z",
-         *   "deletedAt": null
-         * }
-         */
-        MesheryView: {
-            /**
-             * Format: uuid
-             * @description Unique identifier for the view.
-             */
-            id: string;
-            /** @description Display name of the view. */
-            name: string;
-            /** @description Visibility level of the view. */
-            visibility: string;
-            /** @description Filter configuration that defines which resources this view displays. */
-            filters?: {
-                [key: string]: unknown;
-            };
-            /** @description Additional metadata associated with the view. */
-            metadata?: {
-                [key: string]: unknown;
-            };
-            /**
-             * Format: uuid
-             * @description ID of the user who created the view.
-             */
-            userId: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the view was created.
-             */
-            createdAt: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the view was last updated.
-             */
-            updatedAt: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the view was soft deleted. Null while the view remains active.
-             */
-            deletedAt?: string | null;
-        };
-        /** @description A view enriched with the workspace and organization it belongs to. */
-        MesheryViewWithLocation: {
-            /** Format: uuid */
-            id?: string;
-            /** @description Display name of the view. */
-            name?: string;
-            /** @description Visibility level of the view. */
-            visibility?: string;
-            /** @description Filter configuration for this view. */
-            filters?: {
-                [key: string]: unknown;
-            };
-            /** @description Metadata associated with the view. */
-            metadata?: {
-                [key: string]: unknown;
-            };
-            /**
-             * Format: uuid
-             * @description ID of the user who created the view.
-             */
-            userId?: string;
-            /** @description Name of the workspace this view belongs to. */
-            workspaceName?: string;
-            /**
-             * Format: uuid
-             * @description ID of the workspace this view belongs to.
-             */
-            workspaceId: string;
-            /**
-             * Format: uuid
-             * @description ID of the organization this view belongs to.
-             */
-            organizationId: string;
-            /** @description Name of the organization this view belongs to. */
-            organizationName?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the view was created.
-             */
-            createdAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the view was last updated.
-             */
-            updatedAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the view was soft deleted. Null while the view remains active.
-             */
-            deletedAt?: string | null;
-        };
-        /** @description Payload for creating or updating a view. */
-        ViewPayload: {
-            /** @description Display name of the view. */
-            name: string;
-            /** @description Filter configuration for this view. */
-            filters?: {
-                [key: string]: unknown;
-            };
-            /** @description Visibility level of the view. */
-            visibility?: string;
-            /** @description Metadata associated with the view. */
-            metadata?: {
-                [key: string]: unknown;
-            };
-        };
-        /**
-         * @description Payload for sharing a view with one or more recipients by email. The
-         * wire format matches the canonical design share payload
-         * (`design.ContentSharePayload` in `v1beta2/design`), restricted to the
-         * `view` content type since that is all this endpoint accepts.
-         */
-        ContentSharePayload: {
-            /**
-             * Format: uuid
-             * @description Identifier of the view being shared.
-             */
-            contentId: string;
-            /**
-             * @description The kind of content being shared. Only `view` is accepted on this
-             * endpoint.
-             *
-             * @enum {string}
-             */
-            contentType: "view";
-            /** @description Email addresses of the recipients to share this view with. */
-            emails: string[];
-            /**
-             * @description When true, flip the view's visibility to public and send invitation
-             * emails to the recipients. When false, revert visibility to private.
-             */
-            share: boolean;
-        };
-        /** @description Paginated list of views with location enrichment. */
-        MesheryViewPage: {
-            /** @description Zero-based page index returned in this response. */
-            page?: number;
-            /** @description Maximum number of items returned on each page. */
-            pageSize?: number;
-            /** @description Total number of items across all pages. */
-            totalCount?: number;
-            /** @description Views in this page, enriched with workspace and organization context. */
-            views?: {
-                /** Format: uuid */
-                id?: string;
-                /** @description Display name of the view. */
-                name?: string;
-                /** @description Visibility level of the view. */
-                visibility?: string;
-                /** @description Filter configuration for this view. */
-                filters?: {
-                    [key: string]: unknown;
-                };
-                /** @description Metadata associated with the view. */
-                metadata?: {
-                    [key: string]: unknown;
-                };
-                /**
-                 * Format: uuid
-                 * @description ID of the user who created the view.
-                 */
-                userId?: string;
-                /** @description Name of the workspace this view belongs to. */
-                workspaceName?: string;
-                /**
-                 * Format: uuid
-                 * @description ID of the workspace this view belongs to.
-                 */
-                workspaceId: string;
-                /**
-                 * Format: uuid
-                 * @description ID of the organization this view belongs to.
-                 */
-                organizationId: string;
-                /** @description Name of the organization this view belongs to. */
-                organizationName?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the view was created.
-                 */
-                createdAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the view was last updated.
-                 */
-                updatedAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the view was soft deleted. Null while the view remains active.
-                 */
-                deletedAt?: string | null;
-            }[];
-        };
-    };
-    responses: {
-        /** ok */
-        200: {
-            content: {
-                "text/plain": string;
-            };
-        };
-        /** Invalid request body or request param */
-        400: {
-            content: {
-                "text/plain": string;
-            };
-        };
-        /** Expired JWT token used or insufficient privilege */
-        401: {
-            content: {
-                "text/plain": string;
-            };
-        };
-        /** Result not found */
-        404: {
-            content: {
-                "text/plain": string;
-            };
-        };
-        /** Internal server error */
-        500: {
-            content: {
-                "text/plain": string;
-            };
-        };
-    };
-    parameters: {
-        /** @description View ID */
-        viewId: string;
-        /** @description Get responses that match search param value */
-        search: string;
-        /** @description Get ordered responses */
-        order: string;
-        /** @description Get responses by page */
-        page: string;
-        /** @description Get responses by pagesize */
-        pagesize: string;
-        /** @description Organization ID to scope the request. */
-        orgIdQuery: string;
-        /** @description UUID of the user whose views to retrieve. */
-        userIdQuery: string;
-    };
-    requestBodies: {
-        /** Body for creating or updating a view */
-        viewPayload: {
-            content: {
-                "application/json": {
-                    /** @description Display name of the view. */
-                    name: string;
-                    /** @description Filter configuration for this view. */
-                    filters?: {
-                        [key: string]: unknown;
-                    };
-                    /** @description Visibility level of the view. */
-                    visibility?: string;
-                    /** @description Metadata associated with the view. */
-                    metadata?: {
-                        [key: string]: unknown;
-                    };
-                };
-            };
-        };
-        /** Body for sharing a view with recipients by email. */
-        contentSharePayload: {
-            content: {
-                "application/json": {
-                    /**
-                     * Format: uuid
-                     * @description Identifier of the view being shared.
-                     */
-                    contentId: string;
-                    /**
-                     * @description The kind of content being shared. Only `view` is accepted on this
-                     * endpoint.
-                     *
-                     * @enum {string}
-                     */
-                    contentType: "view";
-                    /** @description Email addresses of the recipients to share this view with. */
-                    emails: string[];
-                    /**
-                     * @description When true, flip the view's visibility to public and send invitation
-                     * emails to the recipients. When false, revert visibility to private.
-                     */
-                    share: boolean;
-                };
-            };
-        };
-    };
-}
-interface operations {
-    /** Returns a paginated list of views accessible to the user. */
-    getViews: {
-        parameters: {
-            query: {
-                /** Get responses that match search param value */
-                search?: string;
-                /** Get ordered responses */
-                order?: string;
-                /** Get responses by page */
-                page?: string;
-                /** Get responses by pagesize */
-                pagesize?: string;
-                /** JSON-encoded filter string for assignment and soft-delete filters. */
-                filter?: string;
-                /** When true, include views shared with the user. */
-                shared?: boolean;
-                /** Filter by visibility level (public, private). */
-                visibility?: string;
-                /** Organization ID to scope the request. */
-                orgId?: string;
-                /** UUID of the user whose views to retrieve. */
-                userId?: string;
-            };
-        };
-        responses: {
-            /** Views page */
-            200: {
-                content: {
-                    "application/json": {
-                        /** @description Zero-based page index returned in this response. */
-                        page?: number;
-                        /** @description Maximum number of items returned on each page. */
-                        pageSize?: number;
-                        /** @description Total number of items across all pages. */
-                        totalCount?: number;
-                        /** @description Views in this page, enriched with workspace and organization context. */
-                        views?: {
-                            /** Format: uuid */
-                            id?: string;
-                            /** @description Display name of the view. */
-                            name?: string;
-                            /** @description Visibility level of the view. */
-                            visibility?: string;
-                            /** @description Filter configuration for this view. */
-                            filters?: {
-                                [key: string]: unknown;
-                            };
-                            /** @description Metadata associated with the view. */
-                            metadata?: {
-                                [key: string]: unknown;
-                            };
-                            /**
-                             * Format: uuid
-                             * @description ID of the user who created the view.
-                             */
-                            userId?: string;
-                            /** @description Name of the workspace this view belongs to. */
-                            workspaceName?: string;
-                            /**
-                             * Format: uuid
-                             * @description ID of the workspace this view belongs to.
-                             */
-                            workspaceId: string;
-                            /**
-                             * Format: uuid
-                             * @description ID of the organization this view belongs to.
-                             */
-                            organizationId: string;
-                            /** @description Name of the organization this view belongs to. */
-                            organizationName?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the view was created.
-                             */
-                            createdAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the view was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the view was soft deleted. Null while the view remains active.
-                             */
-                            deletedAt?: string | null;
-                        }[];
-                    };
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-    };
-    /** Creates a new view with the given filters and metadata. */
-    createView: {
-        responses: {
-            /** Created view */
-            201: {
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description Unique identifier for the view.
-                         */
-                        id: string;
-                        /** @description Display name of the view. */
-                        name: string;
-                        /** @description Visibility level of the view. */
-                        visibility: string;
-                        /** @description Filter configuration that defines which resources this view displays. */
-                        filters?: {
-                            [key: string]: unknown;
-                        };
-                        /** @description Additional metadata associated with the view. */
-                        metadata?: {
-                            [key: string]: unknown;
-                        };
-                        /**
-                         * Format: uuid
-                         * @description ID of the user who created the view.
-                         */
-                        userId: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was created.
-                         */
-                        createdAt: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was last updated.
-                         */
-                        updatedAt: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was soft deleted. Null while the view remains active.
-                         */
-                        deletedAt?: string | null;
-                    };
-                };
-            };
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-        /** Body for creating or updating a view */
-        requestBody: {
-            content: {
-                "application/json": {
-                    /** @description Display name of the view. */
-                    name: string;
-                    /** @description Filter configuration for this view. */
-                    filters?: {
-                        [key: string]: unknown;
-                    };
-                    /** @description Visibility level of the view. */
-                    visibility?: string;
-                    /** @description Metadata associated with the view. */
-                    metadata?: {
-                        [key: string]: unknown;
-                    };
-                };
-            };
-        };
-    };
-    /**
-     * Shares a view with a list of email addresses. When `share` is true, the
-     * view's visibility is flipped to public and an invitation email is sent
-     * to each recipient. When `share` is false, visibility is reverted to
-     * private. Only the owner of the view (or a provider admin) may change
-     * its sharing mode.
-     */
-    shareView: {
-        responses: {
-            /** View shared. */
-            200: unknown;
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Caller is not the owner of the view. */
-            403: unknown;
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-        /** Body for sharing a view with recipients by email. */
-        requestBody: {
-            content: {
-                "application/json": {
-                    /**
-                     * Format: uuid
-                     * @description Identifier of the view being shared.
-                     */
-                    contentId: string;
-                    /**
-                     * @description The kind of content being shared. Only `view` is accepted on this
-                     * endpoint.
-                     *
-                     * @enum {string}
-                     */
-                    contentType: "view";
-                    /** @description Email addresses of the recipients to share this view with. */
-                    emails: string[];
-                    /**
-                     * @description When true, flip the view's visibility to public and send invitation
-                     * emails to the recipients. When false, revert visibility to private.
-                     */
-                    share: boolean;
-                };
-            };
-        };
-    };
-    /** Returns a single view by its unique identifier. */
-    getViewById: {
-        parameters: {
-            path: {
-                /** View ID */
-                viewId: string;
-            };
-        };
-        responses: {
-            /** View */
-            200: {
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description Unique identifier for the view.
-                         */
-                        id: string;
-                        /** @description Display name of the view. */
-                        name: string;
-                        /** @description Visibility level of the view. */
-                        visibility: string;
-                        /** @description Filter configuration that defines which resources this view displays. */
-                        filters?: {
-                            [key: string]: unknown;
-                        };
-                        /** @description Additional metadata associated with the view. */
-                        metadata?: {
-                            [key: string]: unknown;
-                        };
-                        /**
-                         * Format: uuid
-                         * @description ID of the user who created the view.
-                         */
-                        userId: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was created.
-                         */
-                        createdAt: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was last updated.
-                         */
-                        updatedAt: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was soft deleted. Null while the view remains active.
-                         */
-                        deletedAt?: string | null;
-                    };
-                };
-            };
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-    };
-    /** Updates an existing view with new filters, metadata, or visibility. */
-    updateView: {
-        parameters: {
-            path: {
-                /** View ID */
-                viewId: string;
-            };
-        };
-        responses: {
-            /** Updated view */
-            200: {
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description Unique identifier for the view.
-                         */
-                        id: string;
-                        /** @description Display name of the view. */
-                        name: string;
-                        /** @description Visibility level of the view. */
-                        visibility: string;
-                        /** @description Filter configuration that defines which resources this view displays. */
-                        filters?: {
-                            [key: string]: unknown;
-                        };
-                        /** @description Additional metadata associated with the view. */
-                        metadata?: {
-                            [key: string]: unknown;
-                        };
-                        /**
-                         * Format: uuid
-                         * @description ID of the user who created the view.
-                         */
-                        userId: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was created.
-                         */
-                        createdAt: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was last updated.
-                         */
-                        updatedAt: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the view was soft deleted. Null while the view remains active.
-                         */
-                        deletedAt?: string | null;
-                    };
-                };
-            };
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-        /** Body for creating or updating a view */
-        requestBody: {
-            content: {
-                "application/json": {
-                    /** @description Display name of the view. */
-                    name: string;
-                    /** @description Filter configuration for this view. */
-                    filters?: {
-                        [key: string]: unknown;
-                    };
-                    /** @description Visibility level of the view. */
-                    visibility?: string;
-                    /** @description Metadata associated with the view. */
-                    metadata?: {
-                        [key: string]: unknown;
-                    };
-                };
-            };
-        };
-    };
-    /** Soft-deletes a view by its unique identifier. */
-    deleteView: {
-        parameters: {
-            path: {
-                /** View ID */
-                viewId: string;
-            };
-        };
-        responses: {
-            /** View deleted */
-            204: never;
-            /** Invalid request body or request param */
-            400: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Expired JWT token used or insufficient privilege */
-            401: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Result not found */
-            404: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-            /** Internal server error */
-            500: {
-                content: {
-                    "text/plain": string;
-                };
-            };
-        };
-    };
-}
-interface external {
-}
-
-export type { components, external, operations, paths };