@meshery/schemas 1.2.14 → 1.2.16

package/dist/constructs/v1beta1/academy/AcademySchema.d.ts

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

package/dist/constructs/v1beta1/badge/Badge.d.ts

@@ -0,0 +1,546 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {
+  "/api/organizations/badges/{id}": {
+    get: operations["getBadgeById"];
+    delete: operations["deleteBadgeById"];
+  };
+  "/api/organizations/badges": {
+    post: operations["createOrUpdateBadge"];
+  };
+  "/api/identity/badges": {
+    get: operations["getAvailableBadges"];
+  };
+  "/api/identity/users/badges": {
+    put: operations["assignBadges"];
+  };
+}
+
+export interface components {
+  schemas: {
+    /** @description Payload for creating or updating a badge. */
+    BadgePayload: {
+      /**
+       * Format: uuid
+       * @description Existing badge ID for updates; omit on create.
+       */
+      id?: string;
+      /**
+       * Format: uuid
+       * @description The ID of the organization in which this badge is available.
+       */
+      org_id: string;
+      /**
+       * @description unique identifier for the badge ( auto generated )
+       * @example Kubernetes-Expert
+       */
+      label: string;
+      /**
+       * @description Concise descriptor for the badge or certificate.
+       * @example Kubernetes Expert
+       */
+      name: string;
+      /**
+       * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+       * @example Awarded for mastering Kubernetes concepts and practices.
+       */
+      description: string;
+      /**
+       * Format: uri
+       * @description URL to the badge image
+       * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+       */
+      image_url: string;
+    };
+    Badge: {
+      /**
+       * 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 The ID of the organization in which this badge is available .
+       */
+      org_id: string;
+      /**
+       * @description unique identifier for the badge ( auto generated )
+       * @example Kubernetes-Expert
+       */
+      label: string;
+      /**
+       * @description Concise descriptor for the badge or certificate.
+       * @example Kubernetes Expert
+       */
+      name: string;
+      /**
+       * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+       * @example Awarded for mastering Kubernetes concepts and practices.
+       */
+      description: string;
+      /**
+       * Format: uri
+       * @description URL to the badge image
+       * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+       */
+      image_url: string;
+      /**
+       * 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;
+      /**
+       * Format: date-time
+       * @description Timestamp when the resource was deleted, if applicable
+       */
+      deleted_at: string;
+    };
+    BadgesPage: {
+      /** @description The badges of the badgespage. */
+      badges?: {
+        [key: string]: {
+          /**
+           * 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 The ID of the organization in which this badge is available .
+           */
+          org_id: string;
+          /**
+           * @description unique identifier for the badge ( auto generated )
+           * @example Kubernetes-Expert
+           */
+          label: string;
+          /**
+           * @description Concise descriptor for the badge or certificate.
+           * @example Kubernetes Expert
+           */
+          name: string;
+          /**
+           * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+           * @example Awarded for mastering Kubernetes concepts and practices.
+           */
+          description: string;
+          /**
+           * Format: uri
+           * @description URL to the badge image
+           * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+           */
+          image_url: string;
+          /**
+           * 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;
+          /**
+           * Format: date-time
+           * @description Timestamp when the resource was deleted, if applicable
+           */
+          deleted_at: string;
+        };
+      };
+    };
+    BadgeAssignmentPayload: {
+      /** @description The badges of the badgeassignment. */
+      badges?: string[];
+      /**
+       * Format: uuid
+       * @description ID of the user who owns or created this resource.
+       */
+      user_id?: string;
+      /** @description The notify of the badgeassignment. */
+      notify?: boolean;
+    };
+  };
+  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;
+      };
+    };
+  };
+}
+
+export interface operations {
+  getBadgeById: {
+    parameters: {
+      path: {
+        /** Unique identifier */
+        id: string;
+      };
+    };
+    responses: {
+      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 The ID of the organization in which this badge is available .
+             */
+            org_id: string;
+            /**
+             * @description unique identifier for the badge ( auto generated )
+             * @example Kubernetes-Expert
+             */
+            label: string;
+            /**
+             * @description Concise descriptor for the badge or certificate.
+             * @example Kubernetes Expert
+             */
+            name: string;
+            /**
+             * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+             * @example Awarded for mastering Kubernetes concepts and practices.
+             */
+            description: string;
+            /**
+             * Format: uri
+             * @description URL to the badge image
+             * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+             */
+            image_url: string;
+            /**
+             * 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;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was deleted, if applicable
+             */
+            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;
+        };
+      };
+    };
+  };
+  deleteBadgeById: {
+    parameters: {
+      path: {
+        /** Unique identifier */
+        id: string;
+      };
+    };
+    responses: {
+      /** Badge 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;
+        };
+      };
+    };
+  };
+  createOrUpdateBadge: {
+    responses: {
+      201: {
+        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 The ID of the organization in which this badge is available .
+             */
+            org_id: string;
+            /**
+             * @description unique identifier for the badge ( auto generated )
+             * @example Kubernetes-Expert
+             */
+            label: string;
+            /**
+             * @description Concise descriptor for the badge or certificate.
+             * @example Kubernetes Expert
+             */
+            name: string;
+            /**
+             * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+             * @example Awarded for mastering Kubernetes concepts and practices.
+             */
+            description: string;
+            /**
+             * Format: uri
+             * @description URL to the badge image
+             * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+             */
+            image_url: string;
+            /**
+             * 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;
+            /**
+             * Format: date-time
+             * @description Timestamp when the resource was deleted, if applicable
+             */
+            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 Existing badge ID for updates; omit on create.
+           */
+          id?: string;
+          /**
+           * Format: uuid
+           * @description The ID of the organization in which this badge is available.
+           */
+          org_id: string;
+          /**
+           * @description unique identifier for the badge ( auto generated )
+           * @example Kubernetes-Expert
+           */
+          label: string;
+          /**
+           * @description Concise descriptor for the badge or certificate.
+           * @example Kubernetes Expert
+           */
+          name: string;
+          /**
+           * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+           * @example Awarded for mastering Kubernetes concepts and practices.
+           */
+          description: string;
+          /**
+           * Format: uri
+           * @description URL to the badge image
+           * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+           */
+          image_url: string;
+        };
+      };
+    };
+  };
+  getAvailableBadges: {
+    responses: {
+      /** Available badges */
+      200: {
+        content: {
+          "application/json": {
+            /** @description The badges of the badgespage. */
+            badges?: {
+              [key: string]: {
+                /**
+                 * 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 The ID of the organization in which this badge is available .
+                 */
+                org_id: string;
+                /**
+                 * @description unique identifier for the badge ( auto generated )
+                 * @example Kubernetes-Expert
+                 */
+                label: string;
+                /**
+                 * @description Concise descriptor for the badge or certificate.
+                 * @example Kubernetes Expert
+                 */
+                name: string;
+                /**
+                 * @description A description of the milestone achieved, often including criteria for receiving this recognition.
+                 * @example Awarded for mastering Kubernetes concepts and practices.
+                 */
+                description: string;
+                /**
+                 * Format: uri
+                 * @description URL to the badge image
+                 * @example https://raw.githubusercontent.com/layer5io/layer5-academy/refs/heads/master/static/11111111-1111-1111-1111-111111111111/images/meshery-logo-light.webp
+                 */
+                image_url: string;
+                /**
+                 * 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;
+                /**
+                 * Format: date-time
+                 * @description Timestamp when the resource was deleted, if applicable
+                 */
+                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;
+        };
+      };
+    };
+  };
+  assignBadges: {
+    responses: {
+      /** Badge assignment result */
+      200: {
+        content: {
+          "application/json": { [key: string]: unknown };
+        };
+      };
+      /** 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 The badges of the badgeassignment. */
+          badges?: string[];
+          /**
+           * Format: uuid
+           * @description ID of the user who owns or created this resource.
+           */
+          user_id?: string;
+          /** @description The notify of the badgeassignment. */
+          notify?: boolean;
+        };
+      };
+    };
+  };
+}
+
+export interface external {}

package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts

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

package/dist/constructs/v1beta1/capability/Capability.d.ts

@@ -0,0 +1,114 @@
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+export interface paths {}
+
+export interface components {
+  schemas: {
+    /**
+     * @description Meshery manages entities in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. Entities may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
+     * @default [
+     *   {
+     *     "description": "Configure the visual styles for the component",
+     *     "displayName": "Styling",
+     *     "entityState": [
+     *       "declaration"
+     *     ],
+     *     "key": "",
+     *     "kind": "mutate",
+     *     "schemaVersion": "capability.meshery.io/v1beta1",
+     *     "status": "enabled",
+     *     "subType": "",
+     *     "type": "style",
+     *     "version": "0.7.0"
+     *   },
+     *   {
+     *     "description": "Change the shape of the component",
+     *     "displayName": "Change Shape",
+     *     "entityState": [
+     *       "declaration"
+     *     ],
+     *     "key": "",
+     *     "kind": "mutate",
+     *     "schemaVersion": "capability.meshery.io/v1beta1",
+     *     "status": "enabled",
+     *     "subType": "shape",
+     *     "type": "style",
+     *     "version": "0.7.0"
+     *   },
+     *   {
+     *     "description": "Drag and Drop a component into a parent component in graph view",
+     *     "displayName": "Compound Drag And Drop",
+     *     "entityState": [
+     *       "declaration"
+     *     ],
+     *     "key": "",
+     *     "kind": "interaction",
+     *     "schemaVersion": "capability.meshery.io/v1beta1",
+     *     "status": "enabled",
+     *     "subType": "compoundDnd",
+     *     "type": "graph",
+     *     "version": "0.7.0"
+     *   },
+     *   {
+     *     "description": "Add text to nodes body",
+     *     "displayName": "Body Text",
+     *     "entityState": [
+     *       "declaration"
+     *     ],
+     *     "key": "",
+     *     "kind": "mutate",
+     *     "schemaVersion": "capability.meshery.io/v1beta1",
+     *     "status": "enabled",
+     *     "subType": "body-text",
+     *     "type": "style",
+     *     "version": "0.7.0"
+     *   }
+     * ]
+     */
+    Capability: {
+      /**
+       * @description Specifies the version of the schema to which the capability definition conforms.
+       * @example [
+       *   "v1",
+       *   "v1alpha1",
+       *   "v2beta3",
+       *   "v1.custom-suffix",
+       *   "models.meshery.io/v1beta1",
+       *   "capability.meshery.io/v1alpha1"
+       * ]
+       */
+      schemaVersion: string;
+      /** @description Version of the capability definition. */
+      version: string;
+      /** @description Name of the capability in human-readible format. */
+      displayName: string;
+      /** @description A written representation of the purpose and characteristics of the capability. */
+      description: string;
+      /** @description Top-level categorization of the capability */
+      kind: string;
+      /** @description Classification of capabilities. Used to group capabilities similar in nature. */
+      type: string;
+      /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
+      subType: string;
+      /** @description Key that backs the capability. */
+      key: string;
+      /** @description State of the entity in which the capability is applicable. */
+      entityState: ("declaration" | "instance")[];
+      /**
+       * @description Status of the capability
+       * @default enabled
+       * @enum {string}
+       */
+      status: "enabled" | "disabled";
+      /** @description Metadata contains additional information associated with the capability. Extension point. */
+      metadata?: { [key: string]: unknown };
+    };
+  };
+}
+
+export interface operations {}
+
+export interface external {}

package/dist/constructs/v1beta1/capability/CapabilitySchema.d.ts

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