@meshery/schemas 1.0.3 → 1.0.4

package/dist/cloudApi.d.mts

@@ -2586,17 +2586,27 @@ type GetWorkspacesApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces of the workspacepage. */
+    /** List of workspaces with resolved owner details. */
     workspaces?: {
         id?: string;
+        /** Name of the workspace. */
         name?: string;
+        /** Description of the workspace. */
         description?: string;
-        /** Workspace organization ID */
-        organization_id?: string;
+        /** Name of the owning organization. */
+        org_name?: string;
+        /** Display name of the workspace owner. */
         owner?: string;
-        metadata?: {
-            [key: string]: string;
-        };
+        /** User ID of the workspace owner. */
+        owner_id?: string;
+        /** Email address of the workspace owner. */
+        owner_email?: string;
+        /** Avatar URL of the workspace owner. */
+        owner_avatar?: string;
+        /** Metadata associated with the workspace. */
+        metadata?: object;
+        /** Organization to which this workspace belongs. */
+        organization_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -2618,19 +2628,21 @@ type GetWorkspacesApiArg = {
     filter?: string;
 };
 type CreateWorkspaceApiResponse = {
-    id?: string;
-    name?: string;
+    id: string;
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
     description?: string;
-    /** Workspace organization ID */
-    organization_id?: string;
+    /** Organization to which this workspace belongs. */
+    organization_id: string;
+    /** User ID of the workspace owner. */
     owner?: string;
-    metadata?: {
-        [key: string]: string;
-    };
+    /** Metadata associated with the workspace. */
+    metadata?: object;
     /** Timestamp when the resource was created. */
-    created_at?: string;
+    created_at: string;
     /** Timestamp when the resource was updated. */
-    updated_at?: string;
+    updated_at: string;
     /** Timestamp when the resource was deleted. */
     deleted_at?: string;
 };
@@ -2643,22 +2655,26 @@ type CreateWorkspaceApiArg = {
         description?: string;
         /** Organization ID. */
         organization_id: string;
+        /** Metadata associated with the workspace. */
+        metadata?: object;
     };
 };
 type GetWorkspaceByIdApiResponse = {
-    id?: string;
-    name?: string;
+    id: string;
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
     description?: string;
-    /** Workspace organization ID */
-    organization_id?: string;
+    /** Organization to which this workspace belongs. */
+    organization_id: string;
+    /** User ID of the workspace owner. */
     owner?: string;
-    metadata?: {
-        [key: string]: string;
-    };
+    /** Metadata associated with the workspace. */
+    metadata?: object;
     /** Timestamp when the resource was created. */
-    created_at?: string;
+    created_at: string;
     /** Timestamp when the resource was updated. */
-    updated_at?: string;
+    updated_at: string;
     /** Timestamp when the resource was deleted. */
     deleted_at?: string;
 };
@@ -2667,19 +2683,21 @@ type GetWorkspaceByIdApiArg = {
     workspaceId: string;
 };
 type UpdateWorkspaceApiResponse = {
-    id?: string;
-    name?: string;
+    id: string;
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
     description?: string;
-    /** Workspace organization ID */
-    organization_id?: string;
+    /** Organization to which this workspace belongs. */
+    organization_id: string;
+    /** User ID of the workspace owner. */
     owner?: string;
-    metadata?: {
-        [key: string]: string;
-    };
+    /** Metadata associated with the workspace. */
+    metadata?: object;
     /** Timestamp when the resource was created. */
-    created_at?: string;
+    created_at: string;
     /** Timestamp when the resource was updated. */
-    updated_at?: string;
+    updated_at: string;
     /** Timestamp when the resource was deleted. */
     deleted_at?: string;
 };
@@ -2694,6 +2712,8 @@ type UpdateWorkspaceApiArg = {
         description?: string;
         /** Organization ID. */
         organization_id: string;
+        /** Metadata associated with the workspace. */
+        metadata?: object;
     };
 };
 type DeleteWorkspaceApiResponse = unknown;
@@ -2741,11 +2761,11 @@ type AssignTeamToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces teams mapping of the workspacesteamsmappingpage. */
+    /** Workspace-team mapping entries. */
     workspacesTeamsMapping?: {
         id?: string;
-        team_id?: string;
         workspace_id?: string;
+        team_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -2813,11 +2833,11 @@ type AssignEnvironmentToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces environments mapping of the workspacesenvironmentsmappingpage. */
+    /** Workspace-environment mapping entries. */
     workspacesEnvironmentsMapping?: {
         id?: string;
-        environment_id?: string;
         workspace_id?: string;
+        environment_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -2843,7 +2863,7 @@ type GetDesignsOfWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The designs of the mesherydesignpage. */
+    /** Designs in this page. */
     designs?: {
         catalogData?: {
             /** Tracks the specific content version that has been made available in the Catalog. */
@@ -3722,11 +3742,11 @@ type AssignDesignToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces designs mapping of the workspacesdesignsmappingpage. */
+    /** Workspace-design mapping entries. */
     workspacesDesignsMapping?: {
         id?: string;
-        design_id?: string;
         workspace_id?: string;
+        design_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -3752,17 +3772,18 @@ type GetViewsOfWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The views of the mesheryviewpage. */
+    /** Views in this page. */
     views?: {
         id?: string;
+        /** Name of the view. */
         name?: string;
-        filters?: {
-            [key: string]: string;
-        };
+        /** Filter configuration for this view. */
+        filters?: object;
+        /** Visibility of the view. */
         visibility?: string;
-        metadata?: {
-            [key: string]: string;
-        };
+        /** Metadata associated with the view. */
+        metadata?: object;
+        /** User ID of the view creator. */
         user_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
@@ -3790,11 +3811,11 @@ type AssignViewToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces views mapping of the workspacesviewsmappingpage. */
+    /** Workspace-view mapping entries. */
     workspacesViewsMapping?: {
         id?: string;
-        view_id?: string;
         workspace_id?: string;
+        view_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */

package/dist/cloudApi.d.ts

@@ -2586,17 +2586,27 @@ type GetWorkspacesApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces of the workspacepage. */
+    /** List of workspaces with resolved owner details. */
     workspaces?: {
         id?: string;
+        /** Name of the workspace. */
         name?: string;
+        /** Description of the workspace. */
         description?: string;
-        /** Workspace organization ID */
-        organization_id?: string;
+        /** Name of the owning organization. */
+        org_name?: string;
+        /** Display name of the workspace owner. */
         owner?: string;
-        metadata?: {
-            [key: string]: string;
-        };
+        /** User ID of the workspace owner. */
+        owner_id?: string;
+        /** Email address of the workspace owner. */
+        owner_email?: string;
+        /** Avatar URL of the workspace owner. */
+        owner_avatar?: string;
+        /** Metadata associated with the workspace. */
+        metadata?: object;
+        /** Organization to which this workspace belongs. */
+        organization_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -2618,19 +2628,21 @@ type GetWorkspacesApiArg = {
     filter?: string;
 };
 type CreateWorkspaceApiResponse = {
-    id?: string;
-    name?: string;
+    id: string;
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
     description?: string;
-    /** Workspace organization ID */
-    organization_id?: string;
+    /** Organization to which this workspace belongs. */
+    organization_id: string;
+    /** User ID of the workspace owner. */
     owner?: string;
-    metadata?: {
-        [key: string]: string;
-    };
+    /** Metadata associated with the workspace. */
+    metadata?: object;
     /** Timestamp when the resource was created. */
-    created_at?: string;
+    created_at: string;
     /** Timestamp when the resource was updated. */
-    updated_at?: string;
+    updated_at: string;
     /** Timestamp when the resource was deleted. */
     deleted_at?: string;
 };
@@ -2643,22 +2655,26 @@ type CreateWorkspaceApiArg = {
         description?: string;
         /** Organization ID. */
         organization_id: string;
+        /** Metadata associated with the workspace. */
+        metadata?: object;
     };
 };
 type GetWorkspaceByIdApiResponse = {
-    id?: string;
-    name?: string;
+    id: string;
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
     description?: string;
-    /** Workspace organization ID */
-    organization_id?: string;
+    /** Organization to which this workspace belongs. */
+    organization_id: string;
+    /** User ID of the workspace owner. */
     owner?: string;
-    metadata?: {
-        [key: string]: string;
-    };
+    /** Metadata associated with the workspace. */
+    metadata?: object;
     /** Timestamp when the resource was created. */
-    created_at?: string;
+    created_at: string;
     /** Timestamp when the resource was updated. */
-    updated_at?: string;
+    updated_at: string;
     /** Timestamp when the resource was deleted. */
     deleted_at?: string;
 };
@@ -2667,19 +2683,21 @@ type GetWorkspaceByIdApiArg = {
     workspaceId: string;
 };
 type UpdateWorkspaceApiResponse = {
-    id?: string;
-    name?: string;
+    id: string;
+    /** Name of the workspace. */
+    name: string;
+    /** Description of the workspace. */
     description?: string;
-    /** Workspace organization ID */
-    organization_id?: string;
+    /** Organization to which this workspace belongs. */
+    organization_id: string;
+    /** User ID of the workspace owner. */
     owner?: string;
-    metadata?: {
-        [key: string]: string;
-    };
+    /** Metadata associated with the workspace. */
+    metadata?: object;
     /** Timestamp when the resource was created. */
-    created_at?: string;
+    created_at: string;
     /** Timestamp when the resource was updated. */
-    updated_at?: string;
+    updated_at: string;
     /** Timestamp when the resource was deleted. */
     deleted_at?: string;
 };
@@ -2694,6 +2712,8 @@ type UpdateWorkspaceApiArg = {
         description?: string;
         /** Organization ID. */
         organization_id: string;
+        /** Metadata associated with the workspace. */
+        metadata?: object;
     };
 };
 type DeleteWorkspaceApiResponse = unknown;
@@ -2741,11 +2761,11 @@ type AssignTeamToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces teams mapping of the workspacesteamsmappingpage. */
+    /** Workspace-team mapping entries. */
     workspacesTeamsMapping?: {
         id?: string;
-        team_id?: string;
         workspace_id?: string;
+        team_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -2813,11 +2833,11 @@ type AssignEnvironmentToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces environments mapping of the workspacesenvironmentsmappingpage. */
+    /** Workspace-environment mapping entries. */
     workspacesEnvironmentsMapping?: {
         id?: string;
-        environment_id?: string;
         workspace_id?: string;
+        environment_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -2843,7 +2863,7 @@ type GetDesignsOfWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The designs of the mesherydesignpage. */
+    /** Designs in this page. */
     designs?: {
         catalogData?: {
             /** Tracks the specific content version that has been made available in the Catalog. */
@@ -3722,11 +3742,11 @@ type AssignDesignToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces designs mapping of the workspacesdesignsmappingpage. */
+    /** Workspace-design mapping entries. */
     workspacesDesignsMapping?: {
         id?: string;
-        design_id?: string;
         workspace_id?: string;
+        design_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */
@@ -3752,17 +3772,18 @@ type GetViewsOfWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The views of the mesheryviewpage. */
+    /** Views in this page. */
     views?: {
         id?: string;
+        /** Name of the view. */
         name?: string;
-        filters?: {
-            [key: string]: string;
-        };
+        /** Filter configuration for this view. */
+        filters?: object;
+        /** Visibility of the view. */
         visibility?: string;
-        metadata?: {
-            [key: string]: string;
-        };
+        /** Metadata associated with the view. */
+        metadata?: object;
+        /** User ID of the view creator. */
         user_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
@@ -3790,11 +3811,11 @@ type AssignViewToWorkspaceApiResponse = {
     page?: number;
     page_size?: number;
     total_count?: number;
-    /** The workspaces views mapping of the workspacesviewsmappingpage. */
+    /** Workspace-view mapping entries. */
     workspacesViewsMapping?: {
         id?: string;
-        view_id?: string;
         workspace_id?: string;
+        view_id?: string;
         /** Timestamp when the resource was created. */
         created_at?: string;
         /** Timestamp when the resource was updated. */