@meshery/schemas 1.2.15 → 1.2.16

package/dist/constructs/v1beta2/role/RoleSchema.d.ts

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

package/dist/constructs/v1beta2/schedule/Schedule.d.ts

@@ -0,0 +1,431 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  "/user/schedules": {
+    /** Returns all schedules for the authenticated user. */
+    get: operations["getSchedules"];
+    /** Creates or updates a schedule for the authenticated user. */
+    post: operations["upsertSchedule"];
+  };
+  "/user/schedules/{scheduleId}": {
+    /** Returns a specific schedule by its ID. */
+    get: operations["getSchedule"];
+    /** Deletes a schedule by its ID. */
+    delete: operations["deleteSchedule"];
+  };
+}
+
+export interface components {
+  schemas: {
+    /** @description A schedule defines a recurring cron-based trigger for performance tests or other automated tasks. */
+    Schedule: {
+      /**
+       * Format: uuid
+       * @description Unique identifier for the schedule.
+       */
+      id?: string;
+      /** @description Human-readable name for the schedule. */
+      name: string;
+      /**
+       * Format: uuid
+       * @description UUID of the user who owns this schedule.
+       */
+      userId: string;
+      /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+      cronExpression: string;
+      /**
+       * Format: date-time
+       * @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
+       */
+      lastRun?: string;
+      /**
+       * Format: date-time
+       * @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
+       */
+      nextRun?: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the schedule was created.
+       */
+      createdAt?: string;
+      /**
+       * Format: date-time
+       * @description Timestamp when the schedule was last updated.
+       */
+      updatedAt?: string;
+    };
+    /** @description Payload for upserting a schedule. Includes only client-settable fields. */
+    SchedulePayload: {
+      /**
+       * Format: uuid
+       * @description Existing schedule ID for updates; omit on create.
+       */
+      id?: string;
+      /** @description Human-readable name for the schedule. */
+      name: string;
+      /**
+       * Format: uuid
+       * @description Owner user ID; inferred from the authenticated user when omitted.
+       */
+      userId?: string;
+      /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+      cronExpression: string;
+    };
+    /** @description A paginated list of schedules. */
+    SchedulePage: {
+      /** @description Current page number (zero-based). */
+      page: number;
+      /** @description Number of schedules per page. */
+      pageSize: number;
+      /** @description Total number of schedules across all pages. */
+      totalCount: number;
+      /** @description The schedules of the schedulepage. */
+      schedules: {
+        /**
+         * Format: uuid
+         * @description Unique identifier for the schedule.
+         */
+        id?: string;
+        /** @description Human-readable name for the schedule. */
+        name: string;
+        /**
+         * Format: uuid
+         * @description UUID of the user who owns this schedule.
+         */
+        userId: string;
+        /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+        cronExpression: string;
+        /**
+         * Format: date-time
+         * @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
+         */
+        lastRun?: string;
+        /**
+         * Format: date-time
+         * @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
+         */
+        nextRun?: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the schedule was created.
+         */
+        createdAt?: string;
+        /**
+         * Format: date-time
+         * @description Timestamp when the schedule was last updated.
+         */
+        updatedAt?: string;
+      }[];
+    };
+  };
+  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 Schedule ID */
+    scheduleId: string;
+    /** @description Get responses by page */
+    page: string;
+    /** @description Get responses by page size */
+    pageSize: string;
+    /** @description Get responses that match search param value */
+    search: string;
+    /** @description Get ordered responses */
+    order: string;
+  };
+}
+
+export interface operations {
+  /** Returns all schedules for the authenticated user. */
+  getSchedules: {
+    parameters: {
+      query: {
+        /** Get responses by page */
+        page?: string;
+        /** Get responses by page size */
+        pageSize?: string;
+        /** Get responses that match search param value */
+        search?: string;
+        /** Get ordered responses */
+        order?: string;
+      };
+    };
+    responses: {
+      /** Schedules response */
+      200: {
+        content: {
+          "application/json": {
+            /** @description Current page number (zero-based). */
+            page: number;
+            /** @description Number of schedules per page. */
+            pageSize: number;
+            /** @description Total number of schedules across all pages. */
+            totalCount: number;
+            /** @description The schedules of the schedulepage. */
+            schedules: {
+              /**
+               * Format: uuid
+               * @description Unique identifier for the schedule.
+               */
+              id?: string;
+              /** @description Human-readable name for the schedule. */
+              name: string;
+              /**
+               * Format: uuid
+               * @description UUID of the user who owns this schedule.
+               */
+              userId: string;
+              /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+              cronExpression: string;
+              /**
+               * Format: date-time
+               * @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
+               */
+              lastRun?: string;
+              /**
+               * Format: date-time
+               * @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
+               */
+              nextRun?: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the schedule was created.
+               */
+              createdAt?: string;
+              /**
+               * Format: date-time
+               * @description Timestamp when the schedule was last updated.
+               */
+              updatedAt?: string;
+            }[];
+          };
+        };
+      };
+      /** Expired JWT token used or insufficient privilege */
+      401: {
+        content: {
+          "text/plain": string;
+        };
+      };
+      /** Internal server error */
+      500: {
+        content: {
+          "text/plain": string;
+        };
+      };
+    };
+  };
+  /** Creates or updates a schedule for the authenticated user. */
+  upsertSchedule: {
+    responses: {
+      /** Schedule upserted */
+      200: {
+        content: {
+          "application/json": {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the schedule.
+             */
+            id?: string;
+            /** @description Human-readable name for the schedule. */
+            name: string;
+            /**
+             * Format: uuid
+             * @description UUID of the user who owns this schedule.
+             */
+            userId: string;
+            /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+            cronExpression: string;
+            /**
+             * Format: date-time
+             * @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
+             */
+            lastRun?: string;
+            /**
+             * Format: date-time
+             * @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
+             */
+            nextRun?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the schedule was created.
+             */
+            createdAt?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the schedule was last updated.
+             */
+            updatedAt?: 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 schedule ID for updates; omit on create.
+           */
+          id?: string;
+          /** @description Human-readable name for the schedule. */
+          name: string;
+          /**
+           * Format: uuid
+           * @description Owner user ID; inferred from the authenticated user when omitted.
+           */
+          userId?: string;
+          /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+          cronExpression: string;
+        };
+      };
+    };
+  };
+  /** Returns a specific schedule by its ID. */
+  getSchedule: {
+    parameters: {
+      path: {
+        /** Schedule ID */
+        scheduleId: string;
+      };
+    };
+    responses: {
+      /** Schedule response */
+      200: {
+        content: {
+          "application/json": {
+            /**
+             * Format: uuid
+             * @description Unique identifier for the schedule.
+             */
+            id?: string;
+            /** @description Human-readable name for the schedule. */
+            name: string;
+            /**
+             * Format: uuid
+             * @description UUID of the user who owns this schedule.
+             */
+            userId: string;
+            /** @description Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight). */
+            cronExpression: string;
+            /**
+             * Format: date-time
+             * @description Server-computed timestamp of the schedule's most recent execution. Null until the first run completes. Server-managed; clients must not set this on create/update.
+             */
+            lastRun?: string;
+            /**
+             * Format: date-time
+             * @description Server-computed timestamp of the schedule's next planned execution, derived from the cron expression. Server-managed; clients must not set this on create/update.
+             */
+            nextRun?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the schedule was created.
+             */
+            createdAt?: string;
+            /**
+             * Format: date-time
+             * @description Timestamp when the schedule was last updated.
+             */
+            updatedAt?: 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 schedule by its ID. */
+  deleteSchedule: {
+    parameters: {
+      path: {
+        /** Schedule ID */
+        scheduleId: string;
+      };
+    };
+    responses: {
+      /** Schedule 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;
+        };
+      };
+    };
+  };
+}
+
+export interface external {}

package/dist/constructs/v1beta2/schedule/ScheduleSchema.d.ts

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