@meshery/schemas 1.1.2 → 1.2.1

package/README.md

@@ -48,6 +48,8 @@ Meshery schemas offer a powerful system designed for:
 
 For an explanation of Meshery's terminology regarding schemas, definitions, declarations, and instances, please see [Contributor's Guide to Models](https://docs.meshery.io/project/contributing/contributing-models).
 
+For identifier-naming rules (wire casing, DB tag separation, URL/path/query-param conventions, operationId form), see [`docs/identifier-naming-contributor-guide.md`](docs/identifier-naming-contributor-guide.md) — the canonical, reader-friendly directory for the camelCase-on-the-wire contract that this repository and every downstream consumer share.
+
 ## Contributing
 --> **For an explanation of the directory structure of this repository and how to contribute changes to Meshery's schemas, see [Contributor's Guide to Schema-Driven Development](https://docs.meshery.io/project/contributing/contributing-schemas).**
 
@@ -292,6 +294,8 @@ post:
 
 ## Naming Conventions
 
+> This section is the inline authority; for the reader-friendly directory (26-row naming table with before/after and do/don't examples), see [`docs/identifier-naming-contributor-guide.md`](docs/identifier-naming-contributor-guide.md).
+
 - Property names
   - Use camelCase for property fields (e.g., `schemaVersion`, `displayName`, `componentsCount`).
   - Identifier fields use lowerCamelCase with "Id" suffix (e.g., `modelId`, `registrantId`, `categoryId`).

package/dist/cloudApi.d.mts

@@ -3468,6 +3468,12 @@ type GetSchedulesApiResponse = {
         /** Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight).
          */
         cronExpression: string;
+        /** 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;
+        /** 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;
         /** Timestamp when the schedule was created. */
         createdAt?: string;
         /** Timestamp when the schedule was last updated. */
@@ -3494,6 +3500,12 @@ type UpsertScheduleApiResponse = {
     /** Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight).
      */
     cronExpression: string;
+    /** 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;
+    /** 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;
     /** Timestamp when the schedule was created. */
     createdAt?: string;
     /** Timestamp when the schedule was last updated. */
@@ -3522,6 +3534,12 @@ type GetScheduleApiResponse = {
     /** Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight).
      */
     cronExpression: string;
+    /** 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;
+    /** 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;
     /** Timestamp when the schedule was created. */
     createdAt?: string;
     /** Timestamp when the schedule was last updated. */
@@ -3677,6 +3695,9 @@ type ListUsersNotInTeamApiResponse = {
     total_count?: number;
     /** The data of the teammemberspage. */
     data?: {
+        /** Timestamp when the user joined the team. Server-computed from the earliest matching row in `users_teams_mapping` for this (team, user) pair. Server-managed; clients cannot set this.
+         */
+        joinedAt?: string;
         [key: string]: any;
     }[];
 };
@@ -5647,6 +5668,24 @@ type GetPatternsApiResponse = {
         };
         /** Visibility scope (private, public, published). */
         visibility?: string;
+        /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+         */
+        designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+        /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+         */
+        viewCount?: number;
+        /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+         */
+        downloadCount?: number;
+        /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+         */
+        cloneCount?: number;
+        /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+         */
+        deploymentCount?: number;
+        /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+         */
+        shareCount?: number;
         /** Timestamp of design creation. */
         createdAt?: string;
         /** Timestamp of last design modification. */
@@ -6564,6 +6603,24 @@ type UpsertPatternApiResponse = {
     };
     /** Visibility scope (private, public, published). */
     visibility?: string;
+    /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+     */
+    designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+    /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+     */
+    viewCount?: number;
+    /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+     */
+    downloadCount?: number;
+    /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+     */
+    cloneCount?: number;
+    /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+     */
+    deploymentCount?: number;
+    /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+     */
+    shareCount?: number;
     /** Timestamp of design creation. */
     createdAt?: string;
     /** Timestamp of last design modification. */
@@ -7459,6 +7516,24 @@ type UpsertPatternApiArg = {
             };
             /** Visibility scope (private, public, published). */
             visibility?: string;
+            /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+             */
+            designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+            /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+             */
+            viewCount?: number;
+            /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+             */
+            downloadCount?: number;
+            /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+             */
+            cloneCount?: number;
+            /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+             */
+            deploymentCount?: number;
+            /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+             */
+            shareCount?: number;
             /** Timestamp of design creation. */
             createdAt?: string;
             /** Timestamp of last design modification. */
@@ -8392,6 +8467,24 @@ type GetPatternApiResponse = {
     };
     /** Visibility scope (private, public, published). */
     visibility?: string;
+    /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+     */
+    designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+    /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+     */
+    viewCount?: number;
+    /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+     */
+    downloadCount?: number;
+    /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+     */
+    cloneCount?: number;
+    /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+     */
+    deploymentCount?: number;
+    /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+     */
+    shareCount?: number;
     /** Timestamp of design creation. */
     createdAt?: string;
     /** Timestamp of last design modification. */
@@ -9291,6 +9384,24 @@ type ClonePatternApiResponse = {
     };
     /** Visibility scope (private, public, published). */
     visibility?: string;
+    /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+     */
+    designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+    /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+     */
+    viewCount?: number;
+    /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+     */
+    downloadCount?: number;
+    /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+     */
+    cloneCount?: number;
+    /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+     */
+    deploymentCount?: number;
+    /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+     */
+    shareCount?: number;
     /** Timestamp of design creation. */
     createdAt?: string;
     /** Timestamp of last design modification. */
@@ -10222,6 +10333,24 @@ type GetCatalogContentApiResponse = {
         };
         /** Visibility scope (private, public, published). */
         visibility?: string;
+        /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+         */
+        designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+        /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+         */
+        viewCount?: number;
+        /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+         */
+        downloadCount?: number;
+        /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+         */
+        cloneCount?: number;
+        /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+         */
+        deploymentCount?: number;
+        /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+         */
+        shareCount?: number;
         /** Timestamp of design creation. */
         createdAt?: string;
         /** Timestamp of last design modification. */

package/dist/cloudApi.d.ts

@@ -3468,6 +3468,12 @@ type GetSchedulesApiResponse = {
         /** Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight).
          */
         cronExpression: string;
+        /** 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;
+        /** 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;
         /** Timestamp when the schedule was created. */
         createdAt?: string;
         /** Timestamp when the schedule was last updated. */
@@ -3494,6 +3500,12 @@ type UpsertScheduleApiResponse = {
     /** Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight).
      */
     cronExpression: string;
+    /** 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;
+    /** 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;
     /** Timestamp when the schedule was created. */
     createdAt?: string;
     /** Timestamp when the schedule was last updated. */
@@ -3522,6 +3534,12 @@ type GetScheduleApiResponse = {
     /** Cron expression defining the schedule's recurrence (e.g. "0 0 * * *" for daily at midnight).
      */
     cronExpression: string;
+    /** 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;
+    /** 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;
     /** Timestamp when the schedule was created. */
     createdAt?: string;
     /** Timestamp when the schedule was last updated. */
@@ -3677,6 +3695,9 @@ type ListUsersNotInTeamApiResponse = {
     total_count?: number;
     /** The data of the teammemberspage. */
     data?: {
+        /** Timestamp when the user joined the team. Server-computed from the earliest matching row in `users_teams_mapping` for this (team, user) pair. Server-managed; clients cannot set this.
+         */
+        joinedAt?: string;
         [key: string]: any;
     }[];
 };
@@ -5647,6 +5668,24 @@ type GetPatternsApiResponse = {
         };
         /** Visibility scope (private, public, published). */
         visibility?: string;
+        /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+         */
+        designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+        /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+         */
+        viewCount?: number;
+        /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+         */
+        downloadCount?: number;
+        /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+         */
+        cloneCount?: number;
+        /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+         */
+        deploymentCount?: number;
+        /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+         */
+        shareCount?: number;
         /** Timestamp of design creation. */
         createdAt?: string;
         /** Timestamp of last design modification. */
@@ -6564,6 +6603,24 @@ type UpsertPatternApiResponse = {
     };
     /** Visibility scope (private, public, published). */
     visibility?: string;
+    /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+     */
+    designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+    /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+     */
+    viewCount?: number;
+    /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+     */
+    downloadCount?: number;
+    /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+     */
+    cloneCount?: number;
+    /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+     */
+    deploymentCount?: number;
+    /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+     */
+    shareCount?: number;
     /** Timestamp of design creation. */
     createdAt?: string;
     /** Timestamp of last design modification. */
@@ -7459,6 +7516,24 @@ type UpsertPatternApiArg = {
             };
             /** Visibility scope (private, public, published). */
             visibility?: string;
+            /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+             */
+            designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+            /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+             */
+            viewCount?: number;
+            /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+             */
+            downloadCount?: number;
+            /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+             */
+            cloneCount?: number;
+            /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+             */
+            deploymentCount?: number;
+            /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+             */
+            shareCount?: number;
             /** Timestamp of design creation. */
             createdAt?: string;
             /** Timestamp of last design modification. */
@@ -8392,6 +8467,24 @@ type GetPatternApiResponse = {
     };
     /** Visibility scope (private, public, published). */
     visibility?: string;
+    /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+     */
+    designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+    /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+     */
+    viewCount?: number;
+    /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+     */
+    downloadCount?: number;
+    /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+     */
+    cloneCount?: number;
+    /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+     */
+    deploymentCount?: number;
+    /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+     */
+    shareCount?: number;
     /** Timestamp of design creation. */
     createdAt?: string;
     /** Timestamp of last design modification. */
@@ -9291,6 +9384,24 @@ type ClonePatternApiResponse = {
     };
     /** Visibility scope (private, public, published). */
     visibility?: string;
+    /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+     */
+    designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+    /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+     */
+    viewCount?: number;
+    /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+     */
+    downloadCount?: number;
+    /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+     */
+    cloneCount?: number;
+    /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+     */
+    deploymentCount?: number;
+    /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+     */
+    shareCount?: number;
     /** Timestamp of design creation. */
     createdAt?: string;
     /** Timestamp of last design modification. */
@@ -10222,6 +10333,24 @@ type GetCatalogContentApiResponse = {
         };
         /** Visibility scope (private, public, published). */
         visibility?: string;
+        /** Discriminator identifying the source format of the design body. Projected server-side (not stored in a column of its own); for catalog listings the server derives it from the attached catalog metadata, for user-owned designs the server derives it from the import source. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
+         */
+        designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest";
+        /** Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
+         */
+        viewCount?: number;
+        /** Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
+         */
+        downloadCount?: number;
+        /** Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
+         */
+        cloneCount?: number;
+        /** Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
+         */
+        deploymentCount?: number;
+        /** Server-aggregated count of share events for this design. Server-managed and ignored on writes.
+         */
+        shareCount?: number;
         /** Timestamp of design creation. */
         createdAt?: string;
         /** Timestamp of last design modification. */