@meshery/schemas 1.3.44 → 1.3.46

package/dist/constructs/v1beta3/design/Design.d.ts

@@ -1456,12 +1456,13 @@ export interface components {
                                  *     merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
                                  *     strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
                                  *     remove: Removes a value.
+                                 *     replace: Replaces the value at the target location.
                                  *     copy: Copies a value from one location to another.
                                  *     move: Moves a value from one location to another.
                                  *     test: Tests that a value at the target location is equal to a specified value.
                                  * @enum {string}
                                  */
-                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
+                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
                                 /** @description JSON ref to value from where patch should be applied. */
                                 mutatorRef?: string[][];
                                 mutatedRef?: string[][];
@@ -1547,12 +1548,13 @@ export interface components {
                                  *     merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
                                  *     strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
                                  *     remove: Removes a value.
+                                 *     replace: Replaces the value at the target location.
                                  *     copy: Copies a value from one location to another.
                                  *     move: Moves a value from one location to another.
                                  *     test: Tests that a value at the target location is equal to a specified value.
                                  * @enum {string}
                                  */
-                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
+                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
                                 /** @description JSON ref to value from where patch should be applied. */
                                 mutatorRef?: string[][];
                                 mutatedRef?: string[][];
@@ -1641,12 +1643,13 @@ export interface components {
                                  *     merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
                                  *     strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
                                  *     remove: Removes a value.
+                                 *     replace: Replaces the value at the target location.
                                  *     copy: Copies a value from one location to another.
                                  *     move: Moves a value from one location to another.
                                  *     test: Tests that a value at the target location is equal to a specified value.
                                  * @enum {string}
                                  */
-                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
+                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
                                 /** @description JSON ref to value from where patch should be applied. */
                                 mutatorRef?: string[][];
                                 mutatedRef?: string[][];
@@ -1732,12 +1735,13 @@ export interface components {
                                  *     merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
                                  *     strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
                                  *     remove: Removes a value.
+                                 *     replace: Replaces the value at the target location.
                                  *     copy: Copies a value from one location to another.
                                  *     move: Moves a value from one location to another.
                                  *     test: Tests that a value at the target location is equal to a specified value.
                                  * @enum {string}
                                  */
-                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
+                                patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
                                 /** @description JSON ref to value from where patch should be applied. */
                                 mutatorRef?: string[][];
                                 mutatedRef?: string[][];
@@ -6000,15 +6004,375 @@ export interface operations {
             };
         };
         responses: {
-            /** @description Successful Import */
+            /** @description Successful import. The response body is a JSON array of the saved designs, not a message envelope. The import path saves exactly one design, so the array carries a single element and consumers read the imported design as the first element. */
             200: {
                 headers: {
                     [name: string]: unknown;
                 };
                 content: {
                     "application/json": {
-                        message?: string;
-                    };
+                        /**
+                         * Format: uuid
+                         * @description Server-generated design ID.
+                         */
+                        id?: string;
+                        /** @description Human-readable design name. */
+                        name?: string;
+                        /** @description Catalog metadata attached to the design when published. */
+                        catalogData?: {
+                            /** @description Tracks the specific content version that has been made available in the Catalog. */
+                            publishedVersion?: string;
+                            /** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
+                            class?: string & ("official" | "verified" | "reference architecture");
+                            /**
+                             * Model
+                             * @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
+                             */
+                            compatibility: "kubernetes"[];
+                            /**
+                             * Caveats and Considerations
+                             * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
+                             */
+                            patternCaveats: string;
+                            /**
+                             * Description
+                             * @description Purpose of the design along with its intended and unintended uses.
+                             */
+                            patternInfo: string;
+                            /**
+                             * Type
+                             * @description Categorization of the type of design or operational flow depicted in this design.
+                             * @default Deployment
+                             * @enum {string}
+                             */
+                            type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
+                            /** @description Contains reference to the dark and light mode snapshots of the design. */
+                            snapshotURL?: string[];
+                        };
+                        /**
+                         * Format: uuid
+                         * @description Owning user ID.
+                         */
+                        userId?: string;
+                        /** @description Owning user record, joined inline by the catalog list/get handlers when shaping responses. Server-projected from the users table via the design's userId; not a column on the meshery_patterns table itself, so the generated Go field is tagged `db:"-"` to keep it out of ORM column scans. */
+                        user?: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the user
+                             */
+                            id: string;
+                            /**
+                             * @deprecated
+                             * @description Legacy IdP-derived identifier. Removed in v1beta3; resolve users by id or email.
+                             */
+                            userId: string;
+                            /**
+                             * @description Authentication provider (e.g., Google, Github)
+                             * @example [
+                             *       "local",
+                             *       "github",
+                             *       "google",
+                             *       "twitter"
+                             *     ]
+                             */
+                            provider: string;
+                            /**
+                             * Format: email
+                             * @description User's email address
+                             */
+                            email: string;
+                            /** @description User's first name */
+                            firstName: string;
+                            /** @description User's last name */
+                            lastName: string;
+                            /**
+                             * Format: uri
+                             * @description URL to user's avatar image
+                             */
+                            avatarUrl?: string;
+                            /**
+                             * @description User account status
+                             * @enum {string}
+                             */
+                            status: "active" | "inactive" | "pending" | "anonymous";
+                            /**
+                             * @description User's biography or description
+                             * @default
+                             */
+                            bio: string;
+                            /** @description User's country information stored as JSONB */
+                            country?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description User's region information stored as JSONB */
+                            region?: {
+                                [key: string]: unknown;
+                            };
+                            /** @description User preferences stored as JSONB */
+                            preferences?: {
+                                /** @description The mesh adapters of the preference. */
+                                meshAdapters?: Record<string, never>[];
+                                grafana?: {
+                                    /** @description Grafana URL for the user configuration. */
+                                    grafanaUrl?: string;
+                                    /** @description Grafana API key for the user configuration. */
+                                    grafanaApiKey?: string;
+                                    /** @description Selected Grafana board configurations for the user. */
+                                    selectedBoardsConfigs?: {
+                                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                                        board?: Record<string, never>;
+                                        /** @description Panels selected for the Grafana board configuration. */
+                                        panels?: Record<string, never>[];
+                                        /** @description Template variables applied to the selected Grafana board configuration. */
+                                        templateVars?: string[];
+                                    }[];
+                                };
+                                prometheus?: {
+                                    /** @description The prometheus URL of the prometheus. */
+                                    prometheusUrl?: string;
+                                    /** @description The selected prometheus boards configs of the prometheus. */
+                                    selectedPrometheusBoardsConfigs?: {
+                                        /** @description Placeholder for GrafanaBoard definition (define fields as needed) */
+                                        board?: Record<string, never>;
+                                        /** @description Panels selected for the Grafana board configuration. */
+                                        panels?: Record<string, never>[];
+                                        /** @description Template variables applied to the selected Grafana board configuration. */
+                                        templateVars?: string[];
+                                    }[];
+                                };
+                                loadTestPrefs?: {
+                                    /** @description Concurrent requests */
+                                    c?: number;
+                                    /** @description Queries per second */
+                                    qps?: number;
+                                    /** @description Duration */
+                                    t?: string;
+                                    /** @description Load generator */
+                                    gen?: string;
+                                };
+                                /** @description The anonymous usage stats of the preference. */
+                                anonymousUsageStats: boolean;
+                                /** @description The anonymous perf results of the preference. */
+                                anonymousPerfResults: boolean;
+                                /**
+                                 * Format: date-time
+                                 * @description Timestamp of when the resource was last updated.
+                                 */
+                                updatedAt: string;
+                                /** @description The dashboard preferences of the preference. */
+                                dashboardPreferences: {
+                                    [key: string]: unknown;
+                                };
+                                /**
+                                 * Format: uuid
+                                 * @description ID of the associated selectedOrganization.
+                                 */
+                                selectedOrganizationId: string;
+                                /** @description The selected workspace for organizations of the preference. */
+                                selectedWorkspaceForOrganizations: {
+                                    [key: string]: string;
+                                };
+                                /** @description The users extension preferences of the preference. */
+                                usersExtensionPreferences: {
+                                    [key: string]: unknown;
+                                };
+                                /** @description The remote provider preferences of the preference. */
+                                remoteProviderPreferences: {
+                                    [key: string]: unknown;
+                                };
+                            };
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when user accepted terms and conditions
+                             */
+                            acceptedTermsAt?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of user's first login
+                             */
+                            firstLoginTime?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp of user's most recent login
+                             */
+                            lastLoginTime: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the user record was created
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the user record was last updated
+                             */
+                            updatedAt: string;
+                            /** @description Various online profiles associated with the user account */
+                            socials?: {
+                                /** @description The site of the social. */
+                                site: string;
+                                /**
+                                 * Format: uri
+                                 * @description The link of the social.
+                                 */
+                                link: string;
+                            }[];
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the user record was soft-deleted (null if not deleted)
+                             */
+                            deletedAt: string | null;
+                            /**
+                             * @description Names of the global roles assigned to the user. Free-form, user-generated values sourced from the roles table (role_name is a varchar, not a fixed enumeration); the seeded system roles such as "admin", "organization admin" and "user" are a subset, not the whole set.
+                             * @example [
+                             *       "organization admin",
+                             *       "user"
+                             *     ]
+                             */
+                            roleNames?: string[];
+                            /** @description Teams the user belongs to with role information */
+                            teams?: {
+                                /** @description Team memberships for the user with their assigned roles. */
+                                teamsWithRoles?: {
+                                    /**
+                                     * Format: uuid
+                                     * @description Unique identifier of the team.
+                                     */
+                                    id: string;
+                                    /** @description Name of the team. */
+                                    name: string;
+                                    /** @description Human readable description of the team. */
+                                    description?: string;
+                                    /**
+                                     * Format: uuid
+                                     * @description Identifier of the team owner.
+                                     */
+                                    owner?: string;
+                                    /** @description Free-form metadata associated with the team. */
+                                    metadata?: {
+                                        [key: string]: unknown;
+                                    };
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the team was created.
+                                     */
+                                    createdAt?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the team was last updated.
+                                     */
+                                    updatedAt?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the team was soft-deleted (null if not deleted).
+                                     */
+                                    deletedAt?: string | null;
+                                    /** @description Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
+                                    roleNames: string[];
+                                }[];
+                                /** @description Total number of team memberships returned for the user. */
+                                totalCount?: number;
+                            };
+                            /** @description Organizations the user belongs to with role information */
+                            organizations?: {
+                                /** @description Organization memberships for the user with their assigned roles. */
+                                organizationsWithRoles?: {
+                                    /**
+                                     * Format: uuid
+                                     * @description Unique identifier of the organization.
+                                     */
+                                    id: string;
+                                    /** @description Name of the organization. */
+                                    name: string;
+                                    /** @description Human readable description of the organization. */
+                                    description?: string;
+                                    /** @description Country associated with the organization. */
+                                    country?: string;
+                                    /** @description Region associated with the organization. */
+                                    region?: string;
+                                    /**
+                                     * Format: uuid
+                                     * @description Identifier of the organization owner.
+                                     */
+                                    owner?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the organization was created.
+                                     */
+                                    createdAt?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the organization was last updated.
+                                     */
+                                    updatedAt?: string;
+                                    /**
+                                     * Format: date-time
+                                     * @description Timestamp when the organization was soft-deleted (null if not deleted).
+                                     */
+                                    deletedAt?: string | null;
+                                    /** @description Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
+                                    roleNames: string[];
+                                }[];
+                                /** @description Total number of organization memberships returned for the user. */
+                                totalCount?: number;
+                            };
+                        } | null;
+                        /** @description Optional structured location metadata (branch, host, path, ...). */
+                        location?: {
+                            [key: string]: string;
+                        };
+                        /** @description Raw design body as it is persisted in the meshery_patterns table's `pattern_file` column. The wire form is the YAML/JSON string the server stores verbatim; consumers that need the structured form transcode at the boundary by parsing the string into a PatternFile (see #/components/schemas/PatternFile) and marshalling it back when they write. Keeping the wire shape as a string mirrors the column's actual representation and avoids forcing every consumer through the structured-vs- string union that the previous *PatternFile typing implied. */
+                        patternFile?: string;
+                        /**
+                         * @description Visibility scope of the design — controls whether non-owners may read or list it. `private` is owner-only, `public` is readable by anyone in the org, and `published` is visible in the catalog.
+                         * @enum {string}
+                         */
+                        visibility?: "private" | "public" | "published";
+                        /**
+                         * @description Discriminator identifying the source format of the design body, persisted in the meshery_patterns table's `source_type` column (nullable; null for legacy rows imported before the column was introduced). For catalog listings the server may also project this field from the attached catalog metadata. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+                         * @enum {string|null}
+                         */
+                        designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest" | null;
+                        /**
+                         * Format: byte
+                         * @description Raw bytes of the imported source artifact (Helm chart tarball, Kubernetes manifest, Docker Compose file, etc.) preserved in the meshery_patterns table's `source_content` column for non-Meshery-Design imports. Empty / null for native Meshery designs. Server-managed: populated by the import and upload handlers and scrubbed to null on most read responses, so clients should treat this as opaque base64-encoded bytes when it does appear on the wire.
+                         */
+                        sourceContent?: string | null;
+                        /**
+                         * @description Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+                         * @default 0
+                         */
+                        viewCount: number;
+                        /**
+                         * @description Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+                         * @default 0
+                         */
+                        downloadCount: number;
+                        /**
+                         * @description Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+                         * @default 0
+                         */
+                        cloneCount: number;
+                        /**
+                         * @description Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+                         * @default 0
+                         */
+                        deploymentCount: number;
+                        /**
+                         * @description Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+                         * @default 0
+                         */
+                        shareCount: number;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of design creation.
+                         */
+                        createdAt?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp of last design modification.
+                         */
+                        updatedAt?: string;
+                    }[];
                 };
             };
             /** @description Invalid request format */