@meshery/schemas 1.2.11 → 1.2.12

package/dist/constructs/v1beta3/environment/Environment.d.mts

@@ -1,800 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-interface paths {
-    "/api/environments": {
-        /** Gets all environments */
-        get: operations["getEnvironments"];
-        /** Creates a new environment */
-        post: operations["createEnvironment"];
-    };
-    "/api/environments/{environmentId}": {
-        get: operations["getEnvironmentById"];
-        put: operations["updateEnvironment"];
-        delete: operations["deleteEnvironment"];
-    };
-    "/api/environments/{environmentId}/connections": {
-        get: operations["getEnvironmentConnections"];
-    };
-}
-interface components {
-    schemas: {
-        /**
-         * Environment
-         * @description Environments allow you to logically group related Connections and their associated Credentials. Learn more at https://docs.meshery.io/concepts/logical/environments
-         * @example {
-         *   "id": "00000000-0000-0000-0000-000000000000",
-         *   "schemaVersion": "environments.meshery.io/v1beta3",
-         *   "name": "Production Environment",
-         *   "description": "Connections and credentials for the production cluster.",
-         *   "organizationId": "00000000-0000-0000-0000-000000000000",
-         *   "owner": "00000000-0000-0000-0000-000000000000",
-         *   "createdAt": "0001-01-01T00:00:00Z",
-         *   "metadata": {},
-         *   "updatedAt": "0001-01-01T00:00:00Z",
-         *   "deletedAt": null
-         * }
-         */
-        Environment: {
-            /**
-             * Format: uuid
-             * @description ID
-             */
-            id: string;
-            /**
-             * @description Specifies the version of the schema to which the environment conforms.
-             * @default environments.meshery.io/v1beta3
-             * @example [
-             *   "v1",
-             *   "v1alpha1",
-             *   "v2beta3",
-             *   "v1.custom-suffix",
-             *   "models.meshery.io/v1beta1",
-             *   "capability.meshery.io/v1alpha1"
-             * ]
-             */
-            schemaVersion: string;
-            /** @description Environment name */
-            name: string;
-            /** @description Environment description */
-            description: string;
-            /**
-             * Format: uuid
-             * @description Environment organization ID
-             */
-            organizationId: string;
-            /**
-             * Format: uuid
-             * @description Environment owner
-             */
-            owner?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the environment was created.
-             */
-            createdAt?: string;
-            /** @description Additional metadata associated with the environment. */
-            metadata?: {
-                [key: string]: unknown;
-            };
-            /**
-             * Format: date-time
-             * @description Timestamp when the environment was last updated.
-             */
-            updatedAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
-             */
-            deletedAt?: string | null;
-        };
-        /** @description Junction record linking an environment to a connection. */
-        EnvironmentConnectionMapping: {
-            /**
-             * Format: uuid
-             * @description Mapping record ID.
-             */
-            id?: string;
-            /**
-             * Format: uuid
-             * @description ID of the associated environment.
-             */
-            environmentId?: string;
-            /**
-             * Format: uuid
-             * @description ID of the associated connection.
-             */
-            connectionId?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the mapping was created.
-             */
-            createdAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the mapping was last updated.
-             */
-            updatedAt?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the mapping was soft-deleted. Null while the mapping remains active.
-             */
-            deletedAt?: string;
-        };
-        /** @description Payload for creating or updating an environment. */
-        EnvironmentPayload: {
-            /** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
-            name: string;
-            /** @description An environment is a collection of resources, such as connections & credentials. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
-            description?: string;
-            /**
-             * Format: uuid
-             * @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
-             */
-            organizationId: string;
-        };
-        /** @description Paginated list of environments. */
-        EnvironmentPage: {
-            /** @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 Environments associated with this resource. */
-            environments?: {
-                /**
-                 * Format: uuid
-                 * @description ID
-                 */
-                id: string;
-                /**
-                 * @description Specifies the version of the schema to which the environment conforms.
-                 * @default environments.meshery.io/v1beta3
-                 * @example [
-                 *   "v1",
-                 *   "v1alpha1",
-                 *   "v2beta3",
-                 *   "v1.custom-suffix",
-                 *   "models.meshery.io/v1beta1",
-                 *   "capability.meshery.io/v1alpha1"
-                 * ]
-                 */
-                schemaVersion: string;
-                /** @description Environment name */
-                name: string;
-                /** @description Environment description */
-                description: string;
-                /**
-                 * Format: uuid
-                 * @description Environment organization ID
-                 */
-                organizationId: string;
-                /**
-                 * Format: uuid
-                 * @description Environment owner
-                 */
-                owner?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the environment was created.
-                 */
-                createdAt?: string;
-                /** @description Additional metadata associated with the environment. */
-                metadata?: {
-                    [key: string]: unknown;
-                };
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the environment was last updated.
-                 */
-                updatedAt?: string;
-                /**
-                 * Format: date-time
-                 * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
-                 */
-                deletedAt?: string | null;
-            }[];
-        };
-        /** @description Paginated list of connections associated with an environment. */
-        EnvironmentConnectionsPage: {
-            /** @description Current page number of the result set. */
-            page?: number;
-            /** @description Number of items per page. */
-            pageSize?: number;
-            /** @description Total number of items available. */
-            totalCount?: number;
-            /** @description The connections of the environmentconnectionspage. */
-            connections?: {
-                [key: string]: unknown;
-            }[];
-        };
-    };
-    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 Environment ID */
-        environmentId: 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 User's organization ID */
-        orgIdQuery: string;
-    };
-    requestBodies: {
-        /** Body for creating environment */
-        environmentPayload: {
-            content: {
-                "application/json": {
-                    /** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
-                    name: string;
-                    /** @description An environment is a collection of resources, such as connections & credentials. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
-                    description?: string;
-                    /**
-                     * Format: uuid
-                     * @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
-                     */
-                    organizationId: string;
-                };
-            };
-        };
-    };
-}
-interface operations {
-    /** Gets all environments */
-    getEnvironments: {
-        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;
-                /** User's organization ID */
-                orgId: string;
-            };
-        };
-        responses: {
-            /** Environments */
-            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 Environments associated with this resource. */
-                        environments?: {
-                            /**
-                             * Format: uuid
-                             * @description ID
-                             */
-                            id: string;
-                            /**
-                             * @description Specifies the version of the schema to which the environment conforms.
-                             * @default environments.meshery.io/v1beta3
-                             * @example [
-                             *   "v1",
-                             *   "v1alpha1",
-                             *   "v2beta3",
-                             *   "v1.custom-suffix",
-                             *   "models.meshery.io/v1beta1",
-                             *   "capability.meshery.io/v1alpha1"
-                             * ]
-                             */
-                            schemaVersion: string;
-                            /** @description Environment name */
-                            name: string;
-                            /** @description Environment description */
-                            description: string;
-                            /**
-                             * Format: uuid
-                             * @description Environment organization ID
-                             */
-                            organizationId: string;
-                            /**
-                             * Format: uuid
-                             * @description Environment owner
-                             */
-                            owner?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was created.
-                             */
-                            createdAt?: string;
-                            /** @description Additional metadata associated with the environment. */
-                            metadata?: {
-                                [key: string]: unknown;
-                            };
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was soft deleted. Null while the environment 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 environment */
-    createEnvironment: {
-        responses: {
-            /** Created environment */
-            201: {
-                content: {
-                    "application/json": {
-                        /**
-                         * Format: uuid
-                         * @description ID
-                         */
-                        id: string;
-                        /**
-                         * @description Specifies the version of the schema to which the environment conforms.
-                         * @default environments.meshery.io/v1beta3
-                         * @example [
-                         *   "v1",
-                         *   "v1alpha1",
-                         *   "v2beta3",
-                         *   "v1.custom-suffix",
-                         *   "models.meshery.io/v1beta1",
-                         *   "capability.meshery.io/v1alpha1"
-                         * ]
-                         */
-                        schemaVersion: string;
-                        /** @description Environment name */
-                        name: string;
-                        /** @description Environment description */
-                        description: string;
-                        /**
-                         * Format: uuid
-                         * @description Environment organization ID
-                         */
-                        organizationId: string;
-                        /**
-                         * Format: uuid
-                         * @description Environment owner
-                         */
-                        owner?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the environment was created.
-                         */
-                        createdAt?: string;
-                        /** @description Additional metadata associated with the environment. */
-                        metadata?: {
-                            [key: string]: unknown;
-                        };
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the environment was last updated.
-                         */
-                        updatedAt?: string;
-                        /**
-                         * Format: date-time
-                         * @description Timestamp when the environment was soft deleted. Null while the environment 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 environment */
-        requestBody: {
-            content: {
-                "application/json": {
-                    /** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
-                    name: string;
-                    /** @description An environment is a collection of resources, such as connections & credentials. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
-                    description?: string;
-                    /**
-                     * Format: uuid
-                     * @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
-                     */
-                    organizationId: string;
-                };
-            };
-        };
-    };
-    getEnvironmentById: {
-        parameters: {
-            path: {
-                /** Environment ID */
-                environmentId: string;
-            };
-            query: {
-                /** User's organization ID */
-                orgId: string;
-            };
-        };
-        responses: {
-            /** Environment 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 Environments associated with this resource. */
-                        environments?: {
-                            /**
-                             * Format: uuid
-                             * @description ID
-                             */
-                            id: string;
-                            /**
-                             * @description Specifies the version of the schema to which the environment conforms.
-                             * @default environments.meshery.io/v1beta3
-                             * @example [
-                             *   "v1",
-                             *   "v1alpha1",
-                             *   "v2beta3",
-                             *   "v1.custom-suffix",
-                             *   "models.meshery.io/v1beta1",
-                             *   "capability.meshery.io/v1alpha1"
-                             * ]
-                             */
-                            schemaVersion: string;
-                            /** @description Environment name */
-                            name: string;
-                            /** @description Environment description */
-                            description: string;
-                            /**
-                             * Format: uuid
-                             * @description Environment organization ID
-                             */
-                            organizationId: string;
-                            /**
-                             * Format: uuid
-                             * @description Environment owner
-                             */
-                            owner?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was created.
-                             */
-                            createdAt?: string;
-                            /** @description Additional metadata associated with the environment. */
-                            metadata?: {
-                                [key: string]: unknown;
-                            };
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was soft deleted. Null while the environment 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;
-                };
-            };
-        };
-    };
-    updateEnvironment: {
-        parameters: {
-            path: {
-                /** Environment ID */
-                environmentId: string;
-            };
-        };
-        responses: {
-            /** Environment 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 Environments associated with this resource. */
-                        environments?: {
-                            /**
-                             * Format: uuid
-                             * @description ID
-                             */
-                            id: string;
-                            /**
-                             * @description Specifies the version of the schema to which the environment conforms.
-                             * @default environments.meshery.io/v1beta3
-                             * @example [
-                             *   "v1",
-                             *   "v1alpha1",
-                             *   "v2beta3",
-                             *   "v1.custom-suffix",
-                             *   "models.meshery.io/v1beta1",
-                             *   "capability.meshery.io/v1alpha1"
-                             * ]
-                             */
-                            schemaVersion: string;
-                            /** @description Environment name */
-                            name: string;
-                            /** @description Environment description */
-                            description: string;
-                            /**
-                             * Format: uuid
-                             * @description Environment organization ID
-                             */
-                            organizationId: string;
-                            /**
-                             * Format: uuid
-                             * @description Environment owner
-                             */
-                            owner?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was created.
-                             */
-                            createdAt?: string;
-                            /** @description Additional metadata associated with the environment. */
-                            metadata?: {
-                                [key: string]: unknown;
-                            };
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was last updated.
-                             */
-                            updatedAt?: string;
-                            /**
-                             * Format: date-time
-                             * @description Timestamp when the environment was soft deleted. Null while the environment 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 environment */
-        requestBody: {
-            content: {
-                "application/json": {
-                    /** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
-                    name: string;
-                    /** @description An environment is a collection of resources, such as connections & credentials. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
-                    description?: string;
-                    /**
-                     * Format: uuid
-                     * @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
-                     */
-                    organizationId: string;
-                };
-            };
-        };
-    };
-    deleteEnvironment: {
-        parameters: {
-            path: {
-                /** Environment ID */
-                environmentId: string;
-            };
-        };
-        responses: {
-            /** Environment 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;
-                };
-            };
-        };
-    };
-    getEnvironmentConnections: {
-        parameters: {
-            path: {
-                /** Environment ID */
-                environmentId: string;
-            };
-            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 used to scope the connection listing. */
-                filter?: string;
-            };
-        };
-        responses: {
-            /** Environment connections */
-            200: {
-                content: {
-                    "application/json": {
-                        /** @description Current page number of the result set. */
-                        page?: number;
-                        /** @description Number of items per page. */
-                        pageSize?: number;
-                        /** @description Total number of items available. */
-                        totalCount?: number;
-                        /** @description The connections of the environmentconnectionspage. */
-                        connections?: {
-                            [key: string]: unknown;
-                        }[];
-                    };
-                };
-            };
-            /** 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 };