@meshery/schemas 1.3.94 → 1.3.96

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.
@@ -21,7 +21,7 @@ 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
- * 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.machineId`): registering the same machine again updates that connection and returns `200`, while a new connection returns `201`. A `desktop` body whose metadata lacks `machineId` is refused with `400`. The kind names the connection type, never the product that runs on the machine.
24
+ * 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
25
  *
26
26
  * 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.
27
27
  */
@@ -140,7 +140,7 @@ export interface paths {
140
140
  patch?: never;
141
141
  trace?: never;
142
142
  };
143
- "/api/integrations/connections/desktop/{machineId}": {
143
+ "/api/integrations/connections/desktop/{installationId}": {
144
144
  parameters: {
145
145
  query?: never;
146
146
  header?: never;
@@ -152,7 +152,7 @@ export interface paths {
152
152
  post?: never;
153
153
  /**
154
154
  * Deregister a desktop app install
155
- * @description Delete the caller's `desktop` connection whose `metadata.machineId` matches, as a desktop app install does on sign-out or uninstall. Servers implementing this contract must scope the deletion to the caller: a connection registered by another user is not found. Servers must revoke the API token linked to each deleted connection (`metadata.tokenId`).
155
+ * @description Delete the caller's `desktop` connection whose `metadata.installationId` matches, as a desktop app install does on sign-out or uninstall. Servers implementing this contract must scope the deletion to the caller: a connection registered by another user is not found. Servers must revoke the API token linked to each deleted connection (`metadata.tokenId`).
156
156
  */
157
157
  delete: operations["deregisterDesktopConnection"];
158
158
  options?: never;
@@ -555,7 +555,7 @@ export interface components {
555
555
  deletedAt?: string | null;
556
556
  /**
557
557
  * Format: uuid
558
- * @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.machineId`, 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.
558
+ * @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.
559
559
  */
560
560
  organizationId?: string;
561
561
  /** @description Associated environments for this connection */
@@ -1199,7 +1199,7 @@ export interface components {
1199
1199
  deletedAt?: string | null;
1200
1200
  /**
1201
1201
  * Format: uuid
1202
- * @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.machineId`, 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.
1202
+ * @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.
1203
1203
  */
1204
1204
  organizationId?: string;
1205
1205
  /** @description Associated environments for this connection */
@@ -1292,12 +1292,14 @@ export interface components {
1292
1292
  [key: string]: number;
1293
1293
  };
1294
1294
  };
1295
- /** @description Stable identifier of a desktop app install, generated once per install. It is the machine part of the deduplication key and the `machineId` path parameter. */
1296
- DesktopMachineId: string;
1297
- /** @description Metadata of a `desktop` connection: a desktop app install that registered itself on every connect to Cloud. Servers implementing this contract must validate `metadata` against this schema when a registration has kind `desktop`. The deduplication key is (organization, owner, `machineId`). `lastSeenAt` is set by the server on registration and on each heartbeat. Servers must show this metadata in organization listings only to the connection's owner and to organization admins. */
1295
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the install part of the deduplication key and the `installationId` path parameter. */
1296
+ DesktopInstallationId: string;
1297
+ /** @description Metadata of a `desktop` connection: a desktop app install that registered itself on every connect to Cloud. Servers implementing this contract must validate `metadata` against this schema when a registration has kind `desktop`. The deduplication key is (organization, owner, `installationId`). `lastSeenAt` is set by the server on registration and on each heartbeat. Servers must show this metadata in organization listings only to the connection's owner and to organization admins. */
1298
1298
  DesktopConnectionMetadata: {
1299
- /** @description Stable identifier of a desktop app install: generated once on the install's first launch (a UUID is recommended), kept with the app's local state, and never derived from the host name, a process id or a hardware serial. A reinstall that discards local state is a new install. It is the machine part of the deduplication key. */
1300
- machineId: string;
1299
+ /** @description Stable identifier of a desktop app install: generated once on the install's first launch (a UUID is recommended), kept with the app's local state, and never derived from the host name, a process id or a hardware identifier. A reinstall that discards local state is a new install. It is the install part of the deduplication key. */
1300
+ installationId: string;
1301
+ /** @description Stable identifier of the computer the install runs on, shared by every install on that computer whoever signs in: the lowercase hex SHA-256 digest of a fixed, client-defined salt followed by the operating system's hardware identifier (for example the platform UUID on macOS). Clients must send only this digest, never the raw hardware identifier or a serial number. Absent when the client cannot read a hardware identifier. */
1302
+ computerId?: string;
1301
1303
  /** @description Host name of the machine. */
1302
1304
  hostname?: string;
1303
1305
  /** @description Operating system, for example `macos`. */
@@ -1907,8 +1909,8 @@ export interface components {
1907
1909
  search: string;
1908
1910
  /** @description Sort order */
1909
1911
  order: string;
1910
- /** @description Stable per-install machine identifier from `metadata.machineId`. */
1911
- machineId: string;
1912
+ /** @description Installation identifier from `metadata.installationId`. */
1913
+ installationId: string;
1912
1914
  /** @description Organization ID to scope the request. */
1913
1915
  orgIdQuery: string;
1914
1916
  };
@@ -2230,7 +2232,7 @@ export interface operations {
2230
2232
  deletedAt?: string | null;
2231
2233
  /**
2232
2234
  * Format: uuid
2233
- * @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.machineId`, 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.
2235
+ * @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.
2234
2236
  */
2235
2237
  organizationId?: string;
2236
2238
  /** @description Associated environments for this connection */
@@ -2840,7 +2842,7 @@ export interface operations {
2840
2842
  deletedAt?: string | null;
2841
2843
  /**
2842
2844
  * Format: uuid
2843
- * @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.machineId`, 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.
2845
+ * @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.
2844
2846
  */
2845
2847
  organizationId?: string;
2846
2848
  /** @description Associated environments for this connection */
@@ -3204,7 +3206,7 @@ export interface operations {
3204
3206
  deletedAt?: string | null;
3205
3207
  /**
3206
3208
  * Format: uuid
3207
- * @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.machineId`, 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.
3209
+ * @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.
3208
3210
  */
3209
3211
  organizationId?: string;
3210
3212
  /** @description Associated environments for this connection */
@@ -3794,7 +3796,7 @@ export interface operations {
3794
3796
  deletedAt?: string | null;
3795
3797
  /**
3796
3798
  * Format: uuid
3797
- * @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.machineId`, 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.
3799
+ * @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.
3798
3800
  */
3799
3801
  organizationId?: string;
3800
3802
  /** @description Associated environments for this connection */
@@ -4402,7 +4404,7 @@ export interface operations {
4402
4404
  deletedAt?: string | null;
4403
4405
  /**
4404
4406
  * Format: uuid
4405
- * @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.machineId`, 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.
4407
+ * @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.
4406
4408
  */
4407
4409
  organizationId?: string;
4408
4410
  /** @description Associated environments for this connection */
@@ -4902,7 +4904,7 @@ export interface operations {
4902
4904
  deletedAt?: string | null;
4903
4905
  /**
4904
4906
  * Format: uuid
4905
- * @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.machineId`, 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.
4907
+ * @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.
4906
4908
  */
4907
4909
  organizationId?: string;
4908
4910
  /** @description Associated environments for this connection */
@@ -5077,8 +5079,8 @@ export interface operations {
5077
5079
  query?: never;
5078
5080
  header?: never;
5079
5081
  path: {
5080
- /** @description Stable per-install machine identifier from `metadata.machineId`. */
5081
- machineId: string;
5082
+ /** @description Installation identifier from `metadata.installationId`. */
5083
+ installationId: string;
5082
5084
  };
5083
5085
  cookie?: never;
5084
5086
  };
@@ -5412,7 +5414,7 @@ export interface operations {
5412
5414
  deletedAt?: string | null;
5413
5415
  /**
5414
5416
  * Format: uuid
5415
- * @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.machineId`, 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.
5417
+ * @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.
5416
5418
  */
5417
5419
  organizationId?: string;
5418
5420
  /** @description Associated environments for this connection */