@meshery/schemas 1.0.2 → 1.0.4

package/dist/constructs/v1beta1/workspace/Workspace.d.mts

@@ -60,112 +60,74 @@ interface paths {
 }
 interface components {
     schemas: {
+        /** @description A workspace is a logical grouping of resources within an organization. Workspaces provide a way to organize environments, designs, teams, and views. Learn more at https://docs.meshery.io/concepts/logical/workspaces */
         Workspace: {
             /** Format: uuid */
-            id?: string;
-            name?: string;
+            id: string;
+            /** @description Name of the workspace. */
+            name: string;
+            /** @description Description of the workspace. */
             description?: string;
             /**
              * Format: uuid
-             * @description Workspace organization ID
+             * @description Organization to which this workspace belongs.
+             */
+            organization_id: string;
+            /**
+             * Format: uuid
+             * @description User ID of the workspace owner.
              */
-            organization_id?: string;
             owner?: string;
+            /** @description Metadata associated with the workspace. */
             metadata?: {
-                [key: string]: string;
+                [key: string]: unknown;
             };
             /**
              * Format: date-time
              * @description Timestamp when the resource was created.
              */
-            created_at?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was updated.
-             */
-            updated_at?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was deleted.
-             */
-            deleted_at?: string;
-        };
-        WorkspacesTeamsMapping: {
-            /** Format: uuid */
-            id?: string;
-            /** Format: uuid */
-            team_id?: string;
-            /** Format: uuid */
-            workspace_id?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was created.
-             */
-            created_at?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was updated.
-             */
-            updated_at?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was deleted.
-             */
-            deleted_at?: string;
-        };
-        WorkspacesEnvironmentsMapping: {
-            /** Format: uuid */
-            id?: string;
-            /** Format: uuid */
-            environment_id?: string;
-            /** Format: uuid */
-            workspace_id?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was created.
-             */
-            created_at?: string;
+            created_at: string;
             /**
              * Format: date-time
              * @description Timestamp when the resource was updated.
              */
-            updated_at?: string;
+            updated_at: string;
             /**
              * Format: date-time
              * @description Timestamp when the resource was deleted.
              */
             deleted_at?: string;
         };
-        WorkspacesViewsMapping: {
+        /** @description Workspace with resolved owner details, as returned in list and get responses. */
+        AvailableWorkspace: {
             /** Format: uuid */
             id?: string;
-            /** Format: uuid */
-            view_id?: string;
-            /** Format: uuid */
-            workspace_id?: string;
-            /**
-             * Format: date-time
-             * @description Timestamp when the resource was created.
-             */
-            created_at?: string;
+            /** @description Name of the workspace. */
+            name?: string;
+            /** @description Description of the workspace. */
+            description?: string;
+            /** @description Name of the owning organization. */
+            org_name?: string;
+            /** @description Display name of the workspace owner. */
+            owner?: string;
             /**
-             * Format: date-time
-             * @description Timestamp when the resource was updated.
+             * Format: uuid
+             * @description User ID of the workspace owner.
              */
-            updated_at?: string;
+            owner_id?: string;
+            /** @description Email address of the workspace owner. */
+            owner_email?: string;
+            /** @description Avatar URL of the workspace owner. */
+            owner_avatar?: string;
+            /** @description Metadata associated with the workspace. */
+            metadata?: {
+                [key: string]: unknown;
+            };
             /**
-             * Format: date-time
-             * @description Timestamp when the resource was deleted.
+             * Format: uuid
+             * @description Organization to which this workspace belongs.
              */
-            deleted_at?: string;
-        };
-        WorkspacesDesignsMapping: {
-            /** Format: uuid */
-            id?: string;
-            /** Format: uuid */
-            design_id?: string;
-            /** Format: uuid */
-            workspace_id?: string;
+            organization_id?: string;
             /**
              * Format: date-time
              * @description Timestamp when the resource was created.
@@ -182,6 +144,7 @@ interface components {
              */
             deleted_at?: string;
         };
+        /** @description Payload for creating a workspace. */
         WorkspacePayload: {
             /** @description Name of the workspace. */
             name: string;
@@ -192,7 +155,12 @@ interface components {
              * @description Organization ID.
              */
             organization_id: string;
+            /** @description Metadata associated with the workspace. */
+            metadata?: {
+                [key: string]: unknown;
+            };
         };
+        /** @description Payload for updating a workspace. */
         WorkspaceUpdatePayload: {
             /** @description Name of the workspace. */
             name?: string;
@@ -203,26 +171,46 @@ interface components {
              * @description Organization ID.
              */
             organization_id: string;
+            /** @description Metadata associated with the workspace. */
+            metadata?: {
+                [key: string]: unknown;
+            };
         };
+        /** @description Paginated list of workspaces. */
         WorkspacePage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The workspaces of the workspacepage. */
+            /** @description List of workspaces with resolved owner details. */
             workspaces?: {
                 /** Format: uuid */
                 id?: string;
+                /** @description Name of the workspace. */
                 name?: string;
+                /** @description Description of the workspace. */
                 description?: string;
+                /** @description Name of the owning organization. */
+                org_name?: string;
+                /** @description Display name of the workspace owner. */
+                owner?: string;
                 /**
                  * Format: uuid
-                 * @description Workspace organization ID
+                 * @description User ID of the workspace owner.
                  */
-                organization_id?: string;
-                owner?: string;
+                owner_id?: string;
+                /** @description Email address of the workspace owner. */
+                owner_email?: string;
+                /** @description Avatar URL of the workspace owner. */
+                owner_avatar?: string;
+                /** @description Metadata associated with the workspace. */
                 metadata?: {
-                    [key: string]: string;
+                    [key: string]: unknown;
                 };
+                /**
+                 * Format: uuid
+                 * @description Organization to which this workspace belongs.
+                 */
+                organization_id?: string;
                 /**
                  * Format: date-time
                  * @description Timestamp when the resource was created.
@@ -240,18 +228,43 @@ interface components {
                 deleted_at?: string;
             }[];
         };
+        /** @description Junction record linking a workspace to a team. */
+        WorkspacesTeamsMapping: {
+            /** Format: uuid */
+            id?: string;
+            /** Format: uuid */
+            workspace_id?: string;
+            /** Format: uuid */
+            team_id?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was deleted.
+             */
+            deleted_at?: string;
+        };
+        /** @description Paginated list of workspace-team mappings. */
         WorkspacesTeamsMappingPage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The workspaces teams mapping of the workspacesteamsmappingpage. */
+            /** @description Workspace-team mapping entries. */
             workspacesTeamsMapping?: {
                 /** Format: uuid */
                 id?: string;
                 /** Format: uuid */
-                team_id?: string;
-                /** Format: uuid */
                 workspace_id?: string;
+                /** Format: uuid */
+                team_id?: string;
                 /**
                  * Format: date-time
                  * @description Timestamp when the resource was created.
@@ -269,18 +282,43 @@ interface components {
                 deleted_at?: string;
             }[];
         };
+        /** @description Junction record linking a workspace to an environment. */
+        WorkspacesEnvironmentsMapping: {
+            /** Format: uuid */
+            id?: string;
+            /** Format: uuid */
+            workspace_id?: string;
+            /** Format: uuid */
+            environment_id?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was deleted.
+             */
+            deleted_at?: string;
+        };
+        /** @description Paginated list of workspace-environment mappings. */
         WorkspacesEnvironmentsMappingPage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The workspaces environments mapping of the workspacesenvironmentsmappingpage. */
+            /** @description Workspace-environment mapping entries. */
             workspacesEnvironmentsMapping?: {
                 /** Format: uuid */
                 id?: string;
                 /** Format: uuid */
-                environment_id?: string;
-                /** Format: uuid */
                 workspace_id?: string;
+                /** Format: uuid */
+                environment_id?: string;
                 /**
                  * Format: date-time
                  * @description Timestamp when the resource was created.
@@ -298,18 +336,43 @@ interface components {
                 deleted_at?: string;
             }[];
         };
+        /** @description Junction record linking a workspace to a design. */
+        WorkspacesDesignsMapping: {
+            /** Format: uuid */
+            id?: string;
+            /** Format: uuid */
+            workspace_id?: string;
+            /** Format: uuid */
+            design_id?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was deleted.
+             */
+            deleted_at?: string;
+        };
+        /** @description Paginated list of workspace-design mappings. */
         WorkspacesDesignsMappingPage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The workspaces designs mapping of the workspacesdesignsmappingpage. */
+            /** @description Workspace-design mapping entries. */
             workspacesDesignsMapping?: {
                 /** Format: uuid */
                 id?: string;
                 /** Format: uuid */
-                design_id?: string;
-                /** Format: uuid */
                 workspace_id?: string;
+                /** Format: uuid */
+                design_id?: string;
                 /**
                  * Format: date-time
                  * @description Timestamp when the resource was created.
@@ -327,18 +390,43 @@ interface components {
                 deleted_at?: string;
             }[];
         };
+        /** @description Junction record linking a workspace to a view. */
+        WorkspacesViewsMapping: {
+            /** Format: uuid */
+            id?: string;
+            /** Format: uuid */
+            workspace_id?: string;
+            /** Format: uuid */
+            view_id?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was deleted.
+             */
+            deleted_at?: string;
+        };
+        /** @description Paginated list of workspace-view mappings. */
         WorkspacesViewsMappingPage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The workspaces views mapping of the workspacesviewsmappingpage. */
+            /** @description Workspace-view mapping entries. */
             workspacesViewsMapping?: {
                 /** Format: uuid */
                 id?: string;
                 /** Format: uuid */
-                view_id?: string;
-                /** Format: uuid */
                 workspace_id?: string;
+                /** Format: uuid */
+                view_id?: string;
                 /**
                  * Format: date-time
                  * @description Timestamp when the resource was created.
@@ -356,11 +444,12 @@ interface components {
                 deleted_at?: string;
             }[];
         };
+        /** @description Paginated list of designs. */
         MesheryDesignPage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The designs of the mesherydesignpage. */
+            /** @description Designs in this page. */
             designs?: {
                 catalogData?: {
                     /** @description Tracks the specific content version that has been made available in the Catalog. */
@@ -553,11 +642,11 @@ interface components {
                                  * Format: uuid
                                  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
                                  */
-                                credential_id?: string;
+                                credentialId?: string;
                                 /** @description Connection Type (platform, telemetry, collaboration) */
                                 type: string;
                                 /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
-                                sub_type: string;
+                                subType: string;
                                 /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
                                 kind: string;
                                 /** @description Additional connection metadata */
@@ -1772,17 +1861,26 @@ interface components {
                 visibility?: string;
             }[];
         };
+        /** @description A saved view with filters and metadata. */
         MesheryView: {
             /** Format: uuid */
             id?: string;
+            /** @description Name of the view. */
             name?: string;
+            /** @description Filter configuration for this view. */
             filters?: {
-                [key: string]: string;
+                [key: string]: unknown;
             };
+            /** @description Visibility of the view. */
             visibility?: string;
+            /** @description Metadata associated with the view. */
             metadata?: {
-                [key: string]: string;
+                [key: string]: unknown;
             };
+            /**
+             * Format: uuid
+             * @description User ID of the view creator.
+             */
             user_id?: string;
             /**
              * Format: date-time
@@ -1800,22 +1898,31 @@ interface components {
              */
             deleted_at?: string;
         };
+        /** @description Paginated list of views. */
         MesheryViewPage: {
             page?: number;
             page_size?: number;
             total_count?: number;
-            /** @description The views of the mesheryviewpage. */
+            /** @description Views in this page. */
             views?: {
                 /** Format: uuid */
                 id?: string;
+                /** @description Name of the view. */
                 name?: string;
+                /** @description Filter configuration for this view. */
                 filters?: {
-                    [key: string]: string;
+                    [key: string]: unknown;
                 };
+                /** @description Visibility of the view. */
                 visibility?: string;
+                /** @description Metadata associated with the view. */
                 metadata?: {
-                    [key: string]: string;
+                    [key: string]: unknown;
                 };
+                /**
+                 * Format: uuid
+                 * @description User ID of the view creator.
+                 */
                 user_id?: string;
                 /**
                  * Format: date-time
@@ -1903,6 +2010,10 @@ interface components {
                      * @description Organization ID.
                      */
                     organization_id: string;
+                    /** @description Metadata associated with the workspace. */
+                    metadata?: {
+                        [key: string]: unknown;
+                    };
                 };
             };
         };
@@ -1919,6 +2030,10 @@ interface components {
                      * @description Organization ID.
                      */
                     organization_id: string;
+                    /** @description Metadata associated with the workspace. */
+                    metadata?: {
+                        [key: string]: unknown;
+                    };
                 };
             };
         };
@@ -1949,21 +2064,36 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The workspaces of the workspacepage. */
+                        /** @description List of workspaces with resolved owner details. */
                         workspaces?: {
                             /** Format: uuid */
                             id?: string;
+                            /** @description Name of the workspace. */
                             name?: string;
+                            /** @description Description of the workspace. */
                             description?: string;
+                            /** @description Name of the owning organization. */
+                            org_name?: string;
+                            /** @description Display name of the workspace owner. */
+                            owner?: string;
                             /**
                              * Format: uuid
-                             * @description Workspace organization ID
+                             * @description User ID of the workspace owner.
                              */
-                            organization_id?: string;
-                            owner?: string;
+                            owner_id?: string;
+                            /** @description Email address of the workspace owner. */
+                            owner_email?: string;
+                            /** @description Avatar URL of the workspace owner. */
+                            owner_avatar?: string;
+                            /** @description Metadata associated with the workspace. */
                             metadata?: {
-                                [key: string]: string;
+                                [key: string]: unknown;
                             };
+                            /**
+                             * Format: uuid
+                             * @description Organization to which this workspace belongs.
+                             */
+                            organization_id?: string;
                             /**
                              * Format: date-time
                              * @description Timestamp when the resource was created.
@@ -2005,28 +2135,35 @@ interface operations {
                 content: {
                     "application/json": {
                         /** Format: uuid */
-                        id?: string;
-                        name?: string;
+                        id: string;
+                        /** @description Name of the workspace. */
+                        name: string;
+                        /** @description Description of the workspace. */
                         description?: string;
                         /**
                          * Format: uuid
-                         * @description Workspace organization ID
+                         * @description Organization to which this workspace belongs.
+                         */
+                        organization_id: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID of the workspace owner.
                          */
-                        organization_id?: string;
                         owner?: string;
+                        /** @description Metadata associated with the workspace. */
                         metadata?: {
-                            [key: string]: string;
+                            [key: string]: unknown;
                         };
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was created.
                          */
-                        created_at?: string;
+                        created_at: string;
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was updated.
                          */
-                        updated_at?: string;
+                        updated_at: string;
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was deleted.
@@ -2067,6 +2204,10 @@ interface operations {
                      * @description Organization ID.
                      */
                     organization_id: string;
+                    /** @description Metadata associated with the workspace. */
+                    metadata?: {
+                        [key: string]: unknown;
+                    };
                 };
             };
         };
@@ -2085,28 +2226,35 @@ interface operations {
                 content: {
                     "application/json": {
                         /** Format: uuid */
-                        id?: string;
-                        name?: string;
+                        id: string;
+                        /** @description Name of the workspace. */
+                        name: string;
+                        /** @description Description of the workspace. */
                         description?: string;
                         /**
                          * Format: uuid
-                         * @description Workspace organization ID
+                         * @description Organization to which this workspace belongs.
+                         */
+                        organization_id: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID of the workspace owner.
                          */
-                        organization_id?: string;
                         owner?: string;
+                        /** @description Metadata associated with the workspace. */
                         metadata?: {
-                            [key: string]: string;
+                            [key: string]: unknown;
                         };
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was created.
                          */
-                        created_at?: string;
+                        created_at: string;
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was updated.
                          */
-                        updated_at?: string;
+                        updated_at: string;
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was deleted.
@@ -2155,28 +2303,35 @@ interface operations {
                 content: {
                     "application/json": {
                         /** Format: uuid */
-                        id?: string;
-                        name?: string;
+                        id: string;
+                        /** @description Name of the workspace. */
+                        name: string;
+                        /** @description Description of the workspace. */
                         description?: string;
                         /**
                          * Format: uuid
-                         * @description Workspace organization ID
+                         * @description Organization to which this workspace belongs.
+                         */
+                        organization_id: string;
+                        /**
+                         * Format: uuid
+                         * @description User ID of the workspace owner.
                          */
-                        organization_id?: string;
                         owner?: string;
+                        /** @description Metadata associated with the workspace. */
                         metadata?: {
-                            [key: string]: string;
+                            [key: string]: unknown;
                         };
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was created.
                          */
-                        created_at?: string;
+                        created_at: string;
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was updated.
                          */
-                        updated_at?: string;
+                        updated_at: string;
                         /**
                          * Format: date-time
                          * @description Timestamp when the resource was deleted.
@@ -2223,6 +2378,10 @@ interface operations {
                      * @description Organization ID.
                      */
                     organization_id: string;
+                    /** @description Metadata associated with the workspace. */
+                    metadata?: {
+                        [key: string]: unknown;
+                    };
                 };
             };
         };
@@ -2369,14 +2528,14 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The workspaces teams mapping of the workspacesteamsmappingpage. */
+                        /** @description Workspace-team mapping entries. */
                         workspacesTeamsMapping?: {
                             /** Format: uuid */
                             id?: string;
                             /** Format: uuid */
-                            team_id?: string;
-                            /** Format: uuid */
                             workspace_id?: string;
+                            /** Format: uuid */
+                            team_id?: string;
                             /**
                              * Format: date-time
                              * @description Timestamp when the resource was created.
@@ -2590,14 +2749,14 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The workspaces environments mapping of the workspacesenvironmentsmappingpage. */
+                        /** @description Workspace-environment mapping entries. */
                         workspacesEnvironmentsMapping?: {
                             /** Format: uuid */
                             id?: string;
                             /** Format: uuid */
-                            environment_id?: string;
-                            /** Format: uuid */
                             workspace_id?: string;
+                            /** Format: uuid */
+                            environment_id?: string;
                             /**
                              * Format: date-time
                              * @description Timestamp when the resource was created.
@@ -2710,7 +2869,7 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The designs of the mesherydesignpage. */
+                        /** @description Designs in this page. */
                         designs?: {
                             catalogData?: {
                                 /** @description Tracks the specific content version that has been made available in the Catalog. */
@@ -2903,11 +3062,11 @@ interface operations {
                                              * Format: uuid
                                              * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
                                              */
-                                            credential_id?: string;
+                                            credentialId?: string;
                                             /** @description Connection Type (platform, telemetry, collaboration) */
                                             type: string;
                                             /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
-                                            sub_type: string;
+                                            subType: string;
                                             /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
                                             kind: string;
                                             /** @description Additional connection metadata */
@@ -4168,14 +4327,14 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The workspaces designs mapping of the workspacesdesignsmappingpage. */
+                        /** @description Workspace-design mapping entries. */
                         workspacesDesignsMapping?: {
                             /** Format: uuid */
                             id?: string;
                             /** Format: uuid */
-                            design_id?: string;
-                            /** Format: uuid */
                             workspace_id?: string;
+                            /** Format: uuid */
+                            design_id?: string;
                             /**
                              * Format: date-time
                              * @description Timestamp when the resource was created.
@@ -4288,18 +4447,26 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The views of the mesheryviewpage. */
+                        /** @description Views in this page. */
                         views?: {
                             /** Format: uuid */
                             id?: string;
+                            /** @description Name of the view. */
                             name?: string;
+                            /** @description Filter configuration for this view. */
                             filters?: {
-                                [key: string]: string;
+                                [key: string]: unknown;
                             };
+                            /** @description Visibility of the view. */
                             visibility?: string;
+                            /** @description Metadata associated with the view. */
                             metadata?: {
-                                [key: string]: string;
+                                [key: string]: unknown;
                             };
+                            /**
+                             * Format: uuid
+                             * @description User ID of the view creator.
+                             */
                             user_id?: string;
                             /**
                              * Format: date-time
@@ -4364,14 +4531,14 @@ interface operations {
                         page?: number;
                         page_size?: number;
                         total_count?: number;
-                        /** @description The workspaces views mapping of the workspacesviewsmappingpage. */
+                        /** @description Workspace-view mapping entries. */
                         workspacesViewsMapping?: {
                             /** Format: uuid */
                             id?: string;
                             /** Format: uuid */
-                            view_id?: string;
-                            /** Format: uuid */
                             workspace_id?: string;
+                            /** Format: uuid */
+                            view_id?: string;
                             /**
                              * Format: date-time
                              * @description Timestamp when the resource was created.