@meshery/schemas 1.3.104 → 1.3.105

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
- * 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.
24
+ * Every connection registered 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. When the session names none, the server may use the caller's only organization (Meshery Cloud: the only live organization the caller belongs to, else the only one of those the caller owns); it must not guess between several, and answers 400 instead. Connections registered before servers recorded an organization may have none.
25
25
  *
26
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.
27
27
  *
@@ -577,9 +577,9 @@ export interface components {
577
577
  deletedAt?: string | null;
578
578
  /**
579
579
  * Format: uuid
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.
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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
581
581
  */
582
- organizationId: string;
582
+ organizationId?: string | null;
583
583
  /** @description Associated environments for this connection */
584
584
  environments?: {
585
585
  /**
@@ -1288,9 +1288,9 @@ export interface components {
1288
1288
  deletedAt?: string | null;
1289
1289
  /**
1290
1290
  * Format: uuid
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.
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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
1292
1292
  */
1293
- organizationId: string;
1293
+ organizationId?: string | null;
1294
1294
  /** @description Associated environments for this connection */
1295
1295
  environments?: {
1296
1296
  /**
@@ -2346,9 +2346,9 @@ export interface operations {
2346
2346
  deletedAt?: string | null;
2347
2347
  /**
2348
2348
  * Format: uuid
2349
- * @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.
2349
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
2350
2350
  */
2351
- organizationId: string;
2351
+ organizationId?: string | null;
2352
2352
  /** @description Associated environments for this connection */
2353
2353
  environments?: {
2354
2354
  /**
@@ -2956,9 +2956,9 @@ export interface operations {
2956
2956
  deletedAt?: string | null;
2957
2957
  /**
2958
2958
  * Format: uuid
2959
- * @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.
2959
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
2960
2960
  */
2961
- organizationId: string;
2961
+ organizationId?: string | null;
2962
2962
  /** @description Associated environments for this connection */
2963
2963
  environments?: {
2964
2964
  /**
@@ -3320,9 +3320,9 @@ export interface operations {
3320
3320
  deletedAt?: string | null;
3321
3321
  /**
3322
3322
  * Format: uuid
3323
- * @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.
3323
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
3324
3324
  */
3325
- organizationId: string;
3325
+ organizationId?: string | null;
3326
3326
  /** @description Associated environments for this connection */
3327
3327
  environments?: {
3328
3328
  /**
@@ -3935,9 +3935,9 @@ export interface operations {
3935
3935
  deletedAt?: string | null;
3936
3936
  /**
3937
3937
  * Format: uuid
3938
- * @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.
3938
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
3939
3939
  */
3940
- organizationId: string;
3940
+ organizationId?: string | null;
3941
3941
  /** @description Associated environments for this connection */
3942
3942
  environments?: {
3943
3943
  /**
@@ -4543,9 +4543,9 @@ export interface operations {
4543
4543
  deletedAt?: string | null;
4544
4544
  /**
4545
4545
  * Format: uuid
4546
- * @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.
4546
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
4547
4547
  */
4548
- organizationId: string;
4548
+ organizationId?: string | null;
4549
4549
  /** @description Associated environments for this connection */
4550
4550
  environments?: {
4551
4551
  /**
@@ -5043,9 +5043,9 @@ export interface operations {
5043
5043
  deletedAt?: string | null;
5044
5044
  /**
5045
5045
  * Format: uuid
5046
- * @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.
5046
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
5047
5047
  */
5048
- organizationId: string;
5048
+ organizationId?: string | null;
5049
5049
  /** @description Associated environments for this connection */
5050
5050
  environments?: {
5051
5051
  /**
@@ -5677,9 +5677,9 @@ export interface operations {
5677
5677
  deletedAt?: string | null;
5678
5678
  /**
5679
5679
  * Format: uuid
5680
- * @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.
5680
+ * @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. Every connection a server registers under this contract carries it. Absent only on connections registered before servers recorded an organization and whose owner belongs to several, so none can be assigned without guessing; those are scoped by their owner. A server may backfill a legacy connection whose organization is unambiguous. 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.
5681
5681
  */
5682
- organizationId: string;
5682
+ organizationId?: string | null;
5683
5683
  /** @description Associated environments for this connection */
5684
5684
  environments?: {
5685
5685
  /**