@meshery/schemas 1.3.22 → 1.3.23

package/dist/constructs/v1beta2/model/Model.d.ts

@@ -314,7 +314,7 @@ export interface components {
             } & {
                 [key: string]: unknown;
             };
-            /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
+            /** @description Registrant-defined data associated with the model. */
             model: {
                 /** @description Version of the model as defined by the registrant. */
                 version: string;
@@ -465,8 +465,300 @@ export interface components {
             totalCount?: number;
             /** @description The models matching the list-endpoint query. */
             models?: {
-                /** @description Version of the model as defined by the registrant. */
+                /**
+                 * Format: uuid
+                 * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
+                 */
+                id: string;
+                /**
+                 * @description Specifies the version of the schema used for the definition.
+                 * @default models.meshery.io/v1beta2
+                 * @example [
+                 *       "v1",
+                 *       "v1alpha1",
+                 *       "v2beta3",
+                 *       "v1.custom-suffix",
+                 *       "models.meshery.io/v1beta1",
+                 *       "capability.meshery.io/v1alpha1"
+                 *     ]
+                 */
+                schemaVersion: string;
+                /** @description Version of the model definition. */
                 version: string;
+                /**
+                 * @description The unique name for the model within the scope of a registrant.
+                 * @default untitled-model
+                 * @example cert-manager
+                 */
+                name: string;
+                /**
+                 * @description Human-readable name for the model.
+                 * @default Untitled Model
+                 * @example Cert Manager
+                 */
+                displayName: string;
+                /**
+                 * @description Description of the model.
+                 * @default A new Meshery model.
+                 */
+                description: string;
+                /**
+                 * @description Status of model, including:
+                 *     - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
+                 *     - maintenance: model is unavailable for a period of time.
+                 *     - enabled: model is available for use for all users of this Meshery Server.
+                 *     - ignored: model is unavailable for use for all users of this Meshery Server.
+                 * @default enabled
+                 * @enum {string}
+                 */
+                status: "ignored" | "enabled" | "duplicate";
+                /** @description Connection identifying the entity that registered this model. */
+                registrant: {
+                    /**
+                     * Format: uuid
+                     * @description Connection ID
+                     */
+                    id: string;
+                    /** @description Connection Name */
+                    name: string;
+                    /**
+                     * Format: uuid
+                     * @description Associated Credential ID
+                     */
+                    credentialId?: string;
+                    /** @description Connection Type (platform, telemetry, collaboration) */
+                    type: string;
+                    /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
+                    subType: string;
+                    /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
+                    kind: string;
+                    /** @description Additional connection metadata */
+                    metadata?: Record<string, never>;
+                    /**
+                     * @description Connection Status
+                     * @enum {string}
+                     */
+                    status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
+                    /**
+                     * Format: uuid
+                     * @description User ID who owns this connection
+                     */
+                    user_id?: string;
+                    /** Format: date-time */
+                    created_at?: string;
+                    /** Format: date-time */
+                    updated_at?: string;
+                    /**
+                     * Format: date-time
+                     * @description SQL null Timestamp to handle null values of time.
+                     */
+                    deleted_at?: string;
+                    /** @description Associated environments for this connection */
+                    environments?: {
+                        /**
+                         * Format: uuid
+                         * @description ID
+                         */
+                        id: string;
+                        /**
+                         * @description Specifies the version of the schema to which the environment conforms.
+                         * @default environments.meshery.io/v1beta1
+                         * @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
+                         */
+                        organization_id: string;
+                        /**
+                         * Format: uuid
+                         * @description Environment owner
+                         */
+                        owner?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was created.
+                         */
+                        created_at?: string;
+                        /** @description Additional metadata associated with the environment. */
+                        metadata?: Record<string, never>;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was updated.
+                         */
+                        updated_at?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
+                         */
+                        deleted_at?: string | null;
+                    }[];
+                    /**
+                     * @description Specifies the version of the schema used for the definition.
+                     * @default connections.meshery.io/v1beta1
+                     * @example [
+                     *       "v1",
+                     *       "v1alpha1",
+                     *       "v2beta3",
+                     *       "v1.custom-suffix",
+                     *       "models.meshery.io/v1beta1",
+                     *       "capability.meshery.io/v1alpha1"
+                     *     ]
+                     */
+                    schemaVersion: string;
+                };
+                /**
+                 * Format: uuid
+                 * @description ID of the registrant.
+                 */
+                registrantId: string;
+                /**
+                 * Format: uuid
+                 * @description ID of the category.
+                 */
+                categoryId: string;
+                /** @description Category the model belongs to. */
+                category: {
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    id: string;
+                    /**
+                     * @description The category of the model that determines the main grouping.
+                     * @default Uncategorized
+                     * @enum {string}
+                     */
+                    name: "Analytics" | "App Definition and Development" | "Cloud Native Network" | "Cloud Native Storage" | "Database" | "Machine Learning" | "Observability and Analysis" | "Orchestration & Management" | "Platform" | "Provisioning" | "Runtime" | "Security & Compliance" | "Serverless" | "Tools" | "Uncategorized";
+                    /** @description Additional metadata associated with the category. */
+                    metadata: Record<string, never>;
+                };
+                /**
+                 * SubCategory
+                 * @description Sub-category the model belongs to.
+                 * @default Uncategorized
+                 * @enum {string}
+                 */
+                subCategory: "API Gateway" | "API Integration" | "Application Definition & Image Build" | "Automation & Configuration" | "Certified Kubernetes - Distribution" | "Chaos Engineering" | "Cloud Native Storage" | "Cloud Provider" | "CNI" | "Compute" | "Container Registry" | "Container Runtime" | "Container Security" | "Container" | "Content Delivery Network" | "Continuous Integration & Delivery" | "Coordination & Service Discovery" | "Database" | "Flowchart" | "Framework" | "Installable Platform" | "Key Management" | "Key Management Service" | "Kubernetes" | "Logging" | "Machine Learning" | "Management Governance" | "Metrics" | "Monitoring" | "Networking Content Delivery" | "Operating System" | "Query" | "Remote Procedure Call" | "Scheduling & Orchestration" | "Secrets Management" | "Security Identity & Compliance" | "Service Mesh" | "Service Proxy" | "Source Version Control" | "Storage" | "Specifications" | "Streaming & Messaging" | "Tools" | "Tracing" | "Uncategorized" | "Video Conferencing";
+                /** @description Metadata containing additional information associated with the model. */
+                metadata?: {
+                    /** @description Capabilities associated with the model */
+                    capabilities?: {
+                        /**
+                         * @description Specifies the version of the schema to which the capability definition conforms.
+                         * @example [
+                         *       "v1",
+                         *       "v1alpha1",
+                         *       "v2beta3",
+                         *       "v1.custom-suffix",
+                         *       "models.meshery.io/v1beta1",
+                         *       "capability.meshery.io/v1alpha1"
+                         *     ]
+                         */
+                        schemaVersion: string;
+                        /** @description Version of the capability definition. */
+                        version: string;
+                        /** @description Name of the capability in human-readible format. */
+                        displayName: string;
+                        /** @description A written representation of the purpose and characteristics of the capability. */
+                        description: string;
+                        /** @description Top-level categorization of the capability */
+                        kind: string | "action" | "mutate" | "view" | "interaction";
+                        /** @description Classification of capabilities. Used to group capabilities similar in nature. */
+                        type: string;
+                        /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
+                        subType: string;
+                        /** @description Key that backs the capability. */
+                        key: string;
+                        /** @description State of the entity in which the capability is applicable. */
+                        entityState: ("declaration" | "instance")[];
+                        /**
+                         * @description Status of the capability
+                         * @default enabled
+                         * @enum {string}
+                         */
+                        status: "enabled" | "disabled";
+                        /** @description Metadata contains additional information associated with the capability. Extension point. */
+                        metadata?: {
+                            [key: string]: unknown;
+                        };
+                    }[];
+                    /**
+                     * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
+                     * @default false
+                     */
+                    isAnnotation: boolean;
+                    /**
+                     * @description Primary color associated with the model.
+                     * @default #00b39f
+                     */
+                    primaryColor: string;
+                    /**
+                     * @description Secondary color associated with the model.
+                     * @default #00D3A9
+                     */
+                    secondaryColor: string;
+                    /**
+                     * @description SVG representation of the model in white color.
+                     * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
+                     */
+                    svgWhite: string;
+                    /**
+                     * @description SVG representation of the model in colored format.
+                     * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
+                     */
+                    svgColor: string;
+                    /** @description SVG representation of the complete model. */
+                    svgComplete?: string;
+                    /**
+                     * @description Visual shape used to render the model's entities in design canvases.
+                     * @enum {string}
+                     */
+                    shape?: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
+                } & {
+                    [key: string]: unknown;
+                };
+                /** @description Registrant-defined data associated with the model. */
+                model: {
+                    /** @description Version of the model as defined by the registrant. */
+                    version: string;
+                };
+                /** @description The relationships of the model. */
+                relationships: unknown[];
+                /** @description The components of the model. */
+                components: unknown[];
+                /**
+                 * @description Number of components associated with the model.
+                 * @default 0
+                 */
+                componentsCount: number;
+                /**
+                 * @description Number of relationships associated with the model.
+                 * @default 0
+                 */
+                relationshipsCount: number;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the model was created.
+                 */
+                createdAt?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the model was last updated.
+                 */
+                updatedAt?: string;
             }[];
         };
         /** @description Flat canonical representation of the model import form that combines the UI-level uploadType discriminator with the union of fields from the ImportBody oneOf variants. This schema is the authoritative source for the canonical RJSF form schema at schemas/constructs/v1beta2/model/forms/import.json. The server receives an ImportRequest; this form schema captures the superset of user-facing fields so the form schema can be validated as a subset of this canonical type. */
@@ -646,8 +938,300 @@ export interface operations {
                         totalCount?: number;
                         /** @description The models matching the list-endpoint query. */
                         models?: {
-                            /** @description Version of the model as defined by the registrant. */
+                            /**
+                             * Format: uuid
+                             * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
+                             */
+                            id: string;
+                            /**
+                             * @description Specifies the version of the schema used for the definition.
+                             * @default models.meshery.io/v1beta2
+                             * @example [
+                             *       "v1",
+                             *       "v1alpha1",
+                             *       "v2beta3",
+                             *       "v1.custom-suffix",
+                             *       "models.meshery.io/v1beta1",
+                             *       "capability.meshery.io/v1alpha1"
+                             *     ]
+                             */
+                            schemaVersion: string;
+                            /** @description Version of the model definition. */
                             version: string;
+                            /**
+                             * @description The unique name for the model within the scope of a registrant.
+                             * @default untitled-model
+                             * @example cert-manager
+                             */
+                            name: string;
+                            /**
+                             * @description Human-readable name for the model.
+                             * @default Untitled Model
+                             * @example Cert Manager
+                             */
+                            displayName: string;
+                            /**
+                             * @description Description of the model.
+                             * @default A new Meshery model.
+                             */
+                            description: string;
+                            /**
+                             * @description Status of model, including:
+                             *     - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
+                             *     - maintenance: model is unavailable for a period of time.
+                             *     - enabled: model is available for use for all users of this Meshery Server.
+                             *     - ignored: model is unavailable for use for all users of this Meshery Server.
+                             * @default enabled
+                             * @enum {string}
+                             */
+                            status: "ignored" | "enabled" | "duplicate";
+                            /** @description Connection identifying the entity that registered this model. */
+                            registrant: {
+                                /**
+                                 * Format: uuid
+                                 * @description Connection ID
+                                 */
+                                id: string;
+                                /** @description Connection Name */
+                                name: string;
+                                /**
+                                 * Format: uuid
+                                 * @description Associated Credential ID
+                                 */
+                                credentialId?: string;
+                                /** @description Connection Type (platform, telemetry, collaboration) */
+                                type: string;
+                                /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
+                                subType: string;
+                                /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
+                                kind: string;
+                                /** @description Additional connection metadata */
+                                metadata?: Record<string, never>;
+                                /**
+                                 * @description Connection Status
+                                 * @enum {string}
+                                 */
+                                status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
+                                /**
+                                 * Format: uuid
+                                 * @description User ID who owns this connection
+                                 */
+                                user_id?: string;
+                                /** Format: date-time */
+                                created_at?: string;
+                                /** Format: date-time */
+                                updated_at?: string;
+                                /**
+                                 * Format: date-time
+                                 * @description SQL null Timestamp to handle null values of time.
+                                 */
+                                deleted_at?: string;
+                                /** @description Associated environments for this connection */
+                                environments?: {
+                                    /**
+                                     * Format: uuid
+                                     * @description ID
+                                     */
+                                    id: string;
+                                    /**
+                                     * @description Specifies the version of the schema to which the environment conforms.
+                                     * @default environments.meshery.io/v1beta1
+                                     * @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
+                                     */
+                                    organization_id: string;
+                                    /**
+                                     * Format: uuid
+                                     * @description Environment owner
+                                     */
+                                    owner?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the resource was created.
+                                     */
+                                    created_at?: string;
+                                    /** @description Additional metadata associated with the environment. */
+                                    metadata?: Record<string, never>;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the resource was updated.
+                                     */
+                                    updated_at?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
+                                     */
+                                    deleted_at?: string | null;
+                                }[];
+                                /**
+                                 * @description Specifies the version of the schema used for the definition.
+                                 * @default connections.meshery.io/v1beta1
+                                 * @example [
+                                 *       "v1",
+                                 *       "v1alpha1",
+                                 *       "v2beta3",
+                                 *       "v1.custom-suffix",
+                                 *       "models.meshery.io/v1beta1",
+                                 *       "capability.meshery.io/v1alpha1"
+                                 *     ]
+                                 */
+                                schemaVersion: string;
+                            };
+                            /**
+                             * Format: uuid
+                             * @description ID of the registrant.
+                             */
+                            registrantId: string;
+                            /**
+                             * Format: uuid
+                             * @description ID of the category.
+                             */
+                            categoryId: string;
+                            /** @description Category the model belongs to. */
+                            category: {
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                id: string;
+                                /**
+                                 * @description The category of the model that determines the main grouping.
+                                 * @default Uncategorized
+                                 * @enum {string}
+                                 */
+                                name: "Analytics" | "App Definition and Development" | "Cloud Native Network" | "Cloud Native Storage" | "Database" | "Machine Learning" | "Observability and Analysis" | "Orchestration & Management" | "Platform" | "Provisioning" | "Runtime" | "Security & Compliance" | "Serverless" | "Tools" | "Uncategorized";
+                                /** @description Additional metadata associated with the category. */
+                                metadata: Record<string, never>;
+                            };
+                            /**
+                             * SubCategory
+                             * @description Sub-category the model belongs to.
+                             * @default Uncategorized
+                             * @enum {string}
+                             */
+                            subCategory: "API Gateway" | "API Integration" | "Application Definition & Image Build" | "Automation & Configuration" | "Certified Kubernetes - Distribution" | "Chaos Engineering" | "Cloud Native Storage" | "Cloud Provider" | "CNI" | "Compute" | "Container Registry" | "Container Runtime" | "Container Security" | "Container" | "Content Delivery Network" | "Continuous Integration & Delivery" | "Coordination & Service Discovery" | "Database" | "Flowchart" | "Framework" | "Installable Platform" | "Key Management" | "Key Management Service" | "Kubernetes" | "Logging" | "Machine Learning" | "Management Governance" | "Metrics" | "Monitoring" | "Networking Content Delivery" | "Operating System" | "Query" | "Remote Procedure Call" | "Scheduling & Orchestration" | "Secrets Management" | "Security Identity & Compliance" | "Service Mesh" | "Service Proxy" | "Source Version Control" | "Storage" | "Specifications" | "Streaming & Messaging" | "Tools" | "Tracing" | "Uncategorized" | "Video Conferencing";
+                            /** @description Metadata containing additional information associated with the model. */
+                            metadata?: {
+                                /** @description Capabilities associated with the model */
+                                capabilities?: {
+                                    /**
+                                     * @description Specifies the version of the schema to which the capability definition conforms.
+                                     * @example [
+                                     *       "v1",
+                                     *       "v1alpha1",
+                                     *       "v2beta3",
+                                     *       "v1.custom-suffix",
+                                     *       "models.meshery.io/v1beta1",
+                                     *       "capability.meshery.io/v1alpha1"
+                                     *     ]
+                                     */
+                                    schemaVersion: string;
+                                    /** @description Version of the capability definition. */
+                                    version: string;
+                                    /** @description Name of the capability in human-readible format. */
+                                    displayName: string;
+                                    /** @description A written representation of the purpose and characteristics of the capability. */
+                                    description: string;
+                                    /** @description Top-level categorization of the capability */
+                                    kind: string | "action" | "mutate" | "view" | "interaction";
+                                    /** @description Classification of capabilities. Used to group capabilities similar in nature. */
+                                    type: string;
+                                    /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
+                                    subType: string;
+                                    /** @description Key that backs the capability. */
+                                    key: string;
+                                    /** @description State of the entity in which the capability is applicable. */
+                                    entityState: ("declaration" | "instance")[];
+                                    /**
+                                     * @description Status of the capability
+                                     * @default enabled
+                                     * @enum {string}
+                                     */
+                                    status: "enabled" | "disabled";
+                                    /** @description Metadata contains additional information associated with the capability. Extension point. */
+                                    metadata?: {
+                                        [key: string]: unknown;
+                                    };
+                                }[];
+                                /**
+                                 * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
+                                 * @default false
+                                 */
+                                isAnnotation: boolean;
+                                /**
+                                 * @description Primary color associated with the model.
+                                 * @default #00b39f
+                                 */
+                                primaryColor: string;
+                                /**
+                                 * @description Secondary color associated with the model.
+                                 * @default #00D3A9
+                                 */
+                                secondaryColor: string;
+                                /**
+                                 * @description SVG representation of the model in white color.
+                                 * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
+                                 */
+                                svgWhite: string;
+                                /**
+                                 * @description SVG representation of the model in colored format.
+                                 * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
+                                 */
+                                svgColor: string;
+                                /** @description SVG representation of the complete model. */
+                                svgComplete?: string;
+                                /**
+                                 * @description Visual shape used to render the model's entities in design canvases.
+                                 * @enum {string}
+                                 */
+                                shape?: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
+                            } & {
+                                [key: string]: unknown;
+                            };
+                            /** @description Registrant-defined data associated with the model. */
+                            model: {
+                                /** @description Version of the model as defined by the registrant. */
+                                version: string;
+                            };
+                            /** @description The relationships of the model. */
+                            relationships: unknown[];
+                            /** @description The components of the model. */
+                            components: unknown[];
+                            /**
+                             * @description Number of components associated with the model.
+                             * @default 0
+                             */
+                            componentsCount: number;
+                            /**
+                             * @description Number of relationships associated with the model.
+                             * @default 0
+                             */
+                            relationshipsCount: number;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the model was created.
+                             */
+                            createdAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the model was last updated.
+                             */
+                            updatedAt?: string;
                         }[];
                     };
                 };