@meshery/schemas 1.2.14 → 1.2.16

package/dist/constructs/v1beta2/core/CoreSchema.d.ts

@@ -0,0 +1,2 @@
+declare const CoreSchema: Record<string, unknown>;
+export default CoreSchema;

package/dist/constructs/v1beta2/credential/Credential.d.ts

@@ -0,0 +1,519 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export 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"];
+    /** Deletes a credential belonging to the authenticated user. */
+    delete: operations["deleteUserCredential"];
+  };
+  "/api/integrations/credentials/{credentialId}": {
+    /** Retrieves a specific credential by its ID. */
+    get: operations["getCredentialById"];
+  };
+}
+
+export 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.
+       */
+      userId: 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 credential was created.
+       */
+      createdAt: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the credential was last updated.
+       */
+      updatedAt: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the credential was soft-deleted.
+       */
+      deletedAt?: string;
+    };
+    /** @description Payload for creating or updating a credential. */
+    CredentialPayload: {
+      /**
+       * Format: uuid
+       * @description Existing credential ID for updates; omit on create.
+       */
+      id?: string;
+      /** @description Human-readable name for the credential. */
+      name: string;
+      /**
+       * Format: uuid
+       * @description UUID of the user who owns this credential.
+       */
+      userId?: string;
+      /** @description Credential type (e.g. token, basic, AWS). */
+      type: string;
+      /** @description Key-value pairs containing the sensitive credential data. */
+      secret?: { [key: string]: unknown };
+    };
+    /** @description A paginated list of credentials. */
+    CredentialPage: {
+      /** @description The credentials returned on the current page. */
+      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.
+         */
+        userId: 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 credential was created.
+         */
+        createdAt: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the credential was last updated.
+         */
+        updatedAt: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the credential was soft-deleted.
+         */
+        deletedAt?: 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 */
+    credentialId: string;
+    /** @description Credential ID */
+    credentialIdQuery: 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;
+  };
+}
+
+export 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 response */
+      200: {
+        content: {
+          "application/json": {
+            /** @description The credentials returned on the current page. */
+            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.
+               */
+              userId: 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 credential was created.
+               */
+              createdAt: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the credential was last updated.
+               */
+              updatedAt: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the credential was soft-deleted.
+               */
+              deletedAt?: 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 */
+      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.
+             */
+            userId: 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 credential was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the credential was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the credential was soft-deleted.
+             */
+            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;
+        };
+      };
+      /** Result not found */
+      404: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+    requestBody: {
+      content: {
+        "application/json": {
+          /**
+           * Format: uuid
+           * @description Existing credential ID for updates; omit on create.
+           */
+          id?: string;
+          /** @description Human-readable name for the credential. */
+          name: string;
+          /**
+           * Format: uuid
+           * @description UUID of the user who owns this credential.
+           */
+          userId?: string;
+          /** @description Credential type (e.g. token, basic, AWS). */
+          type: string;
+          /** @description Key-value pairs containing the sensitive credential data. */
+          secret?: { [key: string]: unknown };
+        };
+      };
+    };
+  };
+  /** Saves a new credential for the authenticated user. */
+  saveUserCredential: {
+    responses: {
+      /** Credential saved */
+      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.
+             */
+            userId: 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 credential was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the credential was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the credential was soft-deleted.
+             */
+            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 Existing credential ID for updates; omit on create.
+           */
+          id?: string;
+          /** @description Human-readable name for the credential. */
+          name: string;
+          /**
+           * Format: uuid
+           * @description UUID of the user who owns this credential.
+           */
+          userId?: string;
+          /** @description Credential type (e.g. token, basic, AWS). */
+          type: string;
+          /** @description Key-value pairs containing the sensitive credential data. */
+          secret?: { [key: string]: unknown };
+        };
+      };
+    };
+  };
+  /** Deletes a credential belonging to the authenticated user. */
+  deleteUserCredential: {
+    parameters: {
+      query: {
+        /** Credential ID */
+        credentialId: string;
+      };
+    };
+    responses: {
+      /** Credential 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;
+        };
+      };
+    };
+  };
+  /** Retrieves a specific credential by its ID. */
+  getCredentialById: {
+    parameters: {
+      path: {
+        /** Credential ID */
+        credentialId: string;
+      };
+    };
+    responses: {
+      /** Credential response */
+      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.
+             */
+            userId: 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 credential was created.
+             */
+            createdAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the credential was last updated.
+             */
+            updatedAt: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the credential was soft-deleted.
+             */
+            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;
+        };
+      };
+    };
+  };
+}
+
+export interface external {}

package/dist/constructs/v1beta2/credential/CredentialSchema.d.ts

@@ -0,0 +1,2 @@
+declare const CredentialSchema: Record<string, unknown>;
+export default CredentialSchema;