@meshery/schemas 0.8.127 → 0.8.129

package/dist/constructs/v1beta1/credential/Credential.d.mts

@@ -0,0 +1,517 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+interface paths {
+    "/api/integrations/credentials": {
+        /** Retrieves all credentials belonging to the authenticated user. */
+        get: operations["getUserCredentials"];
+        /** Updates an existing credential for the authenticated user. */
+        put: operations["updateUserCredential"];
+        /** Saves a new credential for the authenticated user. */
+        post: operations["saveUserCredential"];
+    };
+    "/api/integrations/credentials/{id}": {
+        /** Retrieves a specific credential by its ID. */
+        get: operations["getCredentialByID"];
+        /** Deletes a credential belonging to the authenticated user. */
+        delete: operations["deleteUserCredential"];
+    };
+}
+interface components {
+    schemas: {
+        /** @description Meshery Credentials store sensitive information such as API keys, tokens, and passwords used by connections to external systems. */
+        Credential: {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the credential.
+             */
+            id?: string;
+            /** @description Human-readable name for the credential. */
+            name: string;
+            /**
+             * Format: uuid
+             * @description UUID of the user who owns this credential.
+             */
+            user_id?: string;
+            /** @description Credential type (e.g. token, basic, AWS). */
+            type: string;
+            /** @description Key-value pairs containing the sensitive credential data. */
+            secret?: {
+                [key: string]: unknown;
+            };
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was created.
+             */
+            created_at?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was updated.
+             */
+            updated_at?: string;
+            /** @description Timestamp when the credential was soft-deleted. */
+            deleted_at?: string;
+        };
+        /** @description A paginated list of credentials. */
+        CredentialPage: {
+            credentials: {
+                /**
+                 * Format: uuid
+                 * @description Unique identifier for the credential.
+                 */
+                id?: string;
+                /** @description Human-readable name for the credential. */
+                name: string;
+                /**
+                 * Format: uuid
+                 * @description UUID of the user who owns this credential.
+                 */
+                user_id?: string;
+                /** @description Credential type (e.g. token, basic, AWS). */
+                type: string;
+                /** @description Key-value pairs containing the sensitive credential data. */
+                secret?: {
+                    [key: string]: unknown;
+                };
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the resource was created.
+                 */
+                created_at?: string;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the resource was updated.
+                 */
+                updated_at?: string;
+                /** @description Timestamp when the credential was soft-deleted. */
+                deleted_at?: string;
+            }[];
+            /** @description Total number of credentials across all pages. */
+            total_count: number;
+            /** @description Current page number (zero-based). */
+            page: number;
+            /** @description Number of credentials per page. */
+            page_size: number;
+        };
+    };
+    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 Credential ID */
+        id: string;
+        /** @description Get responses by page */
+        page: string;
+        /** @description Get responses by pagesize */
+        pagesize: string;
+        /** @description Get responses that match search param value */
+        search: string;
+        /** @description Get ordered responses */
+        order: string;
+    };
+}
+interface operations {
+    /** Retrieves all credentials belonging to the authenticated user. */
+    getUserCredentials: {
+        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: {
+            /** Credentials fetched successfully */
+            200: {
+                content: {
+                    "application/json": {
+                        credentials: {
+                            /**
+                             * Format: uuid
+                             * @description Unique identifier for the credential.
+                             */
+                            id?: string;
+                            /** @description Human-readable name for the credential. */
+                            name: string;
+                            /**
+                             * Format: uuid
+                             * @description UUID of the user who owns this credential.
+                             */
+                            user_id?: string;
+                            /** @description Credential type (e.g. token, basic, AWS). */
+                            type: string;
+                            /** @description Key-value pairs containing the sensitive credential data. */
+                            secret?: {
+                                [key: string]: unknown;
+                            };
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the resource was created.
+                             */
+                            created_at?: string;
+                            /**
+                             * Format: date-time
+                             * @description Timestamp when the resource was updated.
+                             */
+                            updated_at?: string;
+                            /** @description Timestamp when the credential was soft-deleted. */
+                            deleted_at?: string;
+                        }[];
+                        /** @description Total number of credentials across all pages. */
+                        total_count: number;
+                        /** @description Current page number (zero-based). */
+                        page: number;
+                        /** @description Number of credentials per page. */
+                        page_size: number;
+                    };
+                };
+            };
+            /** Expired JWT token used or insufficient privilege */
+            401: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+            /** Internal server error */
+            500: {
+                content: {
+                    "text/plain": string;
+                };
+            };
+        };
+    };
+    /** Updates an existing credential for the authenticated user. */
+    updateUserCredential: {
+        responses: {
+            /** Credential updated successfully */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the credential.
+                         */
+                        id?: string;
+                        /** @description Human-readable name for the credential. */
+                        name: string;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the user who owns this credential.
+                         */
+                        user_id?: string;
+                        /** @description Credential type (e.g. token, basic, AWS). */
+                        type: string;
+                        /** @description Key-value pairs containing the sensitive credential data. */
+                        secret?: {
+                            [key: string]: unknown;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was created.
+                         */
+                        created_at?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was updated.
+                         */
+                        updated_at?: string;
+                        /** @description Timestamp when the credential was soft-deleted. */
+                        deleted_at?: string;
+                    };
+                };
+            };
+            /** 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": {
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier for the credential.
+                     */
+                    id?: string;
+                    /** @description Human-readable name for the credential. */
+                    name: string;
+                    /**
+                     * Format: uuid
+                     * @description UUID of the user who owns this credential.
+                     */
+                    user_id?: string;
+                    /** @description Credential type (e.g. token, basic, AWS). */
+                    type: string;
+                    /** @description Key-value pairs containing the sensitive credential data. */
+                    secret?: {
+                        [key: string]: unknown;
+                    };
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the resource was created.
+                     */
+                    created_at?: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the resource was updated.
+                     */
+                    updated_at?: string;
+                    /** @description Timestamp when the credential was soft-deleted. */
+                    deleted_at?: string;
+                };
+            };
+        };
+    };
+    /** Saves a new credential for the authenticated user. */
+    saveUserCredential: {
+        responses: {
+            /** Credential saved successfully */
+            201: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the credential.
+                         */
+                        id?: string;
+                        /** @description Human-readable name for the credential. */
+                        name: string;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the user who owns this credential.
+                         */
+                        user_id?: string;
+                        /** @description Credential type (e.g. token, basic, AWS). */
+                        type: string;
+                        /** @description Key-value pairs containing the sensitive credential data. */
+                        secret?: {
+                            [key: string]: unknown;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was created.
+                         */
+                        created_at?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was updated.
+                         */
+                        updated_at?: string;
+                        /** @description Timestamp when the credential was soft-deleted. */
+                        deleted_at?: 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 Unique identifier for the credential.
+                     */
+                    id?: string;
+                    /** @description Human-readable name for the credential. */
+                    name: string;
+                    /**
+                     * Format: uuid
+                     * @description UUID of the user who owns this credential.
+                     */
+                    user_id?: string;
+                    /** @description Credential type (e.g. token, basic, AWS). */
+                    type: string;
+                    /** @description Key-value pairs containing the sensitive credential data. */
+                    secret?: {
+                        [key: string]: unknown;
+                    };
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the resource was created.
+                     */
+                    created_at?: string;
+                    /**
+                     * Format: date-time
+                     * @description Timestamp when the resource was updated.
+                     */
+                    updated_at?: string;
+                    /** @description Timestamp when the credential was soft-deleted. */
+                    deleted_at?: string;
+                };
+            };
+        };
+    };
+    /** Retrieves a specific credential by its ID. */
+    getCredentialByID: {
+        parameters: {
+            path: {
+                /** Credential ID */
+                id: string;
+            };
+        };
+        responses: {
+            /** Credential fetched successfully */
+            200: {
+                content: {
+                    "application/json": {
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier for the credential.
+                         */
+                        id?: string;
+                        /** @description Human-readable name for the credential. */
+                        name: string;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the user who owns this credential.
+                         */
+                        user_id?: string;
+                        /** @description Credential type (e.g. token, basic, AWS). */
+                        type: string;
+                        /** @description Key-value pairs containing the sensitive credential data. */
+                        secret?: {
+                            [key: string]: unknown;
+                        };
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was created.
+                         */
+                        created_at?: string;
+                        /**
+                         * Format: date-time
+                         * @description Timestamp when the resource was updated.
+                         */
+                        updated_at?: string;
+                        /** @description Timestamp when the credential was soft-deleted. */
+                        deleted_at?: 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;
+                };
+            };
+        };
+    };
+    /** Deletes a credential belonging to the authenticated user. */
+    deleteUserCredential: {
+        parameters: {
+            path: {
+                /** Credential ID */
+                id: string;
+            };
+        };
+        responses: {
+            /** Credential deleted successfully */
+            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 };