@meshery/schemas 1.3.98 → 1.3.100

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/dist/cloudApi.d.mts +69 -14
  2. package/dist/cloudApi.d.ts +69 -14
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/component/Component.d.ts +5 -0
  6. package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
  7. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/connection/Connection.d.ts +30 -0
  9. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  10. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  11. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +20 -0
  12. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
  13. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
  14. package/dist/constructs/v1beta1/model/Model.d.ts +15 -0
  15. package/dist/constructs/v1beta1/model/ModelSchema.js +3 -3
  16. package/dist/constructs/v1beta1/model/ModelSchema.mjs +3 -3
  17. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +115 -0
  18. package/dist/constructs/v1beta1/pattern/PatternSchema.js +34 -23
  19. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +34 -23
  20. package/dist/constructs/v1beta1/registry/Registry.d.ts +111 -6
  21. package/dist/constructs/v1beta1/registry/RegistrySchema.js +21 -21
  22. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +21 -21
  23. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +20 -0
  24. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +6 -4
  25. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +6 -4
  26. package/dist/constructs/v1beta2/component/Component.d.ts +5 -0
  27. package/dist/constructs/v1beta2/component/ComponentSchema.js +1 -1
  28. package/dist/constructs/v1beta2/component/ComponentSchema.mjs +1 -1
  29. package/dist/constructs/v1beta2/design/Design.d.ts +60 -0
  30. package/dist/constructs/v1beta2/design/DesignSchema.js +12 -12
  31. package/dist/constructs/v1beta2/design/DesignSchema.mjs +12 -12
  32. package/dist/constructs/v1beta2/model/Model.d.ts +15 -0
  33. package/dist/constructs/v1beta2/model/ModelSchema.js +3 -3
  34. package/dist/constructs/v1beta2/model/ModelSchema.mjs +3 -3
  35. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  36. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  37. package/dist/constructs/v1beta3/component/Component.d.ts +5 -0
  38. package/dist/constructs/v1beta3/component/ComponentSchema.js +1 -1
  39. package/dist/constructs/v1beta3/component/ComponentSchema.mjs +1 -1
  40. package/dist/constructs/v1beta3/connection/Connection.d.ts +39 -22
  41. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +4 -4
  42. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +4 -4
  43. package/dist/constructs/v1beta3/design/Design.d.ts +88 -3
  44. package/dist/constructs/v1beta3/design/DesignSchema.js +18 -18
  45. package/dist/constructs/v1beta3/design/DesignSchema.mjs +18 -18
  46. package/dist/constructs/v1beta3/event/Event.d.ts +63 -1
  47. package/dist/constructs/v1beta3/event/EventSchema.js +8 -4
  48. package/dist/constructs/v1beta3/event/EventSchema.mjs +8 -4
  49. package/dist/constructs/v1beta3/profile/Profile.d.ts +1 -1
  50. package/dist/constructs/v1beta3/profile/ProfileSchema.js +1 -1
  51. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +1 -1
  52. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +20 -0
  53. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +6 -4
  54. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +6 -4
  55. package/dist/index.d.mts +120 -0
  56. package/dist/index.d.ts +120 -0
  57. package/dist/index.js +59 -46
  58. package/dist/index.mjs +59 -46
  59. package/dist/mesheryApi.d.mts +75 -17
  60. package/dist/mesheryApi.d.ts +75 -17
  61. package/dist/mesheryApi.js +1 -1
  62. package/dist/mesheryApi.mjs +1 -1
  63. package/package.json +1 -1
@@ -21,6 +21,8 @@ export interface paths {
21
21
  * Register a new connection
22
22
  * @description Register a new connection with credentials. Meshery Cloud reserves the GitHub App connection's identity (name `GitHub App`, sub_type `git`): only its GitHub authorization flow creates that connection, so a request naming it is refused with a `409` MeshKit error that names the reserved GitHub App connection identity.
23
23
  *
24
+ * Every connection belongs to exactly one organization. The server assigns `organizationId` from the session (`X-Current-Orgid`, then the caller's selected organization) and does not accept it in the body.
25
+ *
24
26
  * Desktop registration uses this shared operation, but kind `desktop` is implemented by Cloud: a server that does not support it rejects a `desktop` body with `400`. The heartbeat and deregistration routes are Cloud-only. A client desktop app install registers itself on every connect to Cloud, sign-in included, with kind `desktop`, type `platform`, sub_type `management`, status `connected`, and `metadata` matching `DesktopConnectionMetadata`. Servers implementing this contract must take the organization from the `X-Current-Orgid` header, refuse a `desktop` registration without it with `400`, and refuse a caller who is not a live member of that organization with `403`. They must deduplicate on (organization, owner, `metadata.installationId`): registering the same install again updates that connection and returns `200`, while a new connection returns `201`. A `desktop` body whose metadata lacks `installationId` is refused with `400`. Installs on one computer share `metadata.computerId`, so a server can group them by computer. The kind names the connection type, never the product that runs on the machine.
25
27
  *
26
28
  * A `desktop` registration whose `metadata.clientName` and `metadata.appVersion` fall below the server's minimum version for that client is refused with `426` and a `ClientUpgradeRequiredError` body; the connection, when it exists, is set to `maintenance`. Servers must link the API token that authenticated the registration to the connection (`metadata.tokenId`, server-written) and revoke that token when the connection is deregistered or deleted. When a later registration of the same connection authenticates with a different token, the server revokes the token previously linked to it. Registrations beyond the organization's device limit are accepted; the organization is flagged through the capabilities document's `session.deviceUsage` instead.
@@ -86,7 +88,7 @@ export interface paths {
86
88
  get: operations["getConnectionById"];
87
89
  /**
88
90
  * Update a connection
89
- * @description Update an existing connection. Meshery Cloud refuses, with a `409` MeshKit error naming the reserved identity, an edit that would give a connection the GitHub App connection's identity (name `GitHub App`, sub_type `git`). On the GitHub App connection itself, the server-written metadata keys `installations`, `installationId` and `installationsVerifiedAt` are carried forward from the stored row: a client edit can neither set nor erase them (other metadata keys are written as sent). Their shape is `GithubConnectionMetadata` in the v1beta3 `github` construct.
91
+ * @description Update an existing connection. Meshery Cloud refuses, with a `409` MeshKit error naming the reserved identity, an edit that would give a connection the GitHub App connection's identity (name `GitHub App`, sub_type `git`). On the GitHub App connection itself, the server-written metadata keys `installations`, `installationId` and `installationsVerifiedAt` are carried forward from the stored row: a client edit can neither set nor erase them (other metadata keys are written as sent). Their shape is `GithubConnectionMetadata` in the v1beta3 `github` construct. `organizationId` is not in the body. The server keeps the organization assigned at registration.
90
92
  */
91
93
  put: operations["updateConnection"];
92
94
  post?: never;
@@ -149,7 +151,7 @@ export interface paths {
149
151
  };
150
152
  /**
151
153
  * List the organization's desktop connections
152
- * @description Returns every live `desktop` connection in the session organization, whoever registered it, as a summary: `id`, `name`, `kind`, `owner`, `status` and `lastSeenAt` only. Any live member of the organization may read it, so members can see which computers share its work; a guest session cannot. Servers must never include the connection's credential, metadata (beyond `lastSeenAt`), URL or description here: the full connection stays readable only by its owner through `getConnections`. `status` follows the heartbeat rule of `recordConnectionHeartbeat` (a desktop connection silent for 3 minutes reads `disconnected`). A caller who is not a live member of the session organization receives `404`.
154
+ * @description Returns every live `desktop` connection in the session organization, whoever registered it, as a summary: `id`, `name`, `kind`, `owner`, `status`, `organizationId` and `lastSeenAt` only. Any live member of the organization may read it, so members can see which computers share its work; a guest session cannot. Servers must never include the connection's credential, metadata (beyond `lastSeenAt`), URL or description here: the full connection stays readable only by its owner through `getConnections`. `status` follows the heartbeat rule of `recordConnectionHeartbeat` (a desktop connection silent for 3 minutes reads `disconnected`). A caller who is not a live member of the session organization receives `404`.
153
155
  */
154
156
  get: operations["getDesktopConnectionsOfOrganization"];
155
157
  put?: never;
@@ -575,9 +577,9 @@ export interface components {
575
577
  deletedAt?: string | null;
576
578
  /**
577
579
  * Format: uuid
578
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
580
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
579
581
  */
580
- organizationId?: string;
582
+ organizationId: string;
581
583
  /** @description Associated environments for this connection */
582
584
  environments?: {
583
585
  /**
@@ -965,6 +967,11 @@ export interface components {
965
967
  * @description Time of the connection's last heartbeat (`metadata.lastSeenAt`). Null when it never sent one.
966
968
  */
967
969
  lastSeenAt?: string | null;
970
+ /**
971
+ * Format: uuid
972
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
973
+ */
974
+ readonly organizationId: string;
968
975
  };
969
976
  /** @description Page of connection summaries. */
970
977
  ConnectionSummaryPage: {
@@ -991,6 +998,11 @@ export interface components {
991
998
  * @description Time of the connection's last heartbeat (`metadata.lastSeenAt`). Null when it never sent one.
992
999
  */
993
1000
  lastSeenAt?: string | null;
1001
+ /**
1002
+ * Format: uuid
1003
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1004
+ */
1005
+ readonly organizationId: string;
994
1006
  }[];
995
1007
  /** @description Total number of connections on all pages. */
996
1008
  totalCount: number;
@@ -1276,9 +1288,9 @@ export interface components {
1276
1288
  deletedAt?: string | null;
1277
1289
  /**
1278
1290
  * Format: uuid
1279
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
1291
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
1280
1292
  */
1281
- organizationId?: string;
1293
+ organizationId: string;
1282
1294
  /** @description Associated environments for this connection */
1283
1295
  environments?: {
1284
1296
  /**
@@ -1428,7 +1440,7 @@ export interface components {
1428
1440
  */
1429
1441
  mode?: "operator" | "embedded";
1430
1442
  };
1431
- /** @description Payload for creating or updating a connection */
1443
+ /** @description Payload for creating or updating a connection. `organizationId` is not a client field. The server assigns it from the session organization. */
1432
1444
  ConnectionPayload: {
1433
1445
  /**
1434
1446
  * Format: uuid
@@ -2309,9 +2321,9 @@ export interface operations {
2309
2321
  deletedAt?: string | null;
2310
2322
  /**
2311
2323
  * Format: uuid
2312
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
2324
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
2313
2325
  */
2314
- organizationId?: string;
2326
+ organizationId: string;
2315
2327
  /** @description Associated environments for this connection */
2316
2328
  environments?: {
2317
2329
  /**
@@ -2428,7 +2440,7 @@ export interface operations {
2428
2440
  parameters: {
2429
2441
  query?: never;
2430
2442
  header?: {
2431
- /** @description Organization the connection is registered in. Required for kind `desktop`; ignored for other kinds. */
2443
+ /** @description Session organization. The server assigns `Connection.organizationId` from this header when it is present, and from the caller's selected organization when it is absent. Kind `desktop` requires the header: a desktop registration without it is refused with 400. */
2432
2444
  "X-Current-Orgid"?: string;
2433
2445
  };
2434
2446
  path?: never;
@@ -2919,9 +2931,9 @@ export interface operations {
2919
2931
  deletedAt?: string | null;
2920
2932
  /**
2921
2933
  * Format: uuid
2922
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
2934
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
2923
2935
  */
2924
- organizationId?: string;
2936
+ organizationId: string;
2925
2937
  /** @description Associated environments for this connection */
2926
2938
  environments?: {
2927
2939
  /**
@@ -3283,9 +3295,9 @@ export interface operations {
3283
3295
  deletedAt?: string | null;
3284
3296
  /**
3285
3297
  * Format: uuid
3286
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
3298
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
3287
3299
  */
3288
- organizationId?: string;
3300
+ organizationId: string;
3289
3301
  /** @description Associated environments for this connection */
3290
3302
  environments?: {
3291
3303
  /**
@@ -3873,9 +3885,9 @@ export interface operations {
3873
3885
  deletedAt?: string | null;
3874
3886
  /**
3875
3887
  * Format: uuid
3876
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
3888
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
3877
3889
  */
3878
- organizationId?: string;
3890
+ organizationId: string;
3879
3891
  /** @description Associated environments for this connection */
3880
3892
  environments?: {
3881
3893
  /**
@@ -4481,9 +4493,9 @@ export interface operations {
4481
4493
  deletedAt?: string | null;
4482
4494
  /**
4483
4495
  * Format: uuid
4484
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
4496
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
4485
4497
  */
4486
- organizationId?: string;
4498
+ organizationId: string;
4487
4499
  /** @description Associated environments for this connection */
4488
4500
  environments?: {
4489
4501
  /**
@@ -4981,9 +4993,9 @@ export interface operations {
4981
4993
  deletedAt?: string | null;
4982
4994
  /**
4983
4995
  * Format: uuid
4984
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
4996
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
4985
4997
  */
4986
- organizationId?: string;
4998
+ organizationId: string;
4987
4999
  /** @description Associated environments for this connection */
4988
5000
  environments?: {
4989
5001
  /**
@@ -5197,6 +5209,11 @@ export interface operations {
5197
5209
  * @description Time of the connection's last heartbeat (`metadata.lastSeenAt`). Null when it never sent one.
5198
5210
  */
5199
5211
  lastSeenAt?: string | null;
5212
+ /**
5213
+ * Format: uuid
5214
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5215
+ */
5216
+ readonly organizationId: string;
5200
5217
  }[];
5201
5218
  /** @description Total number of connections on all pages. */
5202
5219
  totalCount: number;
@@ -5585,9 +5602,9 @@ export interface operations {
5585
5602
  deletedAt?: string | null;
5586
5603
  /**
5587
5604
  * Format: uuid
5588
- * @description Organization the connection is registered in, taken from the `X-Current-Orgid` header on registration. Servers implementing this contract use it, with the owner and `metadata.installationId`, as the deduplication key for `desktop` connections. Lets an organization list and count its connections (for example its registered desktop installs) without going through each owner. Absent on connections that predate it.
5605
+ * @description The organization the connection belongs to. The server sets it from the session organization (`X-Current-Orgid`, or the caller's selected organization when that header is absent) when the connection is registered, and keeps it on later updates. Never accepted from clients on connection write payloads. Not marked readOnly: `RegistrantData` inlines this entity into registry registration requests, and readOnly there drops the connection field from the generated RTK client. A value sent on that inlined connection is ignored. With the owner and `metadata.installationId`, it is the deduplication key for `desktop` connections.
5589
5606
  */
5590
- organizationId?: string;
5607
+ organizationId: string;
5591
5608
  /** @description Associated environments for this connection */
5592
5609
  environments?: {
5593
5610
  /**