@meshery/schemas 1.0.9 → 1.1.0

package/dist/constructs/v1beta2/key/Key.d.mts

@@ -0,0 +1,523 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/identity/orgs/{orgId}/users/keys": {
+        /** Get all keys based on roles assigned to user */
+        get: operations["getUserKeys"];
+    };
+    "/api/auth/keys": {
+        get: operations["getKeys"];
+        post: operations["upsertKey"];
+    };
+    "/api/auth/key/{keyId}": {
+        get: operations["getKeyById"];
+        delete: operations["deleteKey"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Represents an authorization key used for access control. */
+        Key: {
+            /**
+             * 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.
+             */
+            owner: string;
+            /** @description Operation permitted by the key. */
+            function: string;
+            /** @description Category for the key. */
+            category: string;
+            /** @description Subcategory for the key. */
+            subcategory: string;
+            /** @description Human readable description of the key. */
+            description: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the key was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the key was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the key was soft-deleted.
+             */
+            deletedAt?: string | null;
+        };
+        /** @description Payload for creating or updating a key. */
+        KeyPayload: {
+            /**
+             * 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 Operation permitted by the key. */
+            function?: string;
+            /** @description Category for the key. */
+            category?: string;
+            /** @description Subcategory for the key. */
+            subcategory?: string;
+            /** @description Human readable description of the key. */
+            description?: string;
+        };
+        /** @description A paginated list of authorization keys. */
+        KeyPage: {
+            /** @description Zero-based page index returned in this response. */
+            page: number;
+            /** @description Maximum number of items returned on each page. */
+            pageSize: number;
+            /** @description Total number of items across all pages. */
+            totalCount: number;
+            /** @description Keys returned on the current page. */
+            keys: {
+                /**
+                 * 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.
+                 */
+                owner: string;
+                /** @description Operation permitted by the key. */
+                function: string;
+                /** @description Category for the key. */
+                category: string;
+                /** @description Subcategory for the key. */
+                subcategory: string;
+                /** @description Human readable description of the key. */
+                description: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the key was created.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the key was last updated.
+                 */
+                updatedAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the key was soft-deleted.
+                 */
+                deletedAt?: string | null;
+            }[];
+        };
+    };
+    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 Organization ID */
+        orgId: string;
+        /** @description Key ID */
+        keyId: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
+        /** @description Get ordered responses */
+        order: string;
+        /** @description Get responses that match search param value */
+        search: string;
+    };
+}
+interface operations {
+    /** Get all keys based on roles assigned to user */
+    getUserKeys: {
+        parameters: {
+            path: {
+                /** Organization ID */
+                orgId: string;
+            };
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+            };
+        };
+        responses: {
+            /** Returns user keys based on roles assigned to user */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Zero-based page index returned in this response. */
+                        page: number;
+                        /** @description Maximum number of items returned on each page. */
+                        pageSize: number;
+                        /** @description Total number of items across all pages. */
+                        totalCount: number;
+                        /** @description Keys returned on the current page. */
+                        keys: {
+                            /**
+                             * 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.
+                             */
+                            owner: string;
+                            /** @description Operation permitted by the key. */
+                            function: string;
+                            /** @description Category for the key. */
+                            category: string;
+                            /** @description Subcategory for the key. */
+                            subcategory: string;
+                            /** @description Human readable description of the key. */
+                            description: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the key was created.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the key was last updated.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the key was soft-deleted.
+                             */
+                            deletedAt?: string | null;
+                        }[];
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+    getKeys: {
+        parameters: {
+            query: {
+                /** Get responses by page */
+                page?: string;
+                /** Get responses by pagesize */
+                pagesize?: string;
+                /** Get responses that match search param value */
+                search?: string;
+                /** Get ordered responses */
+                order?: string;
+            };
+        };
+        responses: {
+            /** Keys fetched */
+            200: {
+                content: {
+                    "application/json": {
+                        /** @description Zero-based page index returned in this response. */
+                        page: number;
+                        /** @description Maximum number of items returned on each page. */
+                        pageSize: number;
+                        /** @description Total number of items across all pages. */
+                        totalCount: number;
+                        /** @description Keys returned on the current page. */
+                        keys: {
+                            /**
+                             * 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.
+                             */
+                            owner: string;
+                            /** @description Operation permitted by the key. */
+                            function: string;
+                            /** @description Category for the key. */
+                            category: string;
+                            /** @description Subcategory for the key. */
+                            subcategory: string;
+                            /** @description Human readable description of the key. */
+                            description: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the key was created.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the key was last updated.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the key was soft-deleted.
+                             */
+                            deletedAt?: string | null;
+                        }[];
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+    upsertKey: {
+        responses: {
+            /** Key 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.
+                         */
+                        owner: string;
+                        /** @description Operation permitted by the key. */
+                        function: string;
+                        /** @description Category for the key. */
+                        category: string;
+                        /** @description Subcategory for the key. */
+                        subcategory: string;
+                        /** @description Human readable description of the key. */
+                        description: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the key was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the key was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the key was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** 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;
+                    /** @description Operation permitted by the key. */
+                    function?: string;
+                    /** @description Category for the key. */
+                    category?: string;
+                    /** @description Subcategory for the key. */
+                    subcategory?: string;
+                    /** @description Human readable description of the key. */
+                    description?: string;
+                };
+            };
+        };
+    };
+    getKeyById: {
+        parameters: {
+            path: {
+                /** Key ID */
+                keyId: string;
+            };
+        };
+        responses: {
+            /** Key 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.
+                         */
+                        owner: string;
+                        /** @description Operation permitted by the key. */
+                        function: string;
+                        /** @description Category for the key. */
+                        category: string;
+                        /** @description Subcategory for the key. */
+                        subcategory: string;
+                        /** @description Human readable description of the key. */
+                        description: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the key was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the key was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the key was soft-deleted.
+                         */
+                        deletedAt?: string | null;
+                    };
+                };
+            };
+            /** 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;
+                };
+            };
+        };
+    };
+    deleteKey: {
+        parameters: {
+            path: {
+                /** Key ID */
+                keyId: string;
+            };
+        };
+        responses: {
+            /** Key deleted */
+            204: never;
+            /** 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;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };