@meshery/schemas 1.0.9 → 1.1.0

package/dist/constructs/v1beta2/keychain/Keychain.d.ts

@@ -0,0 +1,651 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/auth/keychains": {
+        get: operations["getKeychains"];
+        post: operations["createKeychain"];
+    };
+    "/api/auth/keychains/{keychainId}": {
+        get: operations["getKeychainById"];
+        put: operations["updateKeychain"];
+        delete: operations["deleteKeychain"];
+    };
+    "/api/auth/keychains/{keychainId}/{keyId}": {
+        post: operations["addKeyToKeychain"];
+        delete: operations["removeKeyFromKeychain"];
+    };
+    "/api/auth/keychains/{keychainId}/keys": {
+        get: operations["getKeysOfKeychain"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Represents a collection of keys. */
+        Keychain: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the keychain.
+             */
+            id: string;
+            /** @description Name of the keychain. */
+            name: string;
+            /**
+             * Format: uuid
+             * @description Owner of the keychain.
+             */
+            owner: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the keychain was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the keychain was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the keychain was soft-deleted.
+             */
+            deletedAt?: string | null;
+        };
+        /** @description Payload for creating or updating a keychain. */
+        KeychainPayload: {
+            /** @description Name of the keychain. */
+            name: string;
+            /**
+             * Format: uuid
+             * @description Owner of the keychain.
+             */
+            owner?: string;
+        };
+        /** @description A paginated list of keychains. */
+        KeychainPage: {
+            /** @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 Keychains returned on the current page. */
+            keychains: {
+                /**
+                 * Format: uuid
+                 * @description Unique identifier for the keychain.
+                 */
+                id: string;
+                /** @description Name of the keychain. */
+                name: string;
+                /**
+                 * Format: uuid
+                 * @description Owner of the keychain.
+                 */
+                owner: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the keychain was created.
+                 */
+                createdAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the keychain was last updated.
+                 */
+                updatedAt: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the keychain 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 Key ID */
+        keyId: string;
+        /** @description Keychain ID */
+        keychainId: 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 {
+    getKeychains: {
+        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: {
+            /** Keychain(s) 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 Keychains returned on the current page. */
+                        keychains: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the keychain.
+                             */
+                            id: string;
+                            /** @description Name of the keychain. */
+                            name: string;
+                            /**
+                             * Format: uuid
+                             * @description Owner of the keychain.
+                             */
+                            owner: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the keychain was created.
+                             */
+                            createdAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the keychain was last updated.
+                             */
+                            updatedAt: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the keychain 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;
+                };
+            };
+        };
+    };
+    createKeychain: {
+        responses: {
+            /** Keychain created */
+            201: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the keychain.
+                         */
+                        id: string;
+                        /** @description Name of the keychain. */
+                        name: string;
+                        /**
+                         * Format: uuid
+                         * @description Owner of the keychain.
+                         */
+                        owner: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain 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": {
+                    /** @description Name of the keychain. */
+                    name: string;
+                    /**
+                     * Format: uuid
+                     * @description Owner of the keychain.
+                     */
+                    owner?: string;
+                };
+            };
+        };
+    };
+    getKeychainById: {
+        parameters: {
+            path: {
+                /** Keychain ID */
+                keychainId: string;
+            };
+        };
+        responses: {
+            /** Keychain fetched */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the keychain.
+                         */
+                        id: string;
+                        /** @description Name of the keychain. */
+                        name: string;
+                        /**
+                         * Format: uuid
+                         * @description Owner of the keychain.
+                         */
+                        owner: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain 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;
+                };
+            };
+        };
+    };
+    updateKeychain: {
+        parameters: {
+            path: {
+                /** Keychain ID */
+                keychainId: string;
+            };
+        };
+        responses: {
+            /** Keychain updated */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the keychain.
+                         */
+                        id: string;
+                        /** @description Name of the keychain. */
+                        name: string;
+                        /**
+                         * Format: uuid
+                         * @description Owner of the keychain.
+                         */
+                        owner: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain was created.
+                         */
+                        createdAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain was last updated.
+                         */
+                        updatedAt: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the keychain 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;
+                };
+            };
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    /** @description Name of the keychain. */
+                    name: string;
+                    /**
+                     * Format: uuid
+                     * @description Owner of the keychain.
+                     */
+                    owner?: string;
+                };
+            };
+        };
+    };
+    deleteKeychain: {
+        parameters: {
+            path: {
+                /** Keychain ID */
+                keychainId: string;
+            };
+        };
+        responses: {
+            /** Keychain 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;
+                };
+            };
+        };
+    };
+    addKeyToKeychain: {
+        parameters: {
+            path: {
+                /** Keychain ID */
+                keychainId: string;
+                /** Key ID */
+                keyId: string;
+            };
+        };
+        responses: {
+            /** Key added to keychain */
+            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;
+                };
+            };
+        };
+    };
+    removeKeyFromKeychain: {
+        parameters: {
+            path: {
+                /** Keychain ID */
+                keychainId: string;
+                /** Key ID */
+                keyId: string;
+            };
+        };
+        responses: {
+            /** Key removed from keychain */
+            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;
+                };
+            };
+        };
+    };
+    getKeysOfKeychain: {
+        parameters: {
+            path: {
+                /** Keychain ID */
+                keychainId: string;
+            };
+            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 response */
+            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;
+                };
+            };
+            /** Result not found */
+            404: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+}
+interface external {
+}
+
+export type { components, external, operations, paths };

package/dist/constructs/v1beta2/keychain/Keychain.js

@@ -0,0 +1 @@
+'use strict';

package/dist/constructs/v1beta2/keychain/KeychainSchema.d.mts

@@ -0,0 +1,7 @@
+/**
+ * This file was automatically generated from OpenAPI schema.
+ * Do not manually modify this file.
+ */
+declare const KeychainSchema: Record<string, unknown>;
+
+export { KeychainSchema as default };

package/dist/constructs/v1beta2/keychain/KeychainSchema.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This file was automatically generated from OpenAPI schema.
+ * Do not manually modify this file.
+ */
+declare const KeychainSchema: Record<string, unknown>;
+
+export { KeychainSchema as default };