@meshery/schemas 1.0.9 → 1.1.0

package/dist/constructs/v1beta2/badge/Badge.d.mts

@@ -0,0 +1,564 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/organizations/badges/{badgeId}": {
+        get: operations["getBadgeById"];
+        delete: operations["deleteBadgeById"];
+    };
+    "/api/organizations/badges": {
+        post: operations["createOrUpdateBadge"];
+    };
+    "/api/identity/badges": {
+        get: operations["getAvailableBadges"];
+    };
+    "/api/identity/users/badges": {
+        put: operations["assignBadges"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Payload for creating or updating a badge. */
+        BadgePayload: {
+            /**
+             * 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;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            orgId: string;
+            /**
+             * @description Unique identifier for the badge, typically slug-style (auto generated).
+             * @example Kubernetes-Expert
+             */
+            label: string;
+            /**
+             * @description Concise descriptor for the badge or certificate.
+             * @example Kubernetes Expert
+             */
+            name: string;
+            /**
+             * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+             * @example Awarded for mastering Kubernetes concepts and practices.
+             */
+            description: string;
+            /**
+             * Format: uri
+             * @description URL to the badge image.
+             * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+             */
+            imageUrl: string;
+        };
+        /** @description Badge entity — a named recognition issued within an organization. */
+        Badge: {
+            /**
+             * 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;
+            /**
+             * Format: uuid
+             * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+             */
+            orgId: string;
+            /**
+             * @description Unique identifier for the badge, typically slug-style (auto generated).
+             * @example Kubernetes-Expert
+             */
+            label: string;
+            /**
+             * @description Concise descriptor for the badge or certificate.
+             * @example Kubernetes Expert
+             */
+            name: string;
+            /**
+             * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+             * @example Awarded for mastering Kubernetes concepts and practices.
+             */
+            description: string;
+            /**
+             * Format: uri
+             * @description URL to the badge image.
+             * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+             */
+            imageUrl: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the badge was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the badge was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the badge was soft-deleted, if applicable.
+             */
+            deletedAt: string;
+        };
+        /** @description Map of badges available in an organization, keyed by badge label. */
+        BadgesPage: {
+            /** @description Available badges, keyed by badge label. */
+            badges?: {
+                [key: string]: {
+                    /**
+                     * 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;
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    orgId: string;
+                    /**
+                     * @description Unique identifier for the badge, typically slug-style (auto generated).
+                     * @example Kubernetes-Expert
+                     */
+                    label: string;
+                    /**
+                     * @description Concise descriptor for the badge or certificate.
+                     * @example Kubernetes Expert
+                     */
+                    name: string;
+                    /**
+                     * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+                     * @example Awarded for mastering Kubernetes concepts and practices.
+                     */
+                    description: string;
+                    /**
+                     * Format: uri
+                     * @description URL to the badge image.
+                     * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+                     */
+                    imageUrl: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the badge was created.
+                     */
+                    createdAt: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the badge was last updated.
+                     */
+                    updatedAt: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the badge was soft-deleted, if applicable.
+                     */
+                    deletedAt: string;
+                };
+            };
+        };
+        /** @description Payload for assigning a set of badges to a user. */
+        BadgeAssignmentPayload: {
+            /** @description Labels of the badges being assigned to the user. */
+            badges: string[];
+            /**
+             * Format: uuid
+             * @description ID of the user to receive the badges.
+             */
+            userId: string;
+            /** @description When true, send a notification to the user about the new badge assignment. */
+            notify?: boolean;
+        };
+    };
+    responses: {
+        /** Invalid request body or request param */
+        400: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Expired JWT token used or insufficient privilege */
+        401: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Result not found */
+        404: {
+            content: {
+                "text/plain": string;
+            };
+        };
+        /** Internal server error */
+        500: {
+            content: {
+                "text/plain": string;
+            };
+        };
+    };
+    parameters: {
+        /** @description Badge ID */
+        badgeId: string;
+        /** @description Organization ID to scope the badge listing to. */
+        orgIdQuery: string;
+    };
+}
+interface operations {
+    getBadgeById: {
+        parameters: {
+            path: {
+                /** Badge ID */
+                badgeId: string;
+            };
+        };
+        responses: {
+            /** Badge response */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * 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;
+                        /**
+                         * Format: uuid
+                         * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                         */
+                        orgId: string;
+                        /**
+                         * @description Unique identifier for the badge, typically slug-style (auto generated).
+                         * @example Kubernetes-Expert
+                         */
+                        label: string;
+                        /**
+                         * @description Concise descriptor for the badge or certificate.
+                         * @example Kubernetes Expert
+                         */
+                        name: string;
+                        /**
+                         * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+                         * @example Awarded for mastering Kubernetes concepts and practices.
+                         */
+                        description: string;
+                        /**
+                         * Format: uri
+                         * @description URL to the badge image.
+                         * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+                         */
+                        imageUrl: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the badge was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the badge was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the badge was soft-deleted, if applicable.
+                         */
+                        deletedAt: string;
+                    };
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    deleteBadgeById: {
+        parameters: {
+            path: {
+                /** Badge ID */
+                badgeId: string;
+            };
+        };
+        responses: {
+            /** Badge deleted */
+            204: never;
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    createOrUpdateBadge: {
+        responses: {
+            /** Badge upserted */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * 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;
+                        /**
+                         * Format: uuid
+                         * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                         */
+                        orgId: string;
+                        /**
+                         * @description Unique identifier for the badge, typically slug-style (auto generated).
+                         * @example Kubernetes-Expert
+                         */
+                        label: string;
+                        /**
+                         * @description Concise descriptor for the badge or certificate.
+                         * @example Kubernetes Expert
+                         */
+                        name: string;
+                        /**
+                         * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+                         * @example Awarded for mastering Kubernetes concepts and practices.
+                         */
+                        description: string;
+                        /**
+                         * Format: uri
+                         * @description URL to the badge image.
+                         * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+                         */
+                        imageUrl: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the badge was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the badge was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the badge was soft-deleted, if applicable.
+                         */
+                        deletedAt: string;
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /**
+                     * 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;
+                    /**
+                     * Format: uuid
+                     * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                     */
+                    orgId: string;
+                    /**
+                     * @description Unique identifier for the badge, typically slug-style (auto generated).
+                     * @example Kubernetes-Expert
+                     */
+                    label: string;
+                    /**
+                     * @description Concise descriptor for the badge or certificate.
+                     * @example Kubernetes Expert
+                     */
+                    name: string;
+                    /**
+                     * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+                     * @example Awarded for mastering Kubernetes concepts and practices.
+                     */
+                    description: string;
+                    /**
+                     * Format: uri
+                     * @description URL to the badge image.
+                     * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+                     */
+                    imageUrl: string;
+                };
+            };
+        };
+    };
+    getAvailableBadges: {
+        parameters: {
+            query: {
+                /** Organization ID to scope the badge listing to. */
+                orgId?: string;
+            };
+        };
+        responses: {
+            /** Available badges */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Available badges, keyed by badge label. */
+                        badges?: {
+                            [key: string]: {
+                                /**
+                                 * 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;
+                                /**
+                                 * Format: uuid
+                                 * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
+                                 */
+                                orgId: string;
+                                /**
+                                 * @description Unique identifier for the badge, typically slug-style (auto generated).
+                                 * @example Kubernetes-Expert
+                                 */
+                                label: string;
+                                /**
+                                 * @description Concise descriptor for the badge or certificate.
+                                 * @example Kubernetes Expert
+                                 */
+                                name: string;
+                                /**
+                                 * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+                                 * @example Awarded for mastering Kubernetes concepts and practices.
+                                 */
+                                description: string;
+                                /**
+                                 * Format: uri
+                                 * @description URL to the badge image.
+                                 * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+                                 */
+                                imageUrl: string;
+                                /**
+                                 * Format: date-time
+                                 * @description Timestamp when the badge was created.
+                                 */
+                                createdAt: string;
+                                /**
+                                 * Format: date-time
+                                 * @description Timestamp when the badge was last updated.
+                                 */
+                                updatedAt: string;
+                                /**
+                                 * Format: date-time
+                                 * @description Timestamp when the badge was soft-deleted, if applicable.
+                                 */
+                                deletedAt: string;
+                            };
+                        };
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    assignBadges: {
+        responses: {
+            /** Badge assignment result */
+            200: {
+                content: {
+                    "application/json": {
+                        [key: string]: unknown;
+                    };
+                };
+            };
+            /** Invalid request body or request param */
+            400: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description Labels of the badges being assigned to the user. */
+                    badges: string[];
+                    /**
+                     * Format: uuid
+                     * @description ID of the user to receive the badges.
+                     */
+                    userId: string;
+                    /** @description When true, send a notification to the user about the new badge assignment. */
+                    notify?: boolean;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };