@meshery/schemas 1.3.80 → 1.3.81

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.
@@ -20,6 +20,8 @@ export interface paths {
20
20
  /**
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
+ *
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 sign-in 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.
23
25
  */
24
26
  post: operations["registerConnection"];
25
27
  delete?: never;
@@ -136,6 +138,46 @@ export interface paths {
136
138
  patch?: never;
137
139
  trace?: never;
138
140
  };
141
+ "/api/integrations/connections/desktop/{machineId}": {
142
+ parameters: {
143
+ query?: never;
144
+ header?: never;
145
+ path?: never;
146
+ cookie?: never;
147
+ };
148
+ get?: never;
149
+ put?: never;
150
+ post?: never;
151
+ /**
152
+ * Deregister a desktop app install
153
+ * @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.
154
+ */
155
+ delete: operations["deregisterDesktopConnection"];
156
+ options?: never;
157
+ head?: never;
158
+ patch?: never;
159
+ trace?: never;
160
+ };
161
+ "/api/integrations/connections/{connectionId}/heartbeat": {
162
+ parameters: {
163
+ query?: never;
164
+ header?: never;
165
+ path?: never;
166
+ cookie?: never;
167
+ };
168
+ get?: never;
169
+ put?: never;
170
+ /**
171
+ * Record a connection heartbeat
172
+ * @description Mark the caller's connection as alive. Servers implementing this contract must set `metadata.lastSeenAt` to the current time and, when the connection is `disconnected`, set its status back to `connected`. Servers must report a connection whose `metadata.lastSeenAt` is older than 3 minutes as `disconnected` until its next heartbeat. The request has no body, so a heartbeat cannot change anything else about the connection.
173
+ */
174
+ post: operations["recordConnectionHeartbeat"];
175
+ delete?: never;
176
+ options?: never;
177
+ head?: never;
178
+ patch?: never;
179
+ trace?: never;
180
+ };
139
181
  "/api/integrations/connections/kubernetes/{connectionId}/context": {
140
182
  parameters: {
141
183
  query?: never;
@@ -261,7 +303,7 @@ export interface components {
261
303
  type: string;
262
304
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
263
305
  subType: string;
264
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
306
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
265
307
  kind: string;
266
308
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
267
309
  modelReference?: {
@@ -509,6 +551,11 @@ export interface components {
509
551
  * @description Timestamp when the connection was soft-deleted, if applicable.
510
552
  */
511
553
  deletedAt?: string | null;
554
+ /**
555
+ * Format: uuid
556
+ * @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.
557
+ */
558
+ organizationId?: string;
512
559
  /** @description Associated environments for this connection */
513
560
  environments?: {
514
561
  /**
@@ -900,7 +947,7 @@ export interface components {
900
947
  type: string;
901
948
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
902
949
  subType: string;
903
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
950
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
904
951
  kind: string;
905
952
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
906
953
  modelReference?: {
@@ -1148,6 +1195,11 @@ export interface components {
1148
1195
  * @description Timestamp when the connection was soft-deleted, if applicable.
1149
1196
  */
1150
1197
  deletedAt?: string | null;
1198
+ /**
1199
+ * Format: uuid
1200
+ * @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.
1201
+ */
1202
+ organizationId?: string;
1151
1203
  /** @description Associated environments for this connection */
1152
1204
  environments?: {
1153
1205
  /**
@@ -1238,6 +1290,24 @@ export interface components {
1238
1290
  [key: string]: number;
1239
1291
  };
1240
1292
  };
1293
+ /** @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. */
1294
+ DesktopMachineId: string;
1295
+ /** @description Metadata of a `desktop` connection: a desktop app install that registered itself on sign-in. 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. */
1296
+ DesktopConnectionMetadata: {
1297
+ /** @description Stable identifier of a desktop app install, generated once per install. It is the machine part of the deduplication key. */
1298
+ machineId: string;
1299
+ /** @description Host name of the machine. */
1300
+ hostname?: string;
1301
+ /** @description Operating system, for example `macos`. */
1302
+ os?: string;
1303
+ /** @description Version of the desktop app. */
1304
+ appVersion?: string;
1305
+ /**
1306
+ * Format: date-time
1307
+ * @description Server time of the last registration or heartbeat.
1308
+ */
1309
+ lastSeenAt?: string;
1310
+ };
1241
1311
  /**
1242
1312
  * @description Connection Status Value
1243
1313
  * @enum {string}
@@ -1824,6 +1894,8 @@ export interface components {
1824
1894
  search: string;
1825
1895
  /** @description Sort order */
1826
1896
  order: string;
1897
+ /** @description Stable per-install machine identifier from `metadata.machineId`. */
1898
+ machineId: string;
1827
1899
  /** @description Organization ID to scope the request. */
1828
1900
  orgIdQuery: string;
1829
1901
  };
@@ -1895,7 +1967,7 @@ export interface operations {
1895
1967
  type: string;
1896
1968
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
1897
1969
  subType: string;
1898
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
1970
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
1899
1971
  kind: string;
1900
1972
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
1901
1973
  modelReference?: {
@@ -2143,6 +2215,11 @@ export interface operations {
2143
2215
  * @description Timestamp when the connection was soft-deleted, if applicable.
2144
2216
  */
2145
2217
  deletedAt?: string | null;
2218
+ /**
2219
+ * Format: uuid
2220
+ * @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.
2221
+ */
2222
+ organizationId?: string;
2146
2223
  /** @description Associated environments for this connection */
2147
2224
  environments?: {
2148
2225
  /**
@@ -2258,7 +2335,10 @@ export interface operations {
2258
2335
  registerConnection: {
2259
2336
  parameters: {
2260
2337
  query?: never;
2261
- header?: never;
2338
+ header?: {
2339
+ /** @description Organization the connection is registered in. Required for kind `desktop`; ignored for other kinds. */
2340
+ "X-Current-Orgid"?: string;
2341
+ };
2262
2342
  path?: never;
2263
2343
  cookie?: never;
2264
2344
  };
@@ -2467,8 +2547,8 @@ export interface operations {
2467
2547
  };
2468
2548
  };
2469
2549
  responses: {
2470
- /** @description Connection registered */
2471
- 201: {
2550
+ /** @description Existing desktop connection for this machine updated */
2551
+ 200: {
2472
2552
  headers: {
2473
2553
  [name: string]: unknown;
2474
2554
  };
@@ -2497,7 +2577,7 @@ export interface operations {
2497
2577
  type: string;
2498
2578
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
2499
2579
  subType: string;
2500
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
2580
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
2501
2581
  kind: string;
2502
2582
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
2503
2583
  modelReference?: {
@@ -2745,6 +2825,11 @@ export interface operations {
2745
2825
  * @description Timestamp when the connection was soft-deleted, if applicable.
2746
2826
  */
2747
2827
  deletedAt?: string | null;
2828
+ /**
2829
+ * Format: uuid
2830
+ * @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.
2831
+ */
2832
+ organizationId?: string;
2748
2833
  /** @description Associated environments for this connection */
2749
2834
  environments?: {
2750
2835
  /**
@@ -2826,198 +2911,8 @@ export interface operations {
2826
2911
  };
2827
2912
  };
2828
2913
  };
2829
- /** @description Invalid request body or request param */
2830
- 400: {
2831
- headers: {
2832
- [name: string]: unknown;
2833
- };
2834
- content: {
2835
- "text/plain": string;
2836
- };
2837
- };
2838
- /** @description Expired JWT token used or insufficient privilege */
2839
- 401: {
2840
- headers: {
2841
- [name: string]: unknown;
2842
- };
2843
- content: {
2844
- "text/plain": string;
2845
- };
2846
- };
2847
- /** @description Conflict */
2848
- 409: {
2849
- headers: {
2850
- [name: string]: unknown;
2851
- };
2852
- content: {
2853
- "application/json": {
2854
- /** @description The sentence the caller is shown. */
2855
- error: string;
2856
- /** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
2857
- code?: string;
2858
- /**
2859
- * @description MeshKit severity name. Omitted when MeshKit reports none.
2860
- * @enum {string}
2861
- */
2862
- severity?: "emergency" | "alert" | "critical" | "fatal";
2863
- /** @description MeshKit's probable causes of the error. */
2864
- probableCause?: string[];
2865
- /** @description MeshKit's suggested remediations for the error. */
2866
- suggestedRemediation?: string[];
2867
- };
2868
- };
2869
- };
2870
- /** @description Internal server error */
2871
- 500: {
2872
- headers: {
2873
- [name: string]: unknown;
2874
- };
2875
- content: {
2876
- "text/plain": string;
2877
- };
2878
- };
2879
- };
2880
- };
2881
- processConnectionRegistration: {
2882
- parameters: {
2883
- query?: never;
2884
- header?: never;
2885
- path?: never;
2886
- cookie?: never;
2887
- };
2888
- requestBody: {
2889
- content: {
2890
- "application/json": {
2891
- /**
2892
- * Format: uuid
2893
- * @description Registration process tracker. Returned by the `initialize` bootstrap or minted client-side; echoed on every subsequent event for the same registration.
2894
- */
2895
- id?: string;
2896
- /** @description Connection kind (e.g. `kubernetes`, `grafana`, `prometheus`). */
2897
- kind: string;
2898
- /**
2899
- * @description State-machine event to dispatch. `initialize` returns the registration bootstrap; every other event advances the tracked registration. `not found` is the machine's literal event name.
2900
- * @enum {string}
2901
- */
2902
- status: "initialize" | "discovery" | "register" | "connect" | "disconnect" | "ignore" | "delete" | "not found" | "noop" | "exit";
2903
- /** @description Connection name. */
2904
- name?: string;
2905
- /** @description Connection type. */
2906
- type?: string;
2907
- /** @description Connection sub-type. */
2908
- subType?: string;
2909
- /** @description Registry model the connection's definition belongs to. */
2910
- model?: string;
2911
- /** @description Connection metadata gathered so far in the flow. */
2912
- metadata?: Record<string, never>;
2913
- /** @description Credential secret material for the connection. */
2914
- credentialSecret?: Record<string, never>;
2915
- /**
2916
- * Format: uuid
2917
- * @description Existing credential to associate instead of a new secret.
2918
- */
2919
- credentialId?: string;
2920
- /** @description When true the server registers the connection without verifying the supplied credential first. */
2921
- skipCredentialVerification?: boolean;
2922
- };
2923
- };
2924
- };
2925
- responses: {
2926
- /** @description Registration bootstrap for status `initialize`; empty body for every other status. */
2927
- 200: {
2928
- headers: {
2929
- [name: string]: unknown;
2930
- };
2931
- content: {
2932
- "application/json": {
2933
- /**
2934
- * Format: uuid
2935
- * @description Registration process tracker to echo on subsequent events.
2936
- */
2937
- id: string;
2938
- /** @description Registry component definition (`{Kind}Connection`) describing the connection, including its JSON-encoded `schema`. */
2939
- connection: Record<string, never>;
2940
- /** @description Registry component definition (`{Kind}Credential`) describing the credential, including its JSON-encoded `schema`. Absent when the kind defines no credential component. */
2941
- credential?: Record<string, never>;
2942
- };
2943
- };
2944
- };
2945
- /** @description Malformed payload, or no connection component is registered for the requested kind. */
2946
- 400: {
2947
- headers: {
2948
- [name: string]: unknown;
2949
- };
2950
- content?: never;
2951
- };
2952
- /** @description Expired JWT token used or insufficient privilege */
2953
- 401: {
2954
- headers: {
2955
- [name: string]: unknown;
2956
- };
2957
- content: {
2958
- "text/plain": string;
2959
- };
2960
- };
2961
- /** @description Failed to resolve the provider token, or to initialize / signal the registration state machine. */
2962
- 500: {
2963
- headers: {
2964
- [name: string]: unknown;
2965
- };
2966
- content?: never;
2967
- };
2968
- };
2969
- };
2970
- cancelConnectionRegister: {
2971
- parameters: {
2972
- query?: never;
2973
- header?: never;
2974
- path: {
2975
- /** @description Registration process tracker id to discard. */
2976
- registrationId: string;
2977
- };
2978
- cookie?: never;
2979
- };
2980
- requestBody?: never;
2981
- responses: {
2982
- /** @description Registration process discarded. */
2983
- 204: {
2984
- headers: {
2985
- [name: string]: unknown;
2986
- };
2987
- content?: never;
2988
- };
2989
- /** @description registrationId is not a valid UUID. */
2990
- 400: {
2991
- headers: {
2992
- [name: string]: unknown;
2993
- };
2994
- content?: never;
2995
- };
2996
- /** @description Expired JWT token used or insufficient privilege */
2997
- 401: {
2998
- headers: {
2999
- [name: string]: unknown;
3000
- };
3001
- content: {
3002
- "text/plain": string;
3003
- };
3004
- };
3005
- };
3006
- };
3007
- getConnectionById: {
3008
- parameters: {
3009
- query?: never;
3010
- header?: never;
3011
- path: {
3012
- /** @description Connection ID */
3013
- connectionId: string;
3014
- };
3015
- cookie?: never;
3016
- };
3017
- requestBody?: never;
3018
- responses: {
3019
- /** @description Connection details */
3020
- 200: {
2914
+ /** @description Connection registered */
2915
+ 201: {
3021
2916
  headers: {
3022
2917
  [name: string]: unknown;
3023
2918
  };
@@ -3046,7 +2941,7 @@ export interface operations {
3046
2941
  type: string;
3047
2942
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
3048
2943
  subType: string;
3049
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
2944
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
3050
2945
  kind: string;
3051
2946
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
3052
2947
  modelReference?: {
@@ -3294,6 +3189,11 @@ export interface operations {
3294
3189
  * @description Timestamp when the connection was soft-deleted, if applicable.
3295
3190
  */
3296
3191
  deletedAt?: string | null;
3192
+ /**
3193
+ * Format: uuid
3194
+ * @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.
3195
+ */
3196
+ organizationId?: string;
3297
3197
  /** @description Associated environments for this connection */
3298
3198
  environments?: {
3299
3199
  /**
@@ -3375,8 +3275,8 @@ export interface operations {
3375
3275
  };
3376
3276
  };
3377
3277
  };
3378
- /** @description Expired JWT token used or insufficient privilege */
3379
- 401: {
3278
+ /** @description Invalid request body or request param */
3279
+ 400: {
3380
3280
  headers: {
3381
3281
  [name: string]: unknown;
3382
3282
  };
@@ -3384,8 +3284,17 @@ export interface operations {
3384
3284
  "text/plain": string;
3385
3285
  };
3386
3286
  };
3387
- /** @description Result not found */
3388
- 404: {
3287
+ /** @description Expired JWT token used or insufficient privilege */
3288
+ 401: {
3289
+ headers: {
3290
+ [name: string]: unknown;
3291
+ };
3292
+ content: {
3293
+ "text/plain": string;
3294
+ };
3295
+ };
3296
+ /** @description Forbidden */
3297
+ 403: {
3389
3298
  headers: {
3390
3299
  [name: string]: unknown;
3391
3300
  };
@@ -3393,6 +3302,29 @@ export interface operations {
3393
3302
  "text/plain": string;
3394
3303
  };
3395
3304
  };
3305
+ /** @description Conflict */
3306
+ 409: {
3307
+ headers: {
3308
+ [name: string]: unknown;
3309
+ };
3310
+ content: {
3311
+ "application/json": {
3312
+ /** @description The sentence the caller is shown. */
3313
+ error: string;
3314
+ /** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
3315
+ code?: string;
3316
+ /**
3317
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
3318
+ * @enum {string}
3319
+ */
3320
+ severity?: "emergency" | "alert" | "critical" | "fatal";
3321
+ /** @description MeshKit's probable causes of the error. */
3322
+ probableCause?: string[];
3323
+ /** @description MeshKit's suggested remediations for the error. */
3324
+ suggestedRemediation?: string[];
3325
+ };
3326
+ };
3327
+ };
3396
3328
  /** @description Internal server error */
3397
3329
  500: {
3398
3330
  headers: {
@@ -3404,14 +3336,11 @@ export interface operations {
3404
3336
  };
3405
3337
  };
3406
3338
  };
3407
- updateConnection: {
3339
+ processConnectionRegistration: {
3408
3340
  parameters: {
3409
3341
  query?: never;
3410
3342
  header?: never;
3411
- path: {
3412
- /** @description Connection ID */
3413
- connectionId: string;
3414
- };
3343
+ path?: never;
3415
3344
  cookie?: never;
3416
3345
  };
3417
3346
  requestBody: {
@@ -3419,97 +3348,631 @@ export interface operations {
3419
3348
  "application/json": {
3420
3349
  /**
3421
3350
  * Format: uuid
3422
- * @description Connection ID
3351
+ * @description Registration process tracker. Returned by the `initialize` bootstrap or minted client-side; echoed on every subsequent event for the same registration.
3423
3352
  */
3424
3353
  id?: string;
3425
- /** @description Connection name */
3426
- name: string;
3427
- /** @description Connection kind */
3354
+ /** @description Connection kind (e.g. `kubernetes`, `grafana`, `prometheus`). */
3428
3355
  kind: string;
3429
- /** @description Connection type */
3430
- type: string;
3431
- /** @description Connection sub-type */
3432
- subType: string;
3433
- /** @description Credential secret data */
3434
- credentialSecret?: Record<string, never>;
3435
- /** @description Connection metadata */
3356
+ /**
3357
+ * @description State-machine event to dispatch. `initialize` returns the registration bootstrap; every other event advances the tracked registration. `not found` is the machine's literal event name.
3358
+ * @enum {string}
3359
+ */
3360
+ status: "initialize" | "discovery" | "register" | "connect" | "disconnect" | "ignore" | "delete" | "not found" | "noop" | "exit";
3361
+ /** @description Connection name. */
3362
+ name?: string;
3363
+ /** @description Connection type. */
3364
+ type?: string;
3365
+ /** @description Connection sub-type. */
3366
+ subType?: string;
3367
+ /** @description Registry model the connection's definition belongs to. */
3368
+ model?: string;
3369
+ /** @description Connection metadata gathered so far in the flow. */
3436
3370
  metadata?: Record<string, never>;
3437
- /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
3438
- styles?: ({
3439
- /** @description Primary color of the component used for UI representation. */
3440
- primaryColor: string;
3441
- /** @description Secondary color of the entity used for UI representation. */
3442
- secondaryColor?: string;
3443
- /** @description White SVG of the entity used for UI representation on dark background. */
3444
- svgWhite: string;
3445
- /** @description Colored SVG of the entity used for UI representation on light background. */
3446
- svgColor: string;
3447
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
3448
- svgComplete: string;
3449
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
3450
- color?: string;
3451
- /** @description The opacity of the label text, including its outline. */
3452
- textOpacity?: number;
3453
- /** @description A comma-separated list of font names to use on the label text. */
3454
- fontFamily?: string;
3455
- /** @description The size of the label text. */
3456
- fontSize?: string;
3457
- /** @description A CSS font style to be applied to the label text. */
3458
- fontStyle?: string;
3459
- /** @description A CSS font weight to be applied to the label text. */
3460
- fontWeight?: string;
3371
+ /** @description Credential secret material for the connection. */
3372
+ credentialSecret?: Record<string, never>;
3373
+ /**
3374
+ * Format: uuid
3375
+ * @description Existing credential to associate instead of a new secret.
3376
+ */
3377
+ credentialId?: string;
3378
+ /** @description When true the server registers the connection without verifying the supplied credential first. */
3379
+ skipCredentialVerification?: boolean;
3380
+ };
3381
+ };
3382
+ };
3383
+ responses: {
3384
+ /** @description Registration bootstrap for status `initialize`; empty body for every other status. */
3385
+ 200: {
3386
+ headers: {
3387
+ [name: string]: unknown;
3388
+ };
3389
+ content: {
3390
+ "application/json": {
3461
3391
  /**
3462
- * @description A transformation to apply to the label text
3463
- * @enum {string}
3392
+ * Format: uuid
3393
+ * @description Registration process tracker to echo on subsequent events.
3464
3394
  */
3465
- textTransform?: "none" | "uppercase" | "lowercase";
3466
- /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
3467
- opacity?: number;
3468
- /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
3469
- zIndex?: number;
3470
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
3471
- label?: string;
3472
- /** @description The animation to apply to the element. example ripple,bounce,etc */
3473
- animation?: Record<string, never>;
3474
- } & {
3475
- [key: string]: unknown;
3476
- }) & {
3395
+ id: string;
3396
+ /** @description Registry component definition (`{Kind}Connection`) describing the connection, including its JSON-encoded `schema`. */
3397
+ connection: Record<string, never>;
3398
+ /** @description Registry component definition (`{Kind}Credential`) describing the credential, including its JSON-encoded `schema`. Absent when the kind defines no credential component. */
3399
+ credential?: Record<string, never>;
3400
+ };
3401
+ };
3402
+ };
3403
+ /** @description Malformed payload, or no connection component is registered for the requested kind. */
3404
+ 400: {
3405
+ headers: {
3406
+ [name: string]: unknown;
3407
+ };
3408
+ content?: never;
3409
+ };
3410
+ /** @description Expired JWT token used or insufficient privilege */
3411
+ 401: {
3412
+ headers: {
3413
+ [name: string]: unknown;
3414
+ };
3415
+ content: {
3416
+ "text/plain": string;
3417
+ };
3418
+ };
3419
+ /** @description Failed to resolve the provider token, or to initialize / signal the registration state machine. */
3420
+ 500: {
3421
+ headers: {
3422
+ [name: string]: unknown;
3423
+ };
3424
+ content?: never;
3425
+ };
3426
+ };
3427
+ };
3428
+ cancelConnectionRegister: {
3429
+ parameters: {
3430
+ query?: never;
3431
+ header?: never;
3432
+ path: {
3433
+ /** @description Registration process tracker id to discard. */
3434
+ registrationId: string;
3435
+ };
3436
+ cookie?: never;
3437
+ };
3438
+ requestBody?: never;
3439
+ responses: {
3440
+ /** @description Registration process discarded. */
3441
+ 204: {
3442
+ headers: {
3443
+ [name: string]: unknown;
3444
+ };
3445
+ content?: never;
3446
+ };
3447
+ /** @description registrationId is not a valid UUID. */
3448
+ 400: {
3449
+ headers: {
3450
+ [name: string]: unknown;
3451
+ };
3452
+ content?: never;
3453
+ };
3454
+ /** @description Expired JWT token used or insufficient privilege */
3455
+ 401: {
3456
+ headers: {
3457
+ [name: string]: unknown;
3458
+ };
3459
+ content: {
3460
+ "text/plain": string;
3461
+ };
3462
+ };
3463
+ };
3464
+ };
3465
+ getConnectionById: {
3466
+ parameters: {
3467
+ query?: never;
3468
+ header?: never;
3469
+ path: {
3470
+ /** @description Connection ID */
3471
+ connectionId: string;
3472
+ };
3473
+ cookie?: never;
3474
+ };
3475
+ requestBody?: never;
3476
+ responses: {
3477
+ /** @description Connection details */
3478
+ 200: {
3479
+ headers: {
3480
+ [name: string]: unknown;
3481
+ };
3482
+ content: {
3483
+ "application/json": {
3477
3484
  /**
3478
- * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
3479
- * @enum {string}
3485
+ * Format: uuid
3486
+ * @description Connection ID
3480
3487
  */
3481
- shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
3482
- /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
3483
- position?: {
3484
- /** @description The x-coordinate of the node. */
3485
- x: number;
3486
- /** @description The y-coordinate of the node. */
3487
- y: number;
3488
- };
3489
- /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
3490
- bodyText?: string;
3488
+ id: string;
3489
+ /** @description Connection Name */
3490
+ name: string;
3491
+ /** @description Human-readable description of the connection and its purpose. */
3492
+ description?: string;
3491
3493
  /**
3492
- * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
3493
- * @enum {string}
3494
+ * Format: uri
3495
+ * @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
3494
3496
  */
3495
- bodyTextWrap?: "none" | "wrap" | "ellipsis";
3496
- /** @description The maximum width for wrapping text in the node. */
3497
- bodyTextMaxWidth?: string;
3498
- /** @description The opacity of the node's body text, including its outline. */
3499
- bodyTextOpacity?: number;
3500
- /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
3501
- bodyTextBackgroundColor?: string;
3502
- /** @description The size of the node's body text. */
3503
- bodyTextFontSize?: number;
3504
- /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
3505
- bodyTextColor?: string;
3506
- /** @description A CSS font weight to be applied to the node's body text. */
3507
- bodyTextFontWeight?: string;
3508
- /** @description A CSS horizontal alignment to be applied to the node's body text. */
3509
- bodyTextHorizontalAlign?: string;
3510
- /** @description A CSS text decoration to be applied to the node's body text. */
3511
- bodyTextDecoration?: string;
3512
- /** @description A CSS vertical alignment to be applied to the node's body text. */
3497
+ url?: string;
3498
+ /**
3499
+ * Format: uuid
3500
+ * @description Associated Credential ID
3501
+ */
3502
+ credentialId?: string;
3503
+ /** @description Connection Type (platform, telemetry, collaboration) */
3504
+ type: string;
3505
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
3506
+ subType: string;
3507
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
3508
+ kind: string;
3509
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
3510
+ modelReference?: {
3511
+ /**
3512
+ * Format: uuid
3513
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3514
+ */
3515
+ id: string;
3516
+ /**
3517
+ * @description The unique name for the model within the scope of a registrant.
3518
+ * @example cert-manager
3519
+ */
3520
+ name: string;
3521
+ /** @description Version of the model definition. */
3522
+ version: string;
3523
+ /**
3524
+ * @description Human-readable name for the model.
3525
+ * @example Cert Manager
3526
+ */
3527
+ displayName: string;
3528
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3529
+ model: {
3530
+ /** @description Version of the model as defined by the registrant. */
3531
+ version: string;
3532
+ };
3533
+ registrant: {
3534
+ /** @description Kind of the registrant. */
3535
+ kind: string;
3536
+ };
3537
+ };
3538
+ /** @description Additional connection metadata */
3539
+ metadata?: Record<string, never>;
3540
+ /** @description Schema for the credential Associated with the connection */
3541
+ credentialSchema?: Record<string, never>;
3542
+ /** @description Schema for the connection */
3543
+ connectionSchema?: Record<string, never>;
3544
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
3545
+ styles?: ({
3546
+ /** @description Primary color of the component used for UI representation. */
3547
+ primaryColor: string;
3548
+ /** @description Secondary color of the entity used for UI representation. */
3549
+ secondaryColor?: string;
3550
+ /** @description White SVG of the entity used for UI representation on dark background. */
3551
+ svgWhite: string;
3552
+ /** @description Colored SVG of the entity used for UI representation on light background. */
3553
+ svgColor: string;
3554
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
3555
+ svgComplete: string;
3556
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
3557
+ color?: string;
3558
+ /** @description The opacity of the label text, including its outline. */
3559
+ textOpacity?: number;
3560
+ /** @description A comma-separated list of font names to use on the label text. */
3561
+ fontFamily?: string;
3562
+ /** @description The size of the label text. */
3563
+ fontSize?: string;
3564
+ /** @description A CSS font style to be applied to the label text. */
3565
+ fontStyle?: string;
3566
+ /** @description A CSS font weight to be applied to the label text. */
3567
+ fontWeight?: string;
3568
+ /**
3569
+ * @description A transformation to apply to the label text
3570
+ * @enum {string}
3571
+ */
3572
+ textTransform?: "none" | "uppercase" | "lowercase";
3573
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
3574
+ opacity?: number;
3575
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
3576
+ zIndex?: number;
3577
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
3578
+ label?: string;
3579
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
3580
+ animation?: Record<string, never>;
3581
+ } & {
3582
+ [key: string]: unknown;
3583
+ }) & {
3584
+ /**
3585
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
3586
+ * @enum {string}
3587
+ */
3588
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
3589
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
3590
+ position?: {
3591
+ /** @description The x-coordinate of the node. */
3592
+ x: number;
3593
+ /** @description The y-coordinate of the node. */
3594
+ y: number;
3595
+ };
3596
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
3597
+ bodyText?: string;
3598
+ /**
3599
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
3600
+ * @enum {string}
3601
+ */
3602
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
3603
+ /** @description The maximum width for wrapping text in the node. */
3604
+ bodyTextMaxWidth?: string;
3605
+ /** @description The opacity of the node's body text, including its outline. */
3606
+ bodyTextOpacity?: number;
3607
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
3608
+ bodyTextBackgroundColor?: string;
3609
+ /** @description The size of the node's body text. */
3610
+ bodyTextFontSize?: number;
3611
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
3612
+ bodyTextColor?: string;
3613
+ /** @description A CSS font weight to be applied to the node's body text. */
3614
+ bodyTextFontWeight?: string;
3615
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
3616
+ bodyTextHorizontalAlign?: string;
3617
+ /** @description A CSS text decoration to be applied to the node's body text. */
3618
+ bodyTextDecoration?: string;
3619
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
3620
+ bodyTextVerticalAlign?: string;
3621
+ /** @description The width of the node's body or the width of an edge's line. */
3622
+ width?: number;
3623
+ /** @description The height of the node's body */
3624
+ height?: number;
3625
+ /**
3626
+ * Format: uri
3627
+ * @description The URL that points to the image to show in the node.
3628
+ */
3629
+ backgroundImage?: string;
3630
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
3631
+ backgroundColor?: string;
3632
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
3633
+ backgroundBlacken?: number;
3634
+ /** @description The opacity level of the node's background colour */
3635
+ backgroundOpacity?: number;
3636
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
3637
+ backgroundPositionX?: string;
3638
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
3639
+ backgroundPositionY?: string;
3640
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
3641
+ backgroundOffsetX?: string;
3642
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
3643
+ backgroundOffsetY?: string;
3644
+ /**
3645
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
3646
+ * @enum {string}
3647
+ */
3648
+ backgroundFit?: "none" | "contain" | "cover";
3649
+ /**
3650
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
3651
+ * @enum {string}
3652
+ */
3653
+ backgroundClip?: "none" | "node" | "node-border";
3654
+ /**
3655
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
3656
+ * @enum {string}
3657
+ */
3658
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
3659
+ /**
3660
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
3661
+ * @enum {string}
3662
+ */
3663
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
3664
+ /** @description The size of the node's border. */
3665
+ borderWidth?: number;
3666
+ /**
3667
+ * @description The style of the node's border
3668
+ * @enum {string}
3669
+ */
3670
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
3671
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
3672
+ borderColor?: string;
3673
+ /** @description The opacity of the node's border */
3674
+ borderOpacity?: number;
3675
+ /** @description The amount of padding around all sides of the node. */
3676
+ padding?: number;
3677
+ /**
3678
+ * @description The horizontal alignment of a node's label
3679
+ * @enum {string}
3680
+ */
3681
+ textHalign?: "left" | "center" | "right";
3682
+ /**
3683
+ * @description The vertical alignment of a node's label
3684
+ * @enum {string}
3685
+ */
3686
+ textValign?: "top" | "center" | "bottom";
3687
+ /**
3688
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
3689
+ * @default no
3690
+ * @enum {string}
3691
+ */
3692
+ ghost: "yes" | "no";
3693
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
3694
+ activeBgColor?: string;
3695
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
3696
+ activeBgOpacity?: string;
3697
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
3698
+ activeBgSize?: string;
3699
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
3700
+ selectionBoxColor?: string;
3701
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
3702
+ selectionBoxBorderWidth?: number;
3703
+ /** @description The opacity of the selection box. Selector needs to be *core* */
3704
+ selectionBoxOpacity?: number;
3705
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
3706
+ outsideTextureBgColor?: string;
3707
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
3708
+ outsideTextureBgOpacity?: number;
3709
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
3710
+ shapePolygonPoints?: string;
3711
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
3712
+ menuBackgroundColor?: string;
3713
+ /** @description The opacity of the background of the component menu. */
3714
+ menuBackgroundOpacity?: number;
3715
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
3716
+ menuForgroundColor?: string;
3717
+ };
3718
+ /**
3719
+ * @description Connection Status
3720
+ * @enum {string}
3721
+ */
3722
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
3723
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status, along with a description of each transition. */
3724
+ transitionMap?: {
3725
+ [key: string]: {
3726
+ /**
3727
+ * @description Connection Status Value
3728
+ * @enum {string}
3729
+ */
3730
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
3731
+ /** @description Human-readable explanation of when or why this transition occurs. */
3732
+ description?: string;
3733
+ }[];
3734
+ };
3735
+ /**
3736
+ * Format: uuid
3737
+ * @description User ID who owns this connection
3738
+ */
3739
+ owner?: string;
3740
+ /**
3741
+ * Format: date-time
3742
+ * @description Timestamp when the connection was created.
3743
+ */
3744
+ createdAt?: string;
3745
+ /**
3746
+ * Format: date-time
3747
+ * @description Timestamp when the connection was last updated.
3748
+ */
3749
+ updatedAt?: string;
3750
+ /**
3751
+ * Format: date-time
3752
+ * @description Timestamp when the connection was soft-deleted, if applicable.
3753
+ */
3754
+ deletedAt?: string | null;
3755
+ /**
3756
+ * Format: uuid
3757
+ * @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.
3758
+ */
3759
+ organizationId?: string;
3760
+ /** @description Associated environments for this connection */
3761
+ environments?: {
3762
+ /**
3763
+ * Format: uuid
3764
+ * @description ID
3765
+ */
3766
+ id: string;
3767
+ /**
3768
+ * @description Specifies the version of the schema to which the environment conforms.
3769
+ * @default environments.meshery.io/v1beta3
3770
+ * @example [
3771
+ * "v1",
3772
+ * "v1alpha1",
3773
+ * "v2beta3",
3774
+ * "v1.custom-suffix",
3775
+ * "models.meshery.io/v1beta1",
3776
+ * "capability.meshery.io/v1alpha1"
3777
+ * ]
3778
+ */
3779
+ schemaVersion: string;
3780
+ /** @description Environment name */
3781
+ name: string;
3782
+ /** @description Environment description */
3783
+ description: string;
3784
+ /**
3785
+ * Format: uuid
3786
+ * @description Environment organization ID
3787
+ */
3788
+ organizationId: string;
3789
+ /**
3790
+ * Format: uuid
3791
+ * @description Environment owner
3792
+ */
3793
+ owner?: string;
3794
+ /**
3795
+ * Format: date-time
3796
+ * @description Timestamp when the environment was created.
3797
+ */
3798
+ createdAt?: string;
3799
+ /** @description Additional metadata associated with the environment. */
3800
+ metadata?: Record<string, never>;
3801
+ /**
3802
+ * Format: date-time
3803
+ * @description Timestamp when the environment was last updated.
3804
+ */
3805
+ updatedAt?: string;
3806
+ /**
3807
+ * Format: date-time
3808
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
3809
+ */
3810
+ deletedAt?: string | null;
3811
+ /**
3812
+ * @description What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. `profile` is an ordinary, non-privileged environment that holds one profile, by convention one per profile: `name` is the profile's short name, `owner` is the profile's user, `metadata` holds the profile's settings, and the profile's accounts are linked as Connections. Like `user`, it carries no authority and a client may choose it.
3813
+ *
3814
+ * Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
3815
+ *
3816
+ * At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
3817
+ *
3818
+ * Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged values (`user` and `profile`), and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
3819
+ *
3820
+ * The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md.
3821
+ * @enum {string}
3822
+ */
3823
+ purpose?: "user" | "administrative" | "profile";
3824
+ }[];
3825
+ /**
3826
+ * @description Specifies the version of the schema used for the definition.
3827
+ * @default connections.meshery.io/v1beta3
3828
+ * @example [
3829
+ * "v1",
3830
+ * "v1alpha1",
3831
+ * "v2beta3",
3832
+ * "v1.custom-suffix",
3833
+ * "models.meshery.io/v1beta1",
3834
+ * "capability.meshery.io/v1alpha1"
3835
+ * ]
3836
+ */
3837
+ schemaVersion: string;
3838
+ };
3839
+ };
3840
+ };
3841
+ /** @description Expired JWT token used or insufficient privilege */
3842
+ 401: {
3843
+ headers: {
3844
+ [name: string]: unknown;
3845
+ };
3846
+ content: {
3847
+ "text/plain": string;
3848
+ };
3849
+ };
3850
+ /** @description Result not found */
3851
+ 404: {
3852
+ headers: {
3853
+ [name: string]: unknown;
3854
+ };
3855
+ content: {
3856
+ "text/plain": string;
3857
+ };
3858
+ };
3859
+ /** @description Internal server error */
3860
+ 500: {
3861
+ headers: {
3862
+ [name: string]: unknown;
3863
+ };
3864
+ content: {
3865
+ "text/plain": string;
3866
+ };
3867
+ };
3868
+ };
3869
+ };
3870
+ updateConnection: {
3871
+ parameters: {
3872
+ query?: never;
3873
+ header?: never;
3874
+ path: {
3875
+ /** @description Connection ID */
3876
+ connectionId: string;
3877
+ };
3878
+ cookie?: never;
3879
+ };
3880
+ requestBody: {
3881
+ content: {
3882
+ "application/json": {
3883
+ /**
3884
+ * Format: uuid
3885
+ * @description Connection ID
3886
+ */
3887
+ id?: string;
3888
+ /** @description Connection name */
3889
+ name: string;
3890
+ /** @description Connection kind */
3891
+ kind: string;
3892
+ /** @description Connection type */
3893
+ type: string;
3894
+ /** @description Connection sub-type */
3895
+ subType: string;
3896
+ /** @description Credential secret data */
3897
+ credentialSecret?: Record<string, never>;
3898
+ /** @description Connection metadata */
3899
+ metadata?: Record<string, never>;
3900
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
3901
+ styles?: ({
3902
+ /** @description Primary color of the component used for UI representation. */
3903
+ primaryColor: string;
3904
+ /** @description Secondary color of the entity used for UI representation. */
3905
+ secondaryColor?: string;
3906
+ /** @description White SVG of the entity used for UI representation on dark background. */
3907
+ svgWhite: string;
3908
+ /** @description Colored SVG of the entity used for UI representation on light background. */
3909
+ svgColor: string;
3910
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
3911
+ svgComplete: string;
3912
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
3913
+ color?: string;
3914
+ /** @description The opacity of the label text, including its outline. */
3915
+ textOpacity?: number;
3916
+ /** @description A comma-separated list of font names to use on the label text. */
3917
+ fontFamily?: string;
3918
+ /** @description The size of the label text. */
3919
+ fontSize?: string;
3920
+ /** @description A CSS font style to be applied to the label text. */
3921
+ fontStyle?: string;
3922
+ /** @description A CSS font weight to be applied to the label text. */
3923
+ fontWeight?: string;
3924
+ /**
3925
+ * @description A transformation to apply to the label text
3926
+ * @enum {string}
3927
+ */
3928
+ textTransform?: "none" | "uppercase" | "lowercase";
3929
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
3930
+ opacity?: number;
3931
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
3932
+ zIndex?: number;
3933
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
3934
+ label?: string;
3935
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
3936
+ animation?: Record<string, never>;
3937
+ } & {
3938
+ [key: string]: unknown;
3939
+ }) & {
3940
+ /**
3941
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
3942
+ * @enum {string}
3943
+ */
3944
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
3945
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
3946
+ position?: {
3947
+ /** @description The x-coordinate of the node. */
3948
+ x: number;
3949
+ /** @description The y-coordinate of the node. */
3950
+ y: number;
3951
+ };
3952
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
3953
+ bodyText?: string;
3954
+ /**
3955
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
3956
+ * @enum {string}
3957
+ */
3958
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
3959
+ /** @description The maximum width for wrapping text in the node. */
3960
+ bodyTextMaxWidth?: string;
3961
+ /** @description The opacity of the node's body text, including its outline. */
3962
+ bodyTextOpacity?: number;
3963
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
3964
+ bodyTextBackgroundColor?: string;
3965
+ /** @description The size of the node's body text. */
3966
+ bodyTextFontSize?: number;
3967
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
3968
+ bodyTextColor?: string;
3969
+ /** @description A CSS font weight to be applied to the node's body text. */
3970
+ bodyTextFontWeight?: string;
3971
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
3972
+ bodyTextHorizontalAlign?: string;
3973
+ /** @description A CSS text decoration to be applied to the node's body text. */
3974
+ bodyTextDecoration?: string;
3975
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
3513
3976
  bodyTextVerticalAlign?: string;
3514
3977
  /** @description The width of the node's body or the width of an edge's line. */
3515
3978
  width?: number;
@@ -3540,86 +4003,586 @@ export interface operations {
3540
4003
  */
3541
4004
  backgroundFit?: "none" | "contain" | "cover";
3542
4005
  /**
3543
- * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
4006
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
4007
+ * @enum {string}
4008
+ */
4009
+ backgroundClip?: "none" | "node" | "node-border";
4010
+ /**
4011
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
4012
+ * @enum {string}
4013
+ */
4014
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
4015
+ /**
4016
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
4017
+ * @enum {string}
4018
+ */
4019
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
4020
+ /** @description The size of the node's border. */
4021
+ borderWidth?: number;
4022
+ /**
4023
+ * @description The style of the node's border
4024
+ * @enum {string}
4025
+ */
4026
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
4027
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
4028
+ borderColor?: string;
4029
+ /** @description The opacity of the node's border */
4030
+ borderOpacity?: number;
4031
+ /** @description The amount of padding around all sides of the node. */
4032
+ padding?: number;
4033
+ /**
4034
+ * @description The horizontal alignment of a node's label
4035
+ * @enum {string}
4036
+ */
4037
+ textHalign?: "left" | "center" | "right";
4038
+ /**
4039
+ * @description The vertical alignment of a node's label
4040
+ * @enum {string}
4041
+ */
4042
+ textValign?: "top" | "center" | "bottom";
4043
+ /**
4044
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
4045
+ * @default no
4046
+ * @enum {string}
4047
+ */
4048
+ ghost?: "yes" | "no";
4049
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4050
+ activeBgColor?: string;
4051
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4052
+ activeBgOpacity?: string;
4053
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4054
+ activeBgSize?: string;
4055
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4056
+ selectionBoxColor?: string;
4057
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
4058
+ selectionBoxBorderWidth?: number;
4059
+ /** @description The opacity of the selection box. Selector needs to be *core* */
4060
+ selectionBoxOpacity?: number;
4061
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4062
+ outsideTextureBgColor?: string;
4063
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
4064
+ outsideTextureBgOpacity?: number;
4065
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
4066
+ shapePolygonPoints?: string;
4067
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4068
+ menuBackgroundColor?: string;
4069
+ /** @description The opacity of the background of the component menu. */
4070
+ menuBackgroundOpacity?: number;
4071
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4072
+ menuForgroundColor?: string;
4073
+ };
4074
+ /** @description Connection status */
4075
+ status: string;
4076
+ /**
4077
+ * Format: uuid
4078
+ * @description Associated credential ID
4079
+ */
4080
+ credentialId?: string;
4081
+ };
4082
+ };
4083
+ };
4084
+ responses: {
4085
+ /** @description Connection updated */
4086
+ 200: {
4087
+ headers: {
4088
+ [name: string]: unknown;
4089
+ };
4090
+ content: {
4091
+ "application/json": {
4092
+ /**
4093
+ * Format: uuid
4094
+ * @description Connection ID
4095
+ */
4096
+ id: string;
4097
+ /** @description Connection Name */
4098
+ name: string;
4099
+ /** @description Human-readable description of the connection and its purpose. */
4100
+ description?: string;
4101
+ /**
4102
+ * Format: uri
4103
+ * @description URL of the remote resource this connection points to (e.g. the Helm repository URL, the Kubernetes API server endpoint, the Grafana instance URL).
4104
+ */
4105
+ url?: string;
4106
+ /**
4107
+ * Format: uuid
4108
+ * @description Associated Credential ID
4109
+ */
4110
+ credentialId?: string;
4111
+ /** @description Connection Type (platform, telemetry, collaboration) */
4112
+ type: string;
4113
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
4114
+ subType: string;
4115
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
4116
+ kind: string;
4117
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
4118
+ modelReference?: {
4119
+ /**
4120
+ * Format: uuid
4121
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
4122
+ */
4123
+ id: string;
4124
+ /**
4125
+ * @description The unique name for the model within the scope of a registrant.
4126
+ * @example cert-manager
4127
+ */
4128
+ name: string;
4129
+ /** @description Version of the model definition. */
4130
+ version: string;
4131
+ /**
4132
+ * @description Human-readable name for the model.
4133
+ * @example Cert Manager
4134
+ */
4135
+ displayName: string;
4136
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
4137
+ model: {
4138
+ /** @description Version of the model as defined by the registrant. */
4139
+ version: string;
4140
+ };
4141
+ registrant: {
4142
+ /** @description Kind of the registrant. */
4143
+ kind: string;
4144
+ };
4145
+ };
4146
+ /** @description Additional connection metadata */
4147
+ metadata?: Record<string, never>;
4148
+ /** @description Schema for the credential Associated with the connection */
4149
+ credentialSchema?: Record<string, never>;
4150
+ /** @description Schema for the connection */
4151
+ connectionSchema?: Record<string, never>;
4152
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
4153
+ styles?: ({
4154
+ /** @description Primary color of the component used for UI representation. */
4155
+ primaryColor: string;
4156
+ /** @description Secondary color of the entity used for UI representation. */
4157
+ secondaryColor?: string;
4158
+ /** @description White SVG of the entity used for UI representation on dark background. */
4159
+ svgWhite: string;
4160
+ /** @description Colored SVG of the entity used for UI representation on light background. */
4161
+ svgColor: string;
4162
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
4163
+ svgComplete: string;
4164
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
4165
+ color?: string;
4166
+ /** @description The opacity of the label text, including its outline. */
4167
+ textOpacity?: number;
4168
+ /** @description A comma-separated list of font names to use on the label text. */
4169
+ fontFamily?: string;
4170
+ /** @description The size of the label text. */
4171
+ fontSize?: string;
4172
+ /** @description A CSS font style to be applied to the label text. */
4173
+ fontStyle?: string;
4174
+ /** @description A CSS font weight to be applied to the label text. */
4175
+ fontWeight?: string;
4176
+ /**
4177
+ * @description A transformation to apply to the label text
4178
+ * @enum {string}
4179
+ */
4180
+ textTransform?: "none" | "uppercase" | "lowercase";
4181
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
4182
+ opacity?: number;
4183
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
4184
+ zIndex?: number;
4185
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
4186
+ label?: string;
4187
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
4188
+ animation?: Record<string, never>;
4189
+ } & {
4190
+ [key: string]: unknown;
4191
+ }) & {
4192
+ /**
4193
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
4194
+ * @enum {string}
4195
+ */
4196
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
4197
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
4198
+ position?: {
4199
+ /** @description The x-coordinate of the node. */
4200
+ x: number;
4201
+ /** @description The y-coordinate of the node. */
4202
+ y: number;
4203
+ };
4204
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
4205
+ bodyText?: string;
4206
+ /**
4207
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
4208
+ * @enum {string}
4209
+ */
4210
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
4211
+ /** @description The maximum width for wrapping text in the node. */
4212
+ bodyTextMaxWidth?: string;
4213
+ /** @description The opacity of the node's body text, including its outline. */
4214
+ bodyTextOpacity?: number;
4215
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
4216
+ bodyTextBackgroundColor?: string;
4217
+ /** @description The size of the node's body text. */
4218
+ bodyTextFontSize?: number;
4219
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
4220
+ bodyTextColor?: string;
4221
+ /** @description A CSS font weight to be applied to the node's body text. */
4222
+ bodyTextFontWeight?: string;
4223
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
4224
+ bodyTextHorizontalAlign?: string;
4225
+ /** @description A CSS text decoration to be applied to the node's body text. */
4226
+ bodyTextDecoration?: string;
4227
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
4228
+ bodyTextVerticalAlign?: string;
4229
+ /** @description The width of the node's body or the width of an edge's line. */
4230
+ width?: number;
4231
+ /** @description The height of the node's body */
4232
+ height?: number;
4233
+ /**
4234
+ * Format: uri
4235
+ * @description The URL that points to the image to show in the node.
4236
+ */
4237
+ backgroundImage?: string;
4238
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
4239
+ backgroundColor?: string;
4240
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
4241
+ backgroundBlacken?: number;
4242
+ /** @description The opacity level of the node's background colour */
4243
+ backgroundOpacity?: number;
4244
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4245
+ backgroundPositionX?: string;
4246
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4247
+ backgroundPositionY?: string;
4248
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4249
+ backgroundOffsetX?: string;
4250
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4251
+ backgroundOffsetY?: string;
4252
+ /**
4253
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
4254
+ * @enum {string}
4255
+ */
4256
+ backgroundFit?: "none" | "contain" | "cover";
4257
+ /**
4258
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
4259
+ * @enum {string}
4260
+ */
4261
+ backgroundClip?: "none" | "node" | "node-border";
4262
+ /**
4263
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
4264
+ * @enum {string}
4265
+ */
4266
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
4267
+ /**
4268
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
4269
+ * @enum {string}
4270
+ */
4271
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
4272
+ /** @description The size of the node's border. */
4273
+ borderWidth?: number;
4274
+ /**
4275
+ * @description The style of the node's border
4276
+ * @enum {string}
4277
+ */
4278
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
4279
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
4280
+ borderColor?: string;
4281
+ /** @description The opacity of the node's border */
4282
+ borderOpacity?: number;
4283
+ /** @description The amount of padding around all sides of the node. */
4284
+ padding?: number;
4285
+ /**
4286
+ * @description The horizontal alignment of a node's label
4287
+ * @enum {string}
4288
+ */
4289
+ textHalign?: "left" | "center" | "right";
4290
+ /**
4291
+ * @description The vertical alignment of a node's label
4292
+ * @enum {string}
4293
+ */
4294
+ textValign?: "top" | "center" | "bottom";
4295
+ /**
4296
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
4297
+ * @default no
4298
+ * @enum {string}
4299
+ */
4300
+ ghost: "yes" | "no";
4301
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4302
+ activeBgColor?: string;
4303
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4304
+ activeBgOpacity?: string;
4305
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4306
+ activeBgSize?: string;
4307
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4308
+ selectionBoxColor?: string;
4309
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
4310
+ selectionBoxBorderWidth?: number;
4311
+ /** @description The opacity of the selection box. Selector needs to be *core* */
4312
+ selectionBoxOpacity?: number;
4313
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4314
+ outsideTextureBgColor?: string;
4315
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
4316
+ outsideTextureBgOpacity?: number;
4317
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
4318
+ shapePolygonPoints?: string;
4319
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4320
+ menuBackgroundColor?: string;
4321
+ /** @description The opacity of the background of the component menu. */
4322
+ menuBackgroundOpacity?: number;
4323
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4324
+ menuForgroundColor?: string;
4325
+ };
4326
+ /**
4327
+ * @description Connection Status
3544
4328
  * @enum {string}
3545
4329
  */
3546
- backgroundClip?: "none" | "node" | "node-border";
4330
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4331
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status, along with a description of each transition. */
4332
+ transitionMap?: {
4333
+ [key: string]: {
4334
+ /**
4335
+ * @description Connection Status Value
4336
+ * @enum {string}
4337
+ */
4338
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4339
+ /** @description Human-readable explanation of when or why this transition occurs. */
4340
+ description?: string;
4341
+ }[];
4342
+ };
3547
4343
  /**
3548
- * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
3549
- * @enum {string}
4344
+ * Format: uuid
4345
+ * @description User ID who owns this connection
3550
4346
  */
3551
- backgroundWidthRelativeTo?: "none" | "inner" | "outer";
4347
+ owner?: string;
3552
4348
  /**
3553
- * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
3554
- * @enum {string}
4349
+ * Format: date-time
4350
+ * @description Timestamp when the connection was created.
3555
4351
  */
3556
- backgroundHeightRelativeTo?: "none" | "inner" | "outer";
3557
- /** @description The size of the node's border. */
3558
- borderWidth?: number;
4352
+ createdAt?: string;
3559
4353
  /**
3560
- * @description The style of the node's border
3561
- * @enum {string}
4354
+ * Format: date-time
4355
+ * @description Timestamp when the connection was last updated.
3562
4356
  */
3563
- borderStyle?: "solid" | "dotted" | "dashed" | "double";
3564
- /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
3565
- borderColor?: string;
3566
- /** @description The opacity of the node's border */
3567
- borderOpacity?: number;
3568
- /** @description The amount of padding around all sides of the node. */
3569
- padding?: number;
4357
+ updatedAt?: string;
3570
4358
  /**
3571
- * @description The horizontal alignment of a node's label
3572
- * @enum {string}
4359
+ * Format: date-time
4360
+ * @description Timestamp when the connection was soft-deleted, if applicable.
3573
4361
  */
3574
- textHalign?: "left" | "center" | "right";
4362
+ deletedAt?: string | null;
3575
4363
  /**
3576
- * @description The vertical alignment of a node's label
3577
- * @enum {string}
4364
+ * Format: uuid
4365
+ * @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.
3578
4366
  */
3579
- textValign?: "top" | "center" | "bottom";
4367
+ organizationId?: string;
4368
+ /** @description Associated environments for this connection */
4369
+ environments?: {
4370
+ /**
4371
+ * Format: uuid
4372
+ * @description ID
4373
+ */
4374
+ id: string;
4375
+ /**
4376
+ * @description Specifies the version of the schema to which the environment conforms.
4377
+ * @default environments.meshery.io/v1beta3
4378
+ * @example [
4379
+ * "v1",
4380
+ * "v1alpha1",
4381
+ * "v2beta3",
4382
+ * "v1.custom-suffix",
4383
+ * "models.meshery.io/v1beta1",
4384
+ * "capability.meshery.io/v1alpha1"
4385
+ * ]
4386
+ */
4387
+ schemaVersion: string;
4388
+ /** @description Environment name */
4389
+ name: string;
4390
+ /** @description Environment description */
4391
+ description: string;
4392
+ /**
4393
+ * Format: uuid
4394
+ * @description Environment organization ID
4395
+ */
4396
+ organizationId: string;
4397
+ /**
4398
+ * Format: uuid
4399
+ * @description Environment owner
4400
+ */
4401
+ owner?: string;
4402
+ /**
4403
+ * Format: date-time
4404
+ * @description Timestamp when the environment was created.
4405
+ */
4406
+ createdAt?: string;
4407
+ /** @description Additional metadata associated with the environment. */
4408
+ metadata?: Record<string, never>;
4409
+ /**
4410
+ * Format: date-time
4411
+ * @description Timestamp when the environment was last updated.
4412
+ */
4413
+ updatedAt?: string;
4414
+ /**
4415
+ * Format: date-time
4416
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
4417
+ */
4418
+ deletedAt?: string | null;
4419
+ /**
4420
+ * @description What the environment exists for. `user` is an ordinary environment that people create to logically group Connections and their Credentials. `administrative` designates an environment the platform itself provisions to hold organization-level configuration, and which resolvers of that configuration therefore trust. `profile` is an ordinary, non-privileged environment that holds one profile, by convention one per profile: `name` is the profile's short name, `owner` is the profile's user, `metadata` holds the profile's settings, and the profile's accounts are linked as Connections. Like `user`, it carries no authority and a client may choose it.
4421
+ *
4422
+ * Absent means `user`. Nothing may read an unset or unrecognised value as administrative: test for the administrative value explicitly rather than for "not user", so the property fails closed.
4423
+ *
4424
+ * At most one live environment per organization may carry any single privileged purpose - `administrative`, and each privileged value a later version adds. Name those values explicitly wherever the rule is enforced, including the database index predicate: a "not `user`" test also matches the empty value that unmigrated rows and un-normalised writes read back as, which means ordinary. A resolver that selects an environment by purpose MUST fail closed when more than one live row matches: return an error rather than whichever row the database happened to return first.
4425
+ *
4426
+ * Privileged values are server-owned and never client-settable. `EnvironmentPayload`, which every environment POST and PUT requestBody references, accepts only the non-privileged values (`user` and `profile`), and the create-or-edit form has no field for it, so the environment create and update endpoints cannot designate an environment administrative. That restriction is a codegen guarantee, never access control: the registrant connection inlines the full environment entity, so `registerRegistryComponent` and `registerRegistryRelationship` do carry `purpose` in a request type and consumers MUST refuse it on input there too. Whatever surface a value arrives on, every consumer MUST assign this property only from server-side provisioning or a data migration. Permission to create an environment does not confer the ability to make one administrative.
4427
+ *
4428
+ * The database index that enforces the uniqueness invariant, the migration path for environments that are administrative by naming convention today, and each consumer's obligations are specified in https://github.com/meshery/schemas/blob/master/docs/environment-purpose-contract.md.
4429
+ * @enum {string}
4430
+ */
4431
+ purpose?: "user" | "administrative" | "profile";
4432
+ }[];
3580
4433
  /**
3581
- * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
3582
- * @default no
3583
- * @enum {string}
4434
+ * @description Specifies the version of the schema used for the definition.
4435
+ * @default connections.meshery.io/v1beta3
4436
+ * @example [
4437
+ * "v1",
4438
+ * "v1alpha1",
4439
+ * "v2beta3",
4440
+ * "v1.custom-suffix",
4441
+ * "models.meshery.io/v1beta1",
4442
+ * "capability.meshery.io/v1alpha1"
4443
+ * ]
3584
4444
  */
3585
- ghost?: "yes" | "no";
3586
- /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
3587
- activeBgColor?: string;
3588
- /** @description The opacity of the active background indicator. Selector needs to be *core*. */
3589
- activeBgOpacity?: string;
3590
- /** @description The opacity of the active background indicator. Selector needs to be *core*. */
3591
- activeBgSize?: string;
3592
- /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
3593
- selectionBoxColor?: string;
3594
- /** @description The size of the border on the selection box. Selector needs to be *core* */
3595
- selectionBoxBorderWidth?: number;
3596
- /** @description The opacity of the selection box. Selector needs to be *core* */
3597
- selectionBoxOpacity?: number;
3598
- /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
3599
- outsideTextureBgColor?: string;
3600
- /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
3601
- outsideTextureBgOpacity?: number;
3602
- /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
3603
- shapePolygonPoints?: string;
3604
- /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
3605
- menuBackgroundColor?: string;
3606
- /** @description The opacity of the background of the component menu. */
3607
- menuBackgroundOpacity?: number;
3608
- /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
3609
- menuForgroundColor?: string;
4445
+ schemaVersion: string;
4446
+ };
4447
+ };
4448
+ };
4449
+ /** @description Invalid request body or request param */
4450
+ 400: {
4451
+ headers: {
4452
+ [name: string]: unknown;
4453
+ };
4454
+ content: {
4455
+ "text/plain": string;
4456
+ };
4457
+ };
4458
+ /** @description Expired JWT token used or insufficient privilege */
4459
+ 401: {
4460
+ headers: {
4461
+ [name: string]: unknown;
4462
+ };
4463
+ content: {
4464
+ "text/plain": string;
4465
+ };
4466
+ };
4467
+ /** @description Result not found */
4468
+ 404: {
4469
+ headers: {
4470
+ [name: string]: unknown;
4471
+ };
4472
+ content: {
4473
+ "text/plain": string;
4474
+ };
4475
+ };
4476
+ /** @description Conflict */
4477
+ 409: {
4478
+ headers: {
4479
+ [name: string]: unknown;
4480
+ };
4481
+ content: {
4482
+ "application/json": {
4483
+ /** @description The sentence the caller is shown. */
4484
+ error: string;
4485
+ /** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
4486
+ code?: string;
4487
+ /**
4488
+ * @description MeshKit severity name. Omitted when MeshKit reports none.
4489
+ * @enum {string}
4490
+ */
4491
+ severity?: "emergency" | "alert" | "critical" | "fatal";
4492
+ /** @description MeshKit's probable causes of the error. */
4493
+ probableCause?: string[];
4494
+ /** @description MeshKit's suggested remediations for the error. */
4495
+ suggestedRemediation?: string[];
3610
4496
  };
3611
- /** @description Connection status */
3612
- status: string;
4497
+ };
4498
+ };
4499
+ /** @description Internal server error */
4500
+ 500: {
4501
+ headers: {
4502
+ [name: string]: unknown;
4503
+ };
4504
+ content: {
4505
+ "text/plain": string;
4506
+ };
4507
+ };
4508
+ };
4509
+ };
4510
+ deleteConnection: {
4511
+ parameters: {
4512
+ query?: never;
4513
+ header?: never;
4514
+ path: {
4515
+ /** @description Connection ID */
4516
+ connectionId: string;
4517
+ };
4518
+ cookie?: never;
4519
+ };
4520
+ requestBody?: never;
4521
+ responses: {
4522
+ /** @description Connection deleted */
4523
+ 204: {
4524
+ headers: {
4525
+ [name: string]: unknown;
4526
+ };
4527
+ content?: never;
4528
+ };
4529
+ /** @description Expired JWT token used or insufficient privilege */
4530
+ 401: {
4531
+ headers: {
4532
+ [name: string]: unknown;
4533
+ };
4534
+ content: {
4535
+ "text/plain": string;
4536
+ };
4537
+ };
4538
+ /** @description Result not found */
4539
+ 404: {
4540
+ headers: {
4541
+ [name: string]: unknown;
4542
+ };
4543
+ content: {
4544
+ "text/plain": string;
4545
+ };
4546
+ };
4547
+ /** @description Internal server error */
4548
+ 500: {
4549
+ headers: {
4550
+ [name: string]: unknown;
4551
+ };
4552
+ content: {
4553
+ "text/plain": string;
4554
+ };
4555
+ };
4556
+ };
4557
+ };
4558
+ performConnectionAction: {
4559
+ parameters: {
4560
+ query?: never;
4561
+ header?: never;
4562
+ path: {
4563
+ /** @description Connection ID */
4564
+ connectionId: string;
4565
+ };
4566
+ cookie?: never;
4567
+ };
4568
+ requestBody: {
4569
+ content: {
4570
+ "application/json": {
3613
4571
  /**
3614
- * Format: uuid
3615
- * @description Associated credential ID
4572
+ * @description The operation to perform on the connection.
4573
+ * @enum {string}
3616
4574
  */
3617
- credentialId?: string;
4575
+ action: "setMeshsyncMode";
4576
+ /**
4577
+ * @description Target MeshSync deployment mode. Required when `action` is `setMeshsyncMode`; the server redeploys MeshSync (operator vs embedded) for the connection's cluster.
4578
+ * @enum {string}
4579
+ */
4580
+ mode?: "operator" | "embedded";
3618
4581
  };
3619
4582
  };
3620
4583
  };
3621
4584
  responses: {
3622
- /** @description Connection updated */
4585
+ /** @description The updated connection after the action was applied. */
3623
4586
  200: {
3624
4587
  headers: {
3625
4588
  [name: string]: unknown;
@@ -3649,7 +4612,7 @@ export interface operations {
3649
4612
  type: string;
3650
4613
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
3651
4614
  subType: string;
3652
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
4615
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
3653
4616
  kind: string;
3654
4617
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
3655
4618
  modelReference?: {
@@ -3897,6 +4860,11 @@ export interface operations {
3897
4860
  * @description Timestamp when the connection was soft-deleted, if applicable.
3898
4861
  */
3899
4862
  deletedAt?: string | null;
4863
+ /**
4864
+ * Format: uuid
4865
+ * @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.
4866
+ */
4867
+ organizationId?: string;
3900
4868
  /** @description Associated environments for this connection */
3901
4869
  environments?: {
3902
4870
  /**
@@ -4005,27 +4973,52 @@ export interface operations {
4005
4973
  "text/plain": string;
4006
4974
  };
4007
4975
  };
4008
- /** @description Conflict */
4009
- 409: {
4976
+ /** @description Internal server error */
4977
+ 500: {
4010
4978
  headers: {
4011
4979
  [name: string]: unknown;
4012
4980
  };
4013
4981
  content: {
4014
- "application/json": {
4015
- /** @description The sentence the caller is shown. */
4016
- error: string;
4017
- /** @description MeshKit error code, a component-scoped identifier allocated by the emitting service (e.g. `<component>-<number>`); it is not a stable part of this contract. Omitted for an error that is not a MeshKit error. */
4018
- code?: string;
4019
- /**
4020
- * @description MeshKit severity name. Omitted when MeshKit reports none.
4021
- * @enum {string}
4022
- */
4023
- severity?: "emergency" | "alert" | "critical" | "fatal";
4024
- /** @description MeshKit's probable causes of the error. */
4025
- probableCause?: string[];
4026
- /** @description MeshKit's suggested remediations for the error. */
4027
- suggestedRemediation?: string[];
4028
- };
4982
+ "text/plain": string;
4983
+ };
4984
+ };
4985
+ };
4986
+ };
4987
+ deleteMesheryConnection: {
4988
+ parameters: {
4989
+ query?: never;
4990
+ header?: never;
4991
+ path: {
4992
+ /** @description Meshery server ID */
4993
+ mesheryServerId: string;
4994
+ };
4995
+ cookie?: never;
4996
+ };
4997
+ requestBody?: never;
4998
+ responses: {
4999
+ /** @description Meshery connection deleted */
5000
+ 204: {
5001
+ headers: {
5002
+ [name: string]: unknown;
5003
+ };
5004
+ content?: never;
5005
+ };
5006
+ /** @description Expired JWT token used or insufficient privilege */
5007
+ 401: {
5008
+ headers: {
5009
+ [name: string]: unknown;
5010
+ };
5011
+ content: {
5012
+ "text/plain": string;
5013
+ };
5014
+ };
5015
+ /** @description Result not found */
5016
+ 404: {
5017
+ headers: {
5018
+ [name: string]: unknown;
5019
+ };
5020
+ content: {
5021
+ "text/plain": string;
4029
5022
  };
4030
5023
  };
4031
5024
  /** @description Internal server error */
@@ -4039,19 +5032,19 @@ export interface operations {
4039
5032
  };
4040
5033
  };
4041
5034
  };
4042
- deleteConnection: {
5035
+ deregisterDesktopConnection: {
4043
5036
  parameters: {
4044
5037
  query?: never;
4045
5038
  header?: never;
4046
5039
  path: {
4047
- /** @description Connection ID */
4048
- connectionId: string;
5040
+ /** @description Stable per-install machine identifier from `metadata.machineId`. */
5041
+ machineId: string;
4049
5042
  };
4050
5043
  cookie?: never;
4051
5044
  };
4052
5045
  requestBody?: never;
4053
5046
  responses: {
4054
- /** @description Connection deleted */
5047
+ /** @description Desktop connection deleted */
4055
5048
  204: {
4056
5049
  headers: {
4057
5050
  [name: string]: unknown;
@@ -4087,7 +5080,7 @@ export interface operations {
4087
5080
  };
4088
5081
  };
4089
5082
  };
4090
- performConnectionAction: {
5083
+ recordConnectionHeartbeat: {
4091
5084
  parameters: {
4092
5085
  query?: never;
4093
5086
  header?: never;
@@ -4097,24 +5090,9 @@ export interface operations {
4097
5090
  };
4098
5091
  cookie?: never;
4099
5092
  };
4100
- requestBody: {
4101
- content: {
4102
- "application/json": {
4103
- /**
4104
- * @description The operation to perform on the connection.
4105
- * @enum {string}
4106
- */
4107
- action: "setMeshsyncMode";
4108
- /**
4109
- * @description Target MeshSync deployment mode. Required when `action` is `setMeshsyncMode`; the server redeploys MeshSync (operator vs embedded) for the connection's cluster.
4110
- * @enum {string}
4111
- */
4112
- mode?: "operator" | "embedded";
4113
- };
4114
- };
4115
- };
5093
+ requestBody?: never;
4116
5094
  responses: {
4117
- /** @description The updated connection after the action was applied. */
5095
+ /** @description Connection after the heartbeat */
4118
5096
  200: {
4119
5097
  headers: {
4120
5098
  [name: string]: unknown;
@@ -4144,7 +5122,7 @@ export interface operations {
4144
5122
  type: string;
4145
5123
  /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
4146
5124
  subType: string;
4147
- /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
5125
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
4148
5126
  kind: string;
4149
5127
  /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
4150
5128
  modelReference?: {
@@ -4392,6 +5370,11 @@ export interface operations {
4392
5370
  * @description Timestamp when the connection was soft-deleted, if applicable.
4393
5371
  */
4394
5372
  deletedAt?: string | null;
5373
+ /**
5374
+ * Format: uuid
5375
+ * @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.
5376
+ */
5377
+ organizationId?: string;
4395
5378
  /** @description Associated environments for this connection */
4396
5379
  environments?: {
4397
5380
  /**
@@ -4473,63 +5456,6 @@ export interface operations {
4473
5456
  };
4474
5457
  };
4475
5458
  };
4476
- /** @description Invalid request body or request param */
4477
- 400: {
4478
- headers: {
4479
- [name: string]: unknown;
4480
- };
4481
- content: {
4482
- "text/plain": string;
4483
- };
4484
- };
4485
- /** @description Expired JWT token used or insufficient privilege */
4486
- 401: {
4487
- headers: {
4488
- [name: string]: unknown;
4489
- };
4490
- content: {
4491
- "text/plain": string;
4492
- };
4493
- };
4494
- /** @description Result not found */
4495
- 404: {
4496
- headers: {
4497
- [name: string]: unknown;
4498
- };
4499
- content: {
4500
- "text/plain": string;
4501
- };
4502
- };
4503
- /** @description Internal server error */
4504
- 500: {
4505
- headers: {
4506
- [name: string]: unknown;
4507
- };
4508
- content: {
4509
- "text/plain": string;
4510
- };
4511
- };
4512
- };
4513
- };
4514
- deleteMesheryConnection: {
4515
- parameters: {
4516
- query?: never;
4517
- header?: never;
4518
- path: {
4519
- /** @description Meshery server ID */
4520
- mesheryServerId: string;
4521
- };
4522
- cookie?: never;
4523
- };
4524
- requestBody?: never;
4525
- responses: {
4526
- /** @description Meshery connection deleted */
4527
- 204: {
4528
- headers: {
4529
- [name: string]: unknown;
4530
- };
4531
- content?: never;
4532
- };
4533
5459
  /** @description Expired JWT token used or insufficient privilege */
4534
5460
  401: {
4535
5461
  headers: {