@meshery/schemas 1.3.88 → 1.3.89

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/cloudApi.d.mts +9541 -6382
  2. package/dist/cloudApi.d.ts +9541 -6382
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtp.d.ts +1 -1
  6. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.js +1 -1
  7. package/dist/constructs/v1beta1/organization_smtp/OrganizationSmtpSchema.mjs +1 -1
  8. package/dist/constructs/v1beta1/registry/Registry.d.ts +3 -3
  9. package/dist/constructs/v1beta1/registry/RegistrySchema.js +3 -3
  10. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +3 -3
  11. package/dist/constructs/v1beta3/connection/Connection.d.ts +9 -9
  12. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  13. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  14. package/dist/constructs/v1beta3/environment/Environment.d.ts +15 -15
  15. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  16. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  17. package/dist/constructs/v1beta3/profile/Profile.d.ts +1639 -0
  18. package/dist/constructs/v1beta3/profile/Profile.js +1 -0
  19. package/dist/constructs/v1beta3/profile/Profile.mjs +0 -0
  20. package/dist/constructs/v1beta3/profile/ProfileSchema.d.ts +2 -0
  21. package/dist/constructs/v1beta3/profile/ProfileSchema.js +22 -0
  22. package/dist/constructs/v1beta3/profile/ProfileSchema.mjs +22 -0
  23. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +421 -1
  24. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  25. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  26. package/dist/mesheryApi.d.mts +17 -17
  27. package/dist/mesheryApi.d.ts +17 -17
  28. package/dist/permissions.d.mts +85 -1
  29. package/dist/permissions.d.ts +85 -1
  30. package/dist/permissions.js +1 -1
  31. package/dist/permissions.mjs +1 -1
  32. package/package.json +1 -1
@@ -0,0 +1,1639 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+
6
+ export interface paths {
7
+ "/api/profiles": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
14
+ /**
15
+ * Get all profiles
16
+ * @description Gets the live profiles the caller can see: those assigned to a workspace the caller is a member of, those the caller owns, and, for organization admins, every profile of the organization. `search` matches the name or description case-insensitively.
17
+ */
18
+ get: operations["getProfiles"];
19
+ put?: never;
20
+ /**
21
+ * Create a profile
22
+ * @description Creates a profile in the organization named by `organizationId`. The server assigns `id` and the timestamps; `owner` defaults to the authenticated user. Names are not unique.
23
+ */
24
+ post: operations["createProfile"];
25
+ delete?: never;
26
+ options?: never;
27
+ head?: never;
28
+ patch?: never;
29
+ trace?: never;
30
+ };
31
+ "/api/profiles/{profileId}": {
32
+ parameters: {
33
+ query?: never;
34
+ header?: never;
35
+ path?: never;
36
+ cookie?: never;
37
+ };
38
+ /** Get profile by ID */
39
+ get: operations["getProfileById"];
40
+ /**
41
+ * Update a profile
42
+ * @description Replaces the client-settable fields of the profile. `organizationId` cannot change after creation; a different value is refused with 400. Changing `owner` transfers the profile; the new owner must be a member of the organization.
43
+ */
44
+ put: operations["updateProfile"];
45
+ post?: never;
46
+ /**
47
+ * Delete a profile
48
+ * @description Soft-deletes the profile and removes its workspace assignments and connection links. The linked connections themselves are left intact.
49
+ */
50
+ delete: operations["deleteProfile"];
51
+ options?: never;
52
+ head?: never;
53
+ patch?: never;
54
+ trace?: never;
55
+ };
56
+ "/api/profiles/{profileId}/connections": {
57
+ parameters: {
58
+ query?: never;
59
+ header?: never;
60
+ path?: never;
61
+ cookie?: never;
62
+ };
63
+ /**
64
+ * Get profile connections
65
+ * @description Gets the connections linked to the profile. Requires View Profiles and visibility of the profile.
66
+ */
67
+ get: operations["getProfileConnections"];
68
+ put?: never;
69
+ post?: never;
70
+ delete?: never;
71
+ options?: never;
72
+ head?: never;
73
+ patch?: never;
74
+ trace?: never;
75
+ };
76
+ "/api/profiles/{profileId}/connections/{connectionId}": {
77
+ parameters: {
78
+ query?: never;
79
+ header?: never;
80
+ path?: never;
81
+ cookie?: never;
82
+ };
83
+ get?: never;
84
+ put?: never;
85
+ /**
86
+ * Add connection to profile
87
+ * @description Links an existing connection of the same organization to the profile. Requires Edit Profile.
88
+ */
89
+ post: operations["addConnectionToProfile"];
90
+ /**
91
+ * Remove connection from profile
92
+ * @description Unlinks a connection from the profile. The connection itself is left intact. Requires Edit Profile.
93
+ */
94
+ delete: operations["removeConnectionFromProfile"];
95
+ options?: never;
96
+ head?: never;
97
+ patch?: never;
98
+ trace?: never;
99
+ };
100
+ }
101
+ export type webhooks = Record<string, never>;
102
+ export interface components {
103
+ schemas: {
104
+ /**
105
+ * Profile
106
+ * @description A profile is a publishing or persona profile: a named set of settings, owned by an organization, that a person or brand publishes as, with the platform accounts it acts through linked to it as Connections. It is not the user account profile (`/api/identity/users/profile`) and not a performance profile (`/api/performance/profiles`), and it is neither an environment nor a workspace. Like environments, a profile is assigned to any number of workspaces, and workspace assignment is how access to it is granted: a profile is readable by members of the workspaces it is assigned to and by organization admins.
107
+ * @example {
108
+ * "id": "00000000-0000-0000-0000-000000000000",
109
+ * "schemaVersion": "profiles.meshery.io/v1beta3",
110
+ * "name": "jane",
111
+ * "description": "Profile for Jane's accounts and settings.",
112
+ * "organizationId": "00000000-0000-0000-0000-000000000000",
113
+ * "owner": "00000000-0000-0000-0000-000000000000",
114
+ * "userId": "00000000-0000-0000-0000-000000000000",
115
+ * "metadata": {},
116
+ * "createdAt": "0001-01-01T00:00:00Z",
117
+ * "updatedAt": "0001-01-01T00:00:00Z",
118
+ * "deletedAt": null
119
+ * }
120
+ */
121
+ Profile: {
122
+ /**
123
+ * Format: uuid
124
+ * @description Server-generated profile ID.
125
+ */
126
+ id: string;
127
+ /**
128
+ * @description Specifies the version of the schema to which the profile conforms.
129
+ * @default profiles.meshery.io/v1beta3
130
+ * @example [
131
+ * "v1",
132
+ * "v1alpha1",
133
+ * "v2beta3",
134
+ * "v1.custom-suffix",
135
+ * "models.meshery.io/v1beta1",
136
+ * "capability.meshery.io/v1alpha1"
137
+ * ]
138
+ */
139
+ schemaVersion: string;
140
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
141
+ name: string;
142
+ /** @description Description of the profile. */
143
+ description?: string;
144
+ /**
145
+ * Format: uuid
146
+ * @description Owning organization ID. Fixed at creation.
147
+ */
148
+ organizationId: string;
149
+ /**
150
+ * Format: uuid
151
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
152
+ */
153
+ owner: string;
154
+ /**
155
+ * Format: uuid
156
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
157
+ */
158
+ userId?: string;
159
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
160
+ metadata?: Record<string, never>;
161
+ /**
162
+ * Format: date-time
163
+ * @description Timestamp when the profile was created.
164
+ */
165
+ createdAt: string;
166
+ /**
167
+ * Format: date-time
168
+ * @description Timestamp when the profile was last updated.
169
+ */
170
+ updatedAt: string;
171
+ /**
172
+ * Format: date-time
173
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
174
+ */
175
+ deletedAt?: string | null;
176
+ };
177
+ /** @description Payload for creating or updating a profile. Carries only the client-settable fields. `id`, `createdAt`, `updatedAt` and `deletedAt` are server-owned and deliberately absent. `owner` is optional: omitted on create it defaults to the authenticated user, and omitted on update it is unchanged. */
178
+ ProfilePayload: {
179
+ /** @description Name of the profile, typically its short handle. Not unique. */
180
+ name: string;
181
+ /** @description Description of the profile. */
182
+ description?: string;
183
+ /**
184
+ * Format: uuid
185
+ * @description Organization in which to create the profile. Cannot change after creation.
186
+ */
187
+ organizationId: string;
188
+ /**
189
+ * Format: uuid
190
+ * @description ID of the user who owns the profile. Only the owner or a holder of Edit Profile in a workspace the profile is assigned to may change it.
191
+ */
192
+ owner?: string;
193
+ /**
194
+ * Format: uuid
195
+ * @description ID of the user this profile represents, when it represents a user. The user must be a member of the organization.
196
+ */
197
+ userId?: string;
198
+ /** @description Free-form settings of the profile. */
199
+ metadata?: {
200
+ [key: string]: unknown;
201
+ };
202
+ };
203
+ /** @description Paginated list of profiles. */
204
+ ProfilePage: {
205
+ /** @description Zero-based page index returned in this response. */
206
+ page: number;
207
+ /** @description Maximum number of items returned on each page. */
208
+ pageSize: number;
209
+ /** @description Total number of items across all pages. */
210
+ totalCount: number;
211
+ /** @description Profiles in this page. */
212
+ profiles: {
213
+ /**
214
+ * Format: uuid
215
+ * @description Server-generated profile ID.
216
+ */
217
+ id: string;
218
+ /**
219
+ * @description Specifies the version of the schema to which the profile conforms.
220
+ * @default profiles.meshery.io/v1beta3
221
+ * @example [
222
+ * "v1",
223
+ * "v1alpha1",
224
+ * "v2beta3",
225
+ * "v1.custom-suffix",
226
+ * "models.meshery.io/v1beta1",
227
+ * "capability.meshery.io/v1alpha1"
228
+ * ]
229
+ */
230
+ schemaVersion: string;
231
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
232
+ name: string;
233
+ /** @description Description of the profile. */
234
+ description?: string;
235
+ /**
236
+ * Format: uuid
237
+ * @description Owning organization ID. Fixed at creation.
238
+ */
239
+ organizationId: string;
240
+ /**
241
+ * Format: uuid
242
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
243
+ */
244
+ owner: string;
245
+ /**
246
+ * Format: uuid
247
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
248
+ */
249
+ userId?: string;
250
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
251
+ metadata?: Record<string, never>;
252
+ /**
253
+ * Format: date-time
254
+ * @description Timestamp when the profile was created.
255
+ */
256
+ createdAt: string;
257
+ /**
258
+ * Format: date-time
259
+ * @description Timestamp when the profile was last updated.
260
+ */
261
+ updatedAt: string;
262
+ /**
263
+ * Format: date-time
264
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
265
+ */
266
+ deletedAt?: string | null;
267
+ }[];
268
+ };
269
+ /** @description Junction record linking a profile to a connection. */
270
+ ProfileConnectionMapping: {
271
+ /**
272
+ * Format: uuid
273
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
274
+ */
275
+ id: string;
276
+ /**
277
+ * Format: uuid
278
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
279
+ */
280
+ profileId: string;
281
+ /**
282
+ * Format: uuid
283
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
284
+ */
285
+ connectionId: string;
286
+ /**
287
+ * Format: date-time
288
+ * @description Timestamp when the mapping was created.
289
+ */
290
+ createdAt?: string;
291
+ /**
292
+ * Format: date-time
293
+ * @description Timestamp when the mapping was last updated.
294
+ */
295
+ updatedAt?: string;
296
+ /**
297
+ * Format: date-time
298
+ * @description Timestamp when the mapping was soft-deleted. Null while the mapping remains active.
299
+ */
300
+ deletedAt?: string | null;
301
+ };
302
+ };
303
+ responses: {
304
+ /** @description Invalid request body or request param */
305
+ 400: {
306
+ headers: {
307
+ [name: string]: unknown;
308
+ };
309
+ content: {
310
+ "text/plain": string;
311
+ };
312
+ };
313
+ /** @description Expired JWT token used or insufficient privilege */
314
+ 401: {
315
+ headers: {
316
+ [name: string]: unknown;
317
+ };
318
+ content: {
319
+ "text/plain": string;
320
+ };
321
+ };
322
+ /** @description Forbidden */
323
+ 403: {
324
+ headers: {
325
+ [name: string]: unknown;
326
+ };
327
+ content: {
328
+ "text/plain": string;
329
+ };
330
+ };
331
+ /** @description Result not found */
332
+ 404: {
333
+ headers: {
334
+ [name: string]: unknown;
335
+ };
336
+ content: {
337
+ "text/plain": string;
338
+ };
339
+ };
340
+ /** @description Internal server error */
341
+ 500: {
342
+ headers: {
343
+ [name: string]: unknown;
344
+ };
345
+ content: {
346
+ "text/plain": string;
347
+ };
348
+ };
349
+ };
350
+ parameters: {
351
+ /** @description Profile ID */
352
+ profileId: string;
353
+ /** @description Connection ID */
354
+ connectionId: string;
355
+ /** @description Get responses that match search param value */
356
+ search: string;
357
+ /** @description Get ordered responses */
358
+ order: string;
359
+ /** @description Get responses by page */
360
+ page: number;
361
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
362
+ pageSize: number;
363
+ /**
364
+ * @deprecated
365
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
366
+ */
367
+ pagesize: number;
368
+ /** @description Organization ID used to scope the listing. Defaults to the organization the session resolved to. */
369
+ orgIdQuery: string;
370
+ /** @description Return only the profile that represents this user. */
371
+ userIdQuery: string;
372
+ };
373
+ requestBodies: {
374
+ /** @description Body for creating or updating a profile */
375
+ profilePayload: {
376
+ content: {
377
+ "application/json": {
378
+ /** @description Name of the profile, typically its short handle. Not unique. */
379
+ name: string;
380
+ /** @description Description of the profile. */
381
+ description?: string;
382
+ /**
383
+ * Format: uuid
384
+ * @description Organization in which to create the profile. Cannot change after creation.
385
+ */
386
+ organizationId: string;
387
+ /**
388
+ * Format: uuid
389
+ * @description ID of the user who owns the profile. Only the owner or a holder of Edit Profile in a workspace the profile is assigned to may change it.
390
+ */
391
+ owner?: string;
392
+ /**
393
+ * Format: uuid
394
+ * @description ID of the user this profile represents, when it represents a user. The user must be a member of the organization.
395
+ */
396
+ userId?: string;
397
+ /** @description Free-form settings of the profile. */
398
+ metadata?: {
399
+ [key: string]: unknown;
400
+ };
401
+ };
402
+ };
403
+ };
404
+ };
405
+ headers: never;
406
+ pathItems: never;
407
+ }
408
+ export type $defs = Record<string, never>;
409
+ export interface operations {
410
+ getProfiles: {
411
+ parameters: {
412
+ query?: {
413
+ /** @description Get responses that match search param value */
414
+ search?: string;
415
+ /** @description Get ordered responses */
416
+ order?: string;
417
+ /** @description Get responses by page */
418
+ page?: number;
419
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
420
+ pageSize?: number;
421
+ /**
422
+ * @deprecated
423
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
424
+ */
425
+ pagesize?: number;
426
+ /** @description Organization ID used to scope the listing. Defaults to the organization the session resolved to. */
427
+ orgId?: string;
428
+ /** @description Return only the profile that represents this user. */
429
+ userId?: string;
430
+ };
431
+ header?: never;
432
+ path?: never;
433
+ cookie?: never;
434
+ };
435
+ requestBody?: never;
436
+ responses: {
437
+ /** @description Profiles */
438
+ 200: {
439
+ headers: {
440
+ [name: string]: unknown;
441
+ };
442
+ content: {
443
+ "application/json": {
444
+ /** @description Zero-based page index returned in this response. */
445
+ page: number;
446
+ /** @description Maximum number of items returned on each page. */
447
+ pageSize: number;
448
+ /** @description Total number of items across all pages. */
449
+ totalCount: number;
450
+ /** @description Profiles in this page. */
451
+ profiles: {
452
+ /**
453
+ * Format: uuid
454
+ * @description Server-generated profile ID.
455
+ */
456
+ id: string;
457
+ /**
458
+ * @description Specifies the version of the schema to which the profile conforms.
459
+ * @default profiles.meshery.io/v1beta3
460
+ * @example [
461
+ * "v1",
462
+ * "v1alpha1",
463
+ * "v2beta3",
464
+ * "v1.custom-suffix",
465
+ * "models.meshery.io/v1beta1",
466
+ * "capability.meshery.io/v1alpha1"
467
+ * ]
468
+ */
469
+ schemaVersion: string;
470
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
471
+ name: string;
472
+ /** @description Description of the profile. */
473
+ description?: string;
474
+ /**
475
+ * Format: uuid
476
+ * @description Owning organization ID. Fixed at creation.
477
+ */
478
+ organizationId: string;
479
+ /**
480
+ * Format: uuid
481
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
482
+ */
483
+ owner: string;
484
+ /**
485
+ * Format: uuid
486
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
487
+ */
488
+ userId?: string;
489
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
490
+ metadata?: Record<string, never>;
491
+ /**
492
+ * Format: date-time
493
+ * @description Timestamp when the profile was created.
494
+ */
495
+ createdAt: string;
496
+ /**
497
+ * Format: date-time
498
+ * @description Timestamp when the profile was last updated.
499
+ */
500
+ updatedAt: string;
501
+ /**
502
+ * Format: date-time
503
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
504
+ */
505
+ deletedAt?: string | null;
506
+ }[];
507
+ };
508
+ };
509
+ };
510
+ /** @description Expired JWT token used or insufficient privilege */
511
+ 401: {
512
+ headers: {
513
+ [name: string]: unknown;
514
+ };
515
+ content: {
516
+ "text/plain": string;
517
+ };
518
+ };
519
+ /** @description Forbidden */
520
+ 403: {
521
+ headers: {
522
+ [name: string]: unknown;
523
+ };
524
+ content: {
525
+ "text/plain": string;
526
+ };
527
+ };
528
+ /** @description Internal server error */
529
+ 500: {
530
+ headers: {
531
+ [name: string]: unknown;
532
+ };
533
+ content: {
534
+ "text/plain": string;
535
+ };
536
+ };
537
+ };
538
+ };
539
+ createProfile: {
540
+ parameters: {
541
+ query?: never;
542
+ header?: never;
543
+ path?: never;
544
+ cookie?: never;
545
+ };
546
+ /** @description Body for creating or updating a profile */
547
+ requestBody: {
548
+ content: {
549
+ "application/json": {
550
+ /** @description Name of the profile, typically its short handle. Not unique. */
551
+ name: string;
552
+ /** @description Description of the profile. */
553
+ description?: string;
554
+ /**
555
+ * Format: uuid
556
+ * @description Organization in which to create the profile. Cannot change after creation.
557
+ */
558
+ organizationId: string;
559
+ /**
560
+ * Format: uuid
561
+ * @description ID of the user who owns the profile. Only the owner or a holder of Edit Profile in a workspace the profile is assigned to may change it.
562
+ */
563
+ owner?: string;
564
+ /**
565
+ * Format: uuid
566
+ * @description ID of the user this profile represents, when it represents a user. The user must be a member of the organization.
567
+ */
568
+ userId?: string;
569
+ /** @description Free-form settings of the profile. */
570
+ metadata?: {
571
+ [key: string]: unknown;
572
+ };
573
+ };
574
+ };
575
+ };
576
+ responses: {
577
+ /** @description Created profile */
578
+ 201: {
579
+ headers: {
580
+ [name: string]: unknown;
581
+ };
582
+ content: {
583
+ "application/json": {
584
+ /**
585
+ * Format: uuid
586
+ * @description Server-generated profile ID.
587
+ */
588
+ id: string;
589
+ /**
590
+ * @description Specifies the version of the schema to which the profile conforms.
591
+ * @default profiles.meshery.io/v1beta3
592
+ * @example [
593
+ * "v1",
594
+ * "v1alpha1",
595
+ * "v2beta3",
596
+ * "v1.custom-suffix",
597
+ * "models.meshery.io/v1beta1",
598
+ * "capability.meshery.io/v1alpha1"
599
+ * ]
600
+ */
601
+ schemaVersion: string;
602
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
603
+ name: string;
604
+ /** @description Description of the profile. */
605
+ description?: string;
606
+ /**
607
+ * Format: uuid
608
+ * @description Owning organization ID. Fixed at creation.
609
+ */
610
+ organizationId: string;
611
+ /**
612
+ * Format: uuid
613
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
614
+ */
615
+ owner: string;
616
+ /**
617
+ * Format: uuid
618
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
619
+ */
620
+ userId?: string;
621
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
622
+ metadata?: Record<string, never>;
623
+ /**
624
+ * Format: date-time
625
+ * @description Timestamp when the profile was created.
626
+ */
627
+ createdAt: string;
628
+ /**
629
+ * Format: date-time
630
+ * @description Timestamp when the profile was last updated.
631
+ */
632
+ updatedAt: string;
633
+ /**
634
+ * Format: date-time
635
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
636
+ */
637
+ deletedAt?: string | null;
638
+ };
639
+ };
640
+ };
641
+ /** @description Invalid request body or request param */
642
+ 400: {
643
+ headers: {
644
+ [name: string]: unknown;
645
+ };
646
+ content: {
647
+ "text/plain": string;
648
+ };
649
+ };
650
+ /** @description Expired JWT token used or insufficient privilege */
651
+ 401: {
652
+ headers: {
653
+ [name: string]: unknown;
654
+ };
655
+ content: {
656
+ "text/plain": string;
657
+ };
658
+ };
659
+ /** @description Forbidden */
660
+ 403: {
661
+ headers: {
662
+ [name: string]: unknown;
663
+ };
664
+ content: {
665
+ "text/plain": string;
666
+ };
667
+ };
668
+ /** @description Internal server error */
669
+ 500: {
670
+ headers: {
671
+ [name: string]: unknown;
672
+ };
673
+ content: {
674
+ "text/plain": string;
675
+ };
676
+ };
677
+ };
678
+ };
679
+ getProfileById: {
680
+ parameters: {
681
+ query?: never;
682
+ header?: never;
683
+ path: {
684
+ /** @description Profile ID */
685
+ profileId: string;
686
+ };
687
+ cookie?: never;
688
+ };
689
+ requestBody?: never;
690
+ responses: {
691
+ /** @description Profile */
692
+ 200: {
693
+ headers: {
694
+ [name: string]: unknown;
695
+ };
696
+ content: {
697
+ "application/json": {
698
+ /**
699
+ * Format: uuid
700
+ * @description Server-generated profile ID.
701
+ */
702
+ id: string;
703
+ /**
704
+ * @description Specifies the version of the schema to which the profile conforms.
705
+ * @default profiles.meshery.io/v1beta3
706
+ * @example [
707
+ * "v1",
708
+ * "v1alpha1",
709
+ * "v2beta3",
710
+ * "v1.custom-suffix",
711
+ * "models.meshery.io/v1beta1",
712
+ * "capability.meshery.io/v1alpha1"
713
+ * ]
714
+ */
715
+ schemaVersion: string;
716
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
717
+ name: string;
718
+ /** @description Description of the profile. */
719
+ description?: string;
720
+ /**
721
+ * Format: uuid
722
+ * @description Owning organization ID. Fixed at creation.
723
+ */
724
+ organizationId: string;
725
+ /**
726
+ * Format: uuid
727
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
728
+ */
729
+ owner: string;
730
+ /**
731
+ * Format: uuid
732
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
733
+ */
734
+ userId?: string;
735
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
736
+ metadata?: Record<string, never>;
737
+ /**
738
+ * Format: date-time
739
+ * @description Timestamp when the profile was created.
740
+ */
741
+ createdAt: string;
742
+ /**
743
+ * Format: date-time
744
+ * @description Timestamp when the profile was last updated.
745
+ */
746
+ updatedAt: string;
747
+ /**
748
+ * Format: date-time
749
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
750
+ */
751
+ deletedAt?: string | null;
752
+ };
753
+ };
754
+ };
755
+ /** @description Invalid request body or request param */
756
+ 400: {
757
+ headers: {
758
+ [name: string]: unknown;
759
+ };
760
+ content: {
761
+ "text/plain": string;
762
+ };
763
+ };
764
+ /** @description Expired JWT token used or insufficient privilege */
765
+ 401: {
766
+ headers: {
767
+ [name: string]: unknown;
768
+ };
769
+ content: {
770
+ "text/plain": string;
771
+ };
772
+ };
773
+ /** @description Forbidden */
774
+ 403: {
775
+ headers: {
776
+ [name: string]: unknown;
777
+ };
778
+ content: {
779
+ "text/plain": string;
780
+ };
781
+ };
782
+ /** @description Result not found */
783
+ 404: {
784
+ headers: {
785
+ [name: string]: unknown;
786
+ };
787
+ content: {
788
+ "text/plain": string;
789
+ };
790
+ };
791
+ /** @description Internal server error */
792
+ 500: {
793
+ headers: {
794
+ [name: string]: unknown;
795
+ };
796
+ content: {
797
+ "text/plain": string;
798
+ };
799
+ };
800
+ };
801
+ };
802
+ updateProfile: {
803
+ parameters: {
804
+ query?: never;
805
+ header?: never;
806
+ path: {
807
+ /** @description Profile ID */
808
+ profileId: string;
809
+ };
810
+ cookie?: never;
811
+ };
812
+ /** @description Body for creating or updating a profile */
813
+ requestBody: {
814
+ content: {
815
+ "application/json": {
816
+ /** @description Name of the profile, typically its short handle. Not unique. */
817
+ name: string;
818
+ /** @description Description of the profile. */
819
+ description?: string;
820
+ /**
821
+ * Format: uuid
822
+ * @description Organization in which to create the profile. Cannot change after creation.
823
+ */
824
+ organizationId: string;
825
+ /**
826
+ * Format: uuid
827
+ * @description ID of the user who owns the profile. Only the owner or a holder of Edit Profile in a workspace the profile is assigned to may change it.
828
+ */
829
+ owner?: string;
830
+ /**
831
+ * Format: uuid
832
+ * @description ID of the user this profile represents, when it represents a user. The user must be a member of the organization.
833
+ */
834
+ userId?: string;
835
+ /** @description Free-form settings of the profile. */
836
+ metadata?: {
837
+ [key: string]: unknown;
838
+ };
839
+ };
840
+ };
841
+ };
842
+ responses: {
843
+ /** @description Updated profile */
844
+ 200: {
845
+ headers: {
846
+ [name: string]: unknown;
847
+ };
848
+ content: {
849
+ "application/json": {
850
+ /**
851
+ * Format: uuid
852
+ * @description Server-generated profile ID.
853
+ */
854
+ id: string;
855
+ /**
856
+ * @description Specifies the version of the schema to which the profile conforms.
857
+ * @default profiles.meshery.io/v1beta3
858
+ * @example [
859
+ * "v1",
860
+ * "v1alpha1",
861
+ * "v2beta3",
862
+ * "v1.custom-suffix",
863
+ * "models.meshery.io/v1beta1",
864
+ * "capability.meshery.io/v1alpha1"
865
+ * ]
866
+ */
867
+ schemaVersion: string;
868
+ /** @description Name of the profile, typically its short handle. Not unique; like environment names, two profiles may share one. */
869
+ name: string;
870
+ /** @description Description of the profile. */
871
+ description?: string;
872
+ /**
873
+ * Format: uuid
874
+ * @description Owning organization ID. Fixed at creation.
875
+ */
876
+ organizationId: string;
877
+ /**
878
+ * Format: uuid
879
+ * @description ID of the user who owns the profile. Defaults to the creating user. The owner, or a holder of the Edit Profile key in a workspace the profile is assigned to, may transfer it. When the owner's account is deleted, ownership passes on by the same succession rule that applies to designs.
880
+ */
881
+ owner: string;
882
+ /**
883
+ * Format: uuid
884
+ * @description ID of the user this profile represents, when it represents a user. Absent for a profile that represents no user account, such as a brand. Not unique: a user may be represented by more than one profile.
885
+ */
886
+ userId?: string;
887
+ /** @description Free-form settings of the profile, stored as a JSON blob. */
888
+ metadata?: Record<string, never>;
889
+ /**
890
+ * Format: date-time
891
+ * @description Timestamp when the profile was created.
892
+ */
893
+ createdAt: string;
894
+ /**
895
+ * Format: date-time
896
+ * @description Timestamp when the profile was last updated.
897
+ */
898
+ updatedAt: string;
899
+ /**
900
+ * Format: date-time
901
+ * @description Timestamp when the profile was soft-deleted. Null while the profile remains active.
902
+ */
903
+ deletedAt?: string | null;
904
+ };
905
+ };
906
+ };
907
+ /** @description Invalid request body or request param */
908
+ 400: {
909
+ headers: {
910
+ [name: string]: unknown;
911
+ };
912
+ content: {
913
+ "text/plain": string;
914
+ };
915
+ };
916
+ /** @description Expired JWT token used or insufficient privilege */
917
+ 401: {
918
+ headers: {
919
+ [name: string]: unknown;
920
+ };
921
+ content: {
922
+ "text/plain": string;
923
+ };
924
+ };
925
+ /** @description Forbidden */
926
+ 403: {
927
+ headers: {
928
+ [name: string]: unknown;
929
+ };
930
+ content: {
931
+ "text/plain": string;
932
+ };
933
+ };
934
+ /** @description Result not found */
935
+ 404: {
936
+ headers: {
937
+ [name: string]: unknown;
938
+ };
939
+ content: {
940
+ "text/plain": string;
941
+ };
942
+ };
943
+ /** @description Internal server error */
944
+ 500: {
945
+ headers: {
946
+ [name: string]: unknown;
947
+ };
948
+ content: {
949
+ "text/plain": string;
950
+ };
951
+ };
952
+ };
953
+ };
954
+ deleteProfile: {
955
+ parameters: {
956
+ query?: never;
957
+ header?: never;
958
+ path: {
959
+ /** @description Profile ID */
960
+ profileId: string;
961
+ };
962
+ cookie?: never;
963
+ };
964
+ requestBody?: never;
965
+ responses: {
966
+ /** @description Profile deleted */
967
+ 204: {
968
+ headers: {
969
+ [name: string]: unknown;
970
+ };
971
+ content?: never;
972
+ };
973
+ /** @description Invalid request body or request param */
974
+ 400: {
975
+ headers: {
976
+ [name: string]: unknown;
977
+ };
978
+ content: {
979
+ "text/plain": string;
980
+ };
981
+ };
982
+ /** @description Expired JWT token used or insufficient privilege */
983
+ 401: {
984
+ headers: {
985
+ [name: string]: unknown;
986
+ };
987
+ content: {
988
+ "text/plain": string;
989
+ };
990
+ };
991
+ /** @description Forbidden */
992
+ 403: {
993
+ headers: {
994
+ [name: string]: unknown;
995
+ };
996
+ content: {
997
+ "text/plain": string;
998
+ };
999
+ };
1000
+ /** @description Result not found */
1001
+ 404: {
1002
+ headers: {
1003
+ [name: string]: unknown;
1004
+ };
1005
+ content: {
1006
+ "text/plain": string;
1007
+ };
1008
+ };
1009
+ /** @description Internal server error */
1010
+ 500: {
1011
+ headers: {
1012
+ [name: string]: unknown;
1013
+ };
1014
+ content: {
1015
+ "text/plain": string;
1016
+ };
1017
+ };
1018
+ };
1019
+ };
1020
+ getProfileConnections: {
1021
+ parameters: {
1022
+ query?: {
1023
+ /** @description Get responses that match search param value */
1024
+ search?: string;
1025
+ /** @description Get ordered responses */
1026
+ order?: string;
1027
+ /** @description Get responses by page */
1028
+ page?: number;
1029
+ /** @description Number of responses to return per page. Canonical camelCase pagination parameter; prefer this over the deprecated all-lowercase `pagesize`. */
1030
+ pageSize?: number;
1031
+ /**
1032
+ * @deprecated
1033
+ * @description Get responses by pagesize. Deprecated alias of pageSize.
1034
+ */
1035
+ pagesize?: number;
1036
+ };
1037
+ header?: never;
1038
+ path: {
1039
+ /** @description Profile ID */
1040
+ profileId: string;
1041
+ };
1042
+ cookie?: never;
1043
+ };
1044
+ requestBody?: never;
1045
+ responses: {
1046
+ /** @description Profile connections */
1047
+ 200: {
1048
+ headers: {
1049
+ [name: string]: unknown;
1050
+ };
1051
+ content: {
1052
+ "application/json": {
1053
+ /** @description List of connections on this page */
1054
+ connections: {
1055
+ /**
1056
+ * Format: uuid
1057
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1058
+ */
1059
+ id: string;
1060
+ /** @description Connection Name */
1061
+ name: string;
1062
+ /** @description Human-readable description of the connection and its purpose. */
1063
+ description?: string;
1064
+ /**
1065
+ * Format: uri
1066
+ * @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).
1067
+ */
1068
+ url?: string;
1069
+ /**
1070
+ * Format: uuid
1071
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1072
+ */
1073
+ credentialId?: string;
1074
+ /** @description Connection Type (platform, telemetry, collaboration) */
1075
+ type: string;
1076
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
1077
+ subType: string;
1078
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github, desktop) */
1079
+ kind: string;
1080
+ /** @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 */
1081
+ modelReference?: {
1082
+ /**
1083
+ * Format: uuid
1084
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1085
+ */
1086
+ id: string;
1087
+ /**
1088
+ * @description The unique name for the model within the scope of a registrant.
1089
+ * @example cert-manager
1090
+ */
1091
+ name: string;
1092
+ /** @description Version of the model definition. */
1093
+ version: string;
1094
+ /**
1095
+ * @description Human-readable name for the model.
1096
+ * @example Cert Manager
1097
+ */
1098
+ displayName: string;
1099
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1100
+ model: {
1101
+ /** @description Version of the model as defined by the registrant. */
1102
+ version: string;
1103
+ };
1104
+ registrant: {
1105
+ /** @description Kind of the registrant. */
1106
+ kind: string;
1107
+ };
1108
+ };
1109
+ /** @description Additional connection metadata */
1110
+ metadata?: Record<string, never>;
1111
+ /** @description Schema for the credential Associated with the connection */
1112
+ credentialSchema?: Record<string, never>;
1113
+ /** @description Schema for the connection */
1114
+ connectionSchema?: Record<string, never>;
1115
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
1116
+ styles?: ({
1117
+ /** @description Primary color of the component used for UI representation. */
1118
+ primaryColor: string;
1119
+ /** @description Secondary color of the entity used for UI representation. */
1120
+ secondaryColor?: string;
1121
+ /** @description White SVG of the entity used for UI representation on dark background. */
1122
+ svgWhite: string;
1123
+ /** @description Colored SVG of the entity used for UI representation on light background. */
1124
+ svgColor: string;
1125
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1126
+ svgComplete: string;
1127
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
1128
+ color?: string;
1129
+ /** @description The opacity of the label text, including its outline. */
1130
+ textOpacity?: number;
1131
+ /** @description A comma-separated list of font names to use on the label text. */
1132
+ fontFamily?: string;
1133
+ /** @description The size of the label text. */
1134
+ fontSize?: string;
1135
+ /** @description A CSS font style to be applied to the label text. */
1136
+ fontStyle?: string;
1137
+ /** @description A CSS font weight to be applied to the label text. */
1138
+ fontWeight?: string;
1139
+ /**
1140
+ * @description A transformation to apply to the label text
1141
+ * @enum {string}
1142
+ */
1143
+ textTransform?: "none" | "uppercase" | "lowercase";
1144
+ /** @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. */
1145
+ opacity?: number;
1146
+ /** @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. */
1147
+ zIndex?: number;
1148
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
1149
+ label?: string;
1150
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
1151
+ animation?: Record<string, never>;
1152
+ } & {
1153
+ [key: string]: unknown;
1154
+ }) & {
1155
+ /**
1156
+ * @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)
1157
+ * @enum {string}
1158
+ */
1159
+ 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";
1160
+ /** @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. */
1161
+ position?: {
1162
+ /** @description The x-coordinate of the node. */
1163
+ x: number;
1164
+ /** @description The y-coordinate of the node. */
1165
+ y: number;
1166
+ };
1167
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
1168
+ bodyText?: string;
1169
+ /**
1170
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
1171
+ * @enum {string}
1172
+ */
1173
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
1174
+ /** @description The maximum width for wrapping text in the node. */
1175
+ bodyTextMaxWidth?: string;
1176
+ /** @description The opacity of the node's body text, including its outline. */
1177
+ bodyTextOpacity?: number;
1178
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
1179
+ bodyTextBackgroundColor?: string;
1180
+ /** @description The size of the node's body text. */
1181
+ bodyTextFontSize?: number;
1182
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
1183
+ bodyTextColor?: string;
1184
+ /** @description A CSS font weight to be applied to the node's body text. */
1185
+ bodyTextFontWeight?: string;
1186
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
1187
+ bodyTextHorizontalAlign?: string;
1188
+ /** @description A CSS text decoration to be applied to the node's body text. */
1189
+ bodyTextDecoration?: string;
1190
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
1191
+ bodyTextVerticalAlign?: string;
1192
+ /** @description The width of the node's body or the width of an edge's line. */
1193
+ width?: number;
1194
+ /** @description The height of the node's body */
1195
+ height?: number;
1196
+ /**
1197
+ * Format: uri
1198
+ * @description The URL that points to the image to show in the node.
1199
+ */
1200
+ backgroundImage?: string;
1201
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
1202
+ backgroundColor?: string;
1203
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
1204
+ backgroundBlacken?: number;
1205
+ /** @description The opacity level of the node's background colour */
1206
+ backgroundOpacity?: number;
1207
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1208
+ backgroundPositionX?: string;
1209
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1210
+ backgroundPositionY?: string;
1211
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1212
+ backgroundOffsetX?: string;
1213
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
1214
+ backgroundOffsetY?: string;
1215
+ /**
1216
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
1217
+ * @enum {string}
1218
+ */
1219
+ backgroundFit?: "none" | "contain" | "cover";
1220
+ /**
1221
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
1222
+ * @enum {string}
1223
+ */
1224
+ backgroundClip?: "none" | "node" | "node-border";
1225
+ /**
1226
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
1227
+ * @enum {string}
1228
+ */
1229
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
1230
+ /**
1231
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
1232
+ * @enum {string}
1233
+ */
1234
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
1235
+ /** @description The size of the node's border. */
1236
+ borderWidth?: number;
1237
+ /**
1238
+ * @description The style of the node's border
1239
+ * @enum {string}
1240
+ */
1241
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
1242
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
1243
+ borderColor?: string;
1244
+ /** @description The opacity of the node's border */
1245
+ borderOpacity?: number;
1246
+ /** @description The amount of padding around all sides of the node. */
1247
+ padding?: number;
1248
+ /**
1249
+ * @description The horizontal alignment of a node's label
1250
+ * @enum {string}
1251
+ */
1252
+ textHalign?: "left" | "center" | "right";
1253
+ /**
1254
+ * @description The vertical alignment of a node's label
1255
+ * @enum {string}
1256
+ */
1257
+ textValign?: "top" | "center" | "bottom";
1258
+ /**
1259
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
1260
+ * @default no
1261
+ * @enum {string}
1262
+ */
1263
+ ghost: "yes" | "no";
1264
+ /** @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. */
1265
+ activeBgColor?: string;
1266
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
1267
+ activeBgOpacity?: string;
1268
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
1269
+ activeBgSize?: string;
1270
+ /** @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. */
1271
+ selectionBoxColor?: string;
1272
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
1273
+ selectionBoxBorderWidth?: number;
1274
+ /** @description The opacity of the selection box. Selector needs to be *core* */
1275
+ selectionBoxOpacity?: number;
1276
+ /** @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. */
1277
+ outsideTextureBgColor?: string;
1278
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
1279
+ outsideTextureBgOpacity?: number;
1280
+ /** @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 ) */
1281
+ shapePolygonPoints?: string;
1282
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
1283
+ menuBackgroundColor?: string;
1284
+ /** @description The opacity of the background of the component menu. */
1285
+ menuBackgroundOpacity?: number;
1286
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
1287
+ menuForgroundColor?: string;
1288
+ };
1289
+ /**
1290
+ * @description Connection Status
1291
+ * @enum {string}
1292
+ */
1293
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1294
+ /** @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. */
1295
+ transitionMap?: {
1296
+ [key: string]: {
1297
+ /**
1298
+ * @description The connection state reachable from the current state.
1299
+ * @enum {string}
1300
+ */
1301
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
1302
+ /** @description Human-readable explanation of when or why this transition occurs. */
1303
+ description?: string;
1304
+ }[];
1305
+ };
1306
+ /**
1307
+ * Format: uuid
1308
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1309
+ */
1310
+ owner?: string;
1311
+ /**
1312
+ * Format: date-time
1313
+ * @description Timestamp when the connection was created.
1314
+ */
1315
+ createdAt?: string;
1316
+ /**
1317
+ * Format: date-time
1318
+ * @description Timestamp when the connection was last updated.
1319
+ */
1320
+ updatedAt?: string;
1321
+ /**
1322
+ * Format: date-time
1323
+ * @description Timestamp when the connection was soft-deleted, if applicable.
1324
+ */
1325
+ deletedAt?: string | null;
1326
+ /**
1327
+ * Format: uuid
1328
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1329
+ */
1330
+ organizationId?: string;
1331
+ /** @description Associated environments for this connection */
1332
+ environments?: {
1333
+ /**
1334
+ * Format: uuid
1335
+ * @description ID
1336
+ */
1337
+ id: string;
1338
+ /**
1339
+ * @description Specifies the version of the schema to which the environment conforms.
1340
+ * @default environments.meshery.io/v1beta3
1341
+ * @example [
1342
+ * "v1",
1343
+ * "v1alpha1",
1344
+ * "v2beta3",
1345
+ * "v1.custom-suffix",
1346
+ * "models.meshery.io/v1beta1",
1347
+ * "capability.meshery.io/v1alpha1"
1348
+ * ]
1349
+ */
1350
+ schemaVersion: string;
1351
+ /** @description Environment name */
1352
+ name: string;
1353
+ /** @description Environment description */
1354
+ description: string;
1355
+ /**
1356
+ * Format: uuid
1357
+ * @description Environment organization ID
1358
+ */
1359
+ organizationId: string;
1360
+ /**
1361
+ * Format: uuid
1362
+ * @description Environment owner
1363
+ */
1364
+ owner?: string;
1365
+ /**
1366
+ * Format: date-time
1367
+ * @description Timestamp when the environment was created.
1368
+ */
1369
+ createdAt?: string;
1370
+ /** @description Additional metadata associated with the environment. */
1371
+ metadata?: Record<string, never>;
1372
+ /**
1373
+ * Format: date-time
1374
+ * @description Timestamp when the environment was last updated.
1375
+ */
1376
+ updatedAt?: string;
1377
+ /**
1378
+ * Format: date-time
1379
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
1380
+ */
1381
+ deletedAt?: string | null;
1382
+ /**
1383
+ * @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 deprecated: profiles are their own construct (`schemas/constructs/v1beta3/profile`, served at `/api/profiles` and assigned to workspaces under `/api/workspaces/{workspaceId}/profiles`), so new profiles must not be stored as environments. The value stays in the enum only so environments written with it before the profile construct existed still read back; it is an ordinary, non-privileged environment, carries no authority, and will be removed once no consumer stores it. Consumers should move those environments to profiles.
1384
+ *
1385
+ * 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.
1386
+ *
1387
+ * 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.
1388
+ *
1389
+ * 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.
1390
+ *
1391
+ * 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.
1392
+ * @enum {string}
1393
+ */
1394
+ purpose?: "user" | "administrative" | "profile";
1395
+ }[];
1396
+ /**
1397
+ * @description Specifies the version of the schema used for the definition.
1398
+ * @default connections.meshery.io/v1beta3
1399
+ * @example [
1400
+ * "v1",
1401
+ * "v1alpha1",
1402
+ * "v2beta3",
1403
+ * "v1.custom-suffix",
1404
+ * "models.meshery.io/v1beta1",
1405
+ * "capability.meshery.io/v1alpha1"
1406
+ * ]
1407
+ */
1408
+ schemaVersion: string;
1409
+ }[];
1410
+ /** @description Total number of connections on all pages */
1411
+ totalCount: number;
1412
+ /** @description Current page number */
1413
+ page: number;
1414
+ /** @description Number of elements per page */
1415
+ pageSize: number;
1416
+ /** @description Aggregate count of connections grouped by status */
1417
+ statusSummary?: {
1418
+ [key: string]: number;
1419
+ };
1420
+ };
1421
+ };
1422
+ };
1423
+ /** @description Invalid request body or request param */
1424
+ 400: {
1425
+ headers: {
1426
+ [name: string]: unknown;
1427
+ };
1428
+ content: {
1429
+ "text/plain": string;
1430
+ };
1431
+ };
1432
+ /** @description Expired JWT token used or insufficient privilege */
1433
+ 401: {
1434
+ headers: {
1435
+ [name: string]: unknown;
1436
+ };
1437
+ content: {
1438
+ "text/plain": string;
1439
+ };
1440
+ };
1441
+ /** @description Forbidden */
1442
+ 403: {
1443
+ headers: {
1444
+ [name: string]: unknown;
1445
+ };
1446
+ content: {
1447
+ "text/plain": string;
1448
+ };
1449
+ };
1450
+ /** @description Result not found */
1451
+ 404: {
1452
+ headers: {
1453
+ [name: string]: unknown;
1454
+ };
1455
+ content: {
1456
+ "text/plain": string;
1457
+ };
1458
+ };
1459
+ /** @description Internal server error */
1460
+ 500: {
1461
+ headers: {
1462
+ [name: string]: unknown;
1463
+ };
1464
+ content: {
1465
+ "text/plain": string;
1466
+ };
1467
+ };
1468
+ };
1469
+ };
1470
+ addConnectionToProfile: {
1471
+ parameters: {
1472
+ query?: never;
1473
+ header?: never;
1474
+ path: {
1475
+ /** @description Profile ID */
1476
+ profileId: string;
1477
+ /** @description Connection ID */
1478
+ connectionId: string;
1479
+ };
1480
+ cookie?: never;
1481
+ };
1482
+ requestBody?: never;
1483
+ responses: {
1484
+ /** @description Connection linked to profile */
1485
+ 201: {
1486
+ headers: {
1487
+ [name: string]: unknown;
1488
+ };
1489
+ content: {
1490
+ "application/json": {
1491
+ /**
1492
+ * Format: uuid
1493
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1494
+ */
1495
+ id: string;
1496
+ /**
1497
+ * Format: uuid
1498
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1499
+ */
1500
+ profileId: string;
1501
+ /**
1502
+ * Format: uuid
1503
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1504
+ */
1505
+ connectionId: string;
1506
+ /**
1507
+ * Format: date-time
1508
+ * @description Timestamp when the mapping was created.
1509
+ */
1510
+ createdAt?: string;
1511
+ /**
1512
+ * Format: date-time
1513
+ * @description Timestamp when the mapping was last updated.
1514
+ */
1515
+ updatedAt?: string;
1516
+ /**
1517
+ * Format: date-time
1518
+ * @description Timestamp when the mapping was soft-deleted. Null while the mapping remains active.
1519
+ */
1520
+ deletedAt?: string | null;
1521
+ };
1522
+ };
1523
+ };
1524
+ /** @description Invalid request body or request param */
1525
+ 400: {
1526
+ headers: {
1527
+ [name: string]: unknown;
1528
+ };
1529
+ content: {
1530
+ "text/plain": string;
1531
+ };
1532
+ };
1533
+ /** @description Expired JWT token used or insufficient privilege */
1534
+ 401: {
1535
+ headers: {
1536
+ [name: string]: unknown;
1537
+ };
1538
+ content: {
1539
+ "text/plain": string;
1540
+ };
1541
+ };
1542
+ /** @description Forbidden */
1543
+ 403: {
1544
+ headers: {
1545
+ [name: string]: unknown;
1546
+ };
1547
+ content: {
1548
+ "text/plain": string;
1549
+ };
1550
+ };
1551
+ /** @description Result not found */
1552
+ 404: {
1553
+ headers: {
1554
+ [name: string]: unknown;
1555
+ };
1556
+ content: {
1557
+ "text/plain": string;
1558
+ };
1559
+ };
1560
+ /** @description Internal server error */
1561
+ 500: {
1562
+ headers: {
1563
+ [name: string]: unknown;
1564
+ };
1565
+ content: {
1566
+ "text/plain": string;
1567
+ };
1568
+ };
1569
+ };
1570
+ };
1571
+ removeConnectionFromProfile: {
1572
+ parameters: {
1573
+ query?: never;
1574
+ header?: never;
1575
+ path: {
1576
+ /** @description Profile ID */
1577
+ profileId: string;
1578
+ /** @description Connection ID */
1579
+ connectionId: string;
1580
+ };
1581
+ cookie?: never;
1582
+ };
1583
+ requestBody?: never;
1584
+ responses: {
1585
+ /** @description Connection unlinked from profile */
1586
+ 204: {
1587
+ headers: {
1588
+ [name: string]: unknown;
1589
+ };
1590
+ content?: never;
1591
+ };
1592
+ /** @description Invalid request body or request param */
1593
+ 400: {
1594
+ headers: {
1595
+ [name: string]: unknown;
1596
+ };
1597
+ content: {
1598
+ "text/plain": string;
1599
+ };
1600
+ };
1601
+ /** @description Expired JWT token used or insufficient privilege */
1602
+ 401: {
1603
+ headers: {
1604
+ [name: string]: unknown;
1605
+ };
1606
+ content: {
1607
+ "text/plain": string;
1608
+ };
1609
+ };
1610
+ /** @description Forbidden */
1611
+ 403: {
1612
+ headers: {
1613
+ [name: string]: unknown;
1614
+ };
1615
+ content: {
1616
+ "text/plain": string;
1617
+ };
1618
+ };
1619
+ /** @description Result not found */
1620
+ 404: {
1621
+ headers: {
1622
+ [name: string]: unknown;
1623
+ };
1624
+ content: {
1625
+ "text/plain": string;
1626
+ };
1627
+ };
1628
+ /** @description Internal server error */
1629
+ 500: {
1630
+ headers: {
1631
+ [name: string]: unknown;
1632
+ };
1633
+ content: {
1634
+ "text/plain": string;
1635
+ };
1636
+ };
1637
+ };
1638
+ };
1639
+ }