@meshery/schemas 0.8.112 → 0.8.113
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.
- package/dist/cloudApi.d.mts +3307 -762
- package/dist/cloudApi.d.ts +3307 -762
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/component/Component.d.mts +8 -6
- package/dist/constructs/v1beta1/component/Component.d.ts +8 -6
- package/dist/constructs/v1beta1/component/ComponentSchema.d.mts +18 -7
- package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +18 -7
- package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
- package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
- package/dist/constructs/v1beta1/connection/Connection.d.mts +1088 -14
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1088 -14
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.mts +3308 -21
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +3308 -21
- package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.mts +20 -12
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +20 -12
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.mts +68 -20
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +68 -20
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +8 -8
- package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +8 -8
- package/dist/constructs/v1beta1/model/Model.d.mts +8 -6
- package/dist/constructs/v1beta1/model/Model.d.ts +8 -6
- package/dist/constructs/v1beta1/model/ModelSchema.d.mts +18 -7
- package/dist/constructs/v1beta1/model/ModelSchema.d.ts +18 -7
- package/dist/constructs/v1beta1/model/ModelSchema.js +1 -1
- package/dist/constructs/v1beta1/model/ModelSchema.mjs +1 -1
- package/dist/constructs/v1beta1/pattern/Pattern.d.mts +20 -12
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +20 -12
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.mts +68 -20
- package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +68 -20
- package/dist/constructs/v1beta1/pattern/PatternSchema.js +8 -8
- package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +8 -8
- package/dist/index.js +10 -10
- package/dist/index.mjs +10 -10
- package/dist/mesheryApi.d.mts +378 -398
- package/dist/mesheryApi.d.ts +378 -398
- package/package.json +1 -1
|
@@ -3,6 +3,48 @@
|
|
|
3
3
|
* Do not make direct changes to the file.
|
|
4
4
|
*/
|
|
5
5
|
interface paths {
|
|
6
|
+
"/api/integrations/connections": {
|
|
7
|
+
/** Returns a paginated list of connections for the authenticated user */
|
|
8
|
+
get: operations["GetConnections"];
|
|
9
|
+
/** Register a new connection with credentials */
|
|
10
|
+
post: operations["RegisterConnection"];
|
|
11
|
+
};
|
|
12
|
+
"/api/integrations/connections/{connectionKind}": {
|
|
13
|
+
/** Returns connections filtered by kind (meshery, kubernetes, etc.) */
|
|
14
|
+
get: operations["GetConnectionsByKind"];
|
|
15
|
+
};
|
|
16
|
+
"/api/integrations/connections/status": {
|
|
17
|
+
/** Returns aggregated status information for all connections */
|
|
18
|
+
get: operations["GetConnectionsStatus"];
|
|
19
|
+
};
|
|
20
|
+
"/api/integrations/connections/status/{connectionId}": {
|
|
21
|
+
/** Update the status of a specific connection */
|
|
22
|
+
put: operations["UpdateConnectionStatusByID"];
|
|
23
|
+
};
|
|
24
|
+
"/api/integrations/connections/{connectionKind}/{connectionId}": {
|
|
25
|
+
/** Returns a specific connection by kind and ID */
|
|
26
|
+
get: operations["GetConnectionByID"];
|
|
27
|
+
};
|
|
28
|
+
"/api/integrations/connections/{connectionId}": {
|
|
29
|
+
/** Update an existing connection */
|
|
30
|
+
put: operations["UpdateConnection"];
|
|
31
|
+
/** Delete a specific connection */
|
|
32
|
+
delete: operations["DeleteConnection"];
|
|
33
|
+
};
|
|
34
|
+
"/api/integrations/connections/meshery/{mesheryServerId}": {
|
|
35
|
+
/** Delete a Meshery server connection by server ID */
|
|
36
|
+
delete: operations["DeleteMesheryConnection"];
|
|
37
|
+
};
|
|
38
|
+
"/api/integrations/connections/kubernetes/{connectionId}/context": {
|
|
39
|
+
/** Get Kubernetes context for a specific connection */
|
|
40
|
+
get: operations["GetKubernetesContext"];
|
|
41
|
+
};
|
|
42
|
+
"/api/environments/{environmentId}/connections/{connectionId}": {
|
|
43
|
+
/** Associate a connection with an environment */
|
|
44
|
+
post: operations["AddConnectionToEnvironment"];
|
|
45
|
+
/** Disassociate a connection from an environment */
|
|
46
|
+
delete: operations["RemoveConnectionFromEnvironment"];
|
|
47
|
+
};
|
|
6
48
|
}
|
|
7
49
|
interface components {
|
|
8
50
|
schemas: {
|
|
@@ -10,22 +52,23 @@ interface components {
|
|
|
10
52
|
Connection: {
|
|
11
53
|
/**
|
|
12
54
|
* Format: uuid
|
|
13
|
-
* @description ID
|
|
55
|
+
* @description Connection ID
|
|
14
56
|
*/
|
|
15
57
|
id: string;
|
|
16
58
|
/** @description Connection Name */
|
|
17
59
|
name: string;
|
|
18
60
|
/**
|
|
19
61
|
* Format: uuid
|
|
20
|
-
* @description Credential ID
|
|
62
|
+
* @description Associated Credential ID
|
|
21
63
|
*/
|
|
22
64
|
credential_id?: string;
|
|
23
|
-
/** @description Connection Type */
|
|
65
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
24
66
|
type: string;
|
|
25
|
-
/** @description Connection Subtype */
|
|
67
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
26
68
|
sub_type: string;
|
|
27
|
-
/** @description Connection Kind */
|
|
69
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
28
70
|
kind: string;
|
|
71
|
+
/** @description Additional connection metadata */
|
|
29
72
|
metadata?: {
|
|
30
73
|
[key: string]: unknown;
|
|
31
74
|
};
|
|
@@ -36,7 +79,7 @@ interface components {
|
|
|
36
79
|
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
37
80
|
/**
|
|
38
81
|
* Format: uuid
|
|
39
|
-
* @description
|
|
82
|
+
* @description User ID who owns this connection
|
|
40
83
|
*/
|
|
41
84
|
user_id?: string;
|
|
42
85
|
/** Format: date-time */
|
|
@@ -45,6 +88,7 @@ interface components {
|
|
|
45
88
|
updated_at?: string;
|
|
46
89
|
/** Format: date-time */
|
|
47
90
|
deleted_at?: string;
|
|
91
|
+
/** @description Associated environments for this connection */
|
|
48
92
|
environments?: {
|
|
49
93
|
/**
|
|
50
94
|
* Format: uuid
|
|
@@ -87,27 +131,29 @@ interface components {
|
|
|
87
131
|
*/
|
|
88
132
|
schemaVersion: string;
|
|
89
133
|
};
|
|
90
|
-
/** @description Represents a page of connections with
|
|
134
|
+
/** @description Represents a page of connections with meta information about connections count */
|
|
91
135
|
ConnectionPage: {
|
|
136
|
+
/** @description List of connections on this page */
|
|
92
137
|
connections: {
|
|
93
138
|
/**
|
|
94
139
|
* Format: uuid
|
|
95
|
-
* @description ID
|
|
140
|
+
* @description Connection ID
|
|
96
141
|
*/
|
|
97
142
|
id: string;
|
|
98
143
|
/** @description Connection Name */
|
|
99
144
|
name: string;
|
|
100
145
|
/**
|
|
101
146
|
* Format: uuid
|
|
102
|
-
* @description Credential ID
|
|
147
|
+
* @description Associated Credential ID
|
|
103
148
|
*/
|
|
104
149
|
credential_id?: string;
|
|
105
|
-
/** @description Connection Type */
|
|
150
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
106
151
|
type: string;
|
|
107
|
-
/** @description Connection Subtype */
|
|
152
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
108
153
|
sub_type: string;
|
|
109
|
-
/** @description Connection Kind */
|
|
154
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
110
155
|
kind: string;
|
|
156
|
+
/** @description Additional connection metadata */
|
|
111
157
|
metadata?: {
|
|
112
158
|
[key: string]: unknown;
|
|
113
159
|
};
|
|
@@ -118,7 +164,7 @@ interface components {
|
|
|
118
164
|
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
119
165
|
/**
|
|
120
166
|
* Format: uuid
|
|
121
|
-
* @description
|
|
167
|
+
* @description User ID who owns this connection
|
|
122
168
|
*/
|
|
123
169
|
user_id?: string;
|
|
124
170
|
/** Format: date-time */
|
|
@@ -127,6 +173,7 @@ interface components {
|
|
|
127
173
|
updated_at?: string;
|
|
128
174
|
/** Format: date-time */
|
|
129
175
|
deleted_at?: string;
|
|
176
|
+
/** @description Associated environments for this connection */
|
|
130
177
|
environments?: {
|
|
131
178
|
/**
|
|
132
179
|
* Format: uuid
|
|
@@ -171,14 +218,1041 @@ interface components {
|
|
|
171
218
|
}[];
|
|
172
219
|
/** @description Total number of connections on all pages */
|
|
173
220
|
total_count: number;
|
|
174
|
-
/** @description
|
|
221
|
+
/** @description Current page number */
|
|
175
222
|
page: number;
|
|
176
223
|
/** @description Number of elements per page */
|
|
177
224
|
page_size: number;
|
|
178
225
|
};
|
|
226
|
+
/**
|
|
227
|
+
* @description Connection Status Value
|
|
228
|
+
* @enum {string}
|
|
229
|
+
*/
|
|
230
|
+
ConnectionStatusValue: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
231
|
+
/** @description Payload for creating or updating a connection */
|
|
232
|
+
ConnectionPayload: {
|
|
233
|
+
/**
|
|
234
|
+
* Format: uuid
|
|
235
|
+
* @description Connection ID
|
|
236
|
+
*/
|
|
237
|
+
id?: string;
|
|
238
|
+
/** @description Connection name */
|
|
239
|
+
name: string;
|
|
240
|
+
/** @description Connection kind */
|
|
241
|
+
kind: string;
|
|
242
|
+
/** @description Connection type */
|
|
243
|
+
type: string;
|
|
244
|
+
/** @description Connection sub-type */
|
|
245
|
+
sub_type: string;
|
|
246
|
+
/** @description Credential secret data */
|
|
247
|
+
credential_secret?: {
|
|
248
|
+
[key: string]: unknown;
|
|
249
|
+
};
|
|
250
|
+
/** @description Connection metadata */
|
|
251
|
+
metadata?: {
|
|
252
|
+
[key: string]: unknown;
|
|
253
|
+
};
|
|
254
|
+
/** @description Connection status */
|
|
255
|
+
status: string;
|
|
256
|
+
/**
|
|
257
|
+
* Format: uuid
|
|
258
|
+
* @description Associated credential ID
|
|
259
|
+
*/
|
|
260
|
+
credential_id?: string;
|
|
261
|
+
};
|
|
262
|
+
/** @description Status count information for connections */
|
|
263
|
+
ConnectionStatusInfo: {
|
|
264
|
+
/** @description Status value */
|
|
265
|
+
status: string;
|
|
266
|
+
/** @description Number of connections with this status */
|
|
267
|
+
count: number;
|
|
268
|
+
};
|
|
269
|
+
/** @description Paginated list of connection status counts */
|
|
270
|
+
ConnectionsStatusPage: {
|
|
271
|
+
/** @description Total number of status entries */
|
|
272
|
+
total_count: number;
|
|
273
|
+
/** @description Current page number */
|
|
274
|
+
page: number;
|
|
275
|
+
/** @description Number of items per page */
|
|
276
|
+
page_size: number;
|
|
277
|
+
/** @description List of status counts */
|
|
278
|
+
connections_status: {
|
|
279
|
+
/** @description Status value */
|
|
280
|
+
status: string;
|
|
281
|
+
/** @description Number of connections with this status */
|
|
282
|
+
count: number;
|
|
283
|
+
}[];
|
|
284
|
+
};
|
|
285
|
+
/** @description Meshery server instance information */
|
|
286
|
+
MesheryInstance: {
|
|
287
|
+
/** @description Instance ID */
|
|
288
|
+
id?: string;
|
|
289
|
+
/** @description Instance name */
|
|
290
|
+
name?: string;
|
|
291
|
+
/** @description Server ID */
|
|
292
|
+
server_id?: string;
|
|
293
|
+
/** @description Meshery server version */
|
|
294
|
+
server_version?: string;
|
|
295
|
+
/** @description Server location URL */
|
|
296
|
+
server_location?: string;
|
|
297
|
+
/** @description Server build SHA */
|
|
298
|
+
server_build_sha?: string;
|
|
299
|
+
/** @description Creation timestamp */
|
|
300
|
+
created_at?: string;
|
|
301
|
+
/** @description Last update timestamp */
|
|
302
|
+
updated_at?: string;
|
|
303
|
+
/** @description Deletion timestamp */
|
|
304
|
+
deleted_at?: string;
|
|
305
|
+
};
|
|
306
|
+
/** @description Paginated list of Meshery instances */
|
|
307
|
+
MesheryInstancePage: {
|
|
308
|
+
/** @description List of Meshery instances */
|
|
309
|
+
meshery_instances: {
|
|
310
|
+
/** @description Instance ID */
|
|
311
|
+
id?: string;
|
|
312
|
+
/** @description Instance name */
|
|
313
|
+
name?: string;
|
|
314
|
+
/** @description Server ID */
|
|
315
|
+
server_id?: string;
|
|
316
|
+
/** @description Meshery server version */
|
|
317
|
+
server_version?: string;
|
|
318
|
+
/** @description Server location URL */
|
|
319
|
+
server_location?: string;
|
|
320
|
+
/** @description Server build SHA */
|
|
321
|
+
server_build_sha?: string;
|
|
322
|
+
/** @description Creation timestamp */
|
|
323
|
+
created_at?: string;
|
|
324
|
+
/** @description Last update timestamp */
|
|
325
|
+
updated_at?: string;
|
|
326
|
+
/** @description Deletion timestamp */
|
|
327
|
+
deleted_at?: string;
|
|
328
|
+
}[];
|
|
329
|
+
/** @description Current page number */
|
|
330
|
+
page: number;
|
|
331
|
+
/** @description Number of items per page */
|
|
332
|
+
page_size: number;
|
|
333
|
+
/** @description Total number of instances */
|
|
334
|
+
total_count: number;
|
|
335
|
+
};
|
|
336
|
+
/** @description Meshery version compatibility check */
|
|
337
|
+
MesheryCompatibility: {
|
|
338
|
+
/** @description Meshery version string */
|
|
339
|
+
meshery_version?: string;
|
|
340
|
+
/** @description Whether to check compatibility */
|
|
341
|
+
check_compatibility?: boolean;
|
|
342
|
+
};
|
|
343
|
+
};
|
|
344
|
+
parameters: {
|
|
345
|
+
/** @description Connection ID */
|
|
346
|
+
connectionId: string;
|
|
347
|
+
/** @description Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
348
|
+
connectionKind: string;
|
|
349
|
+
/** @description Environment ID */
|
|
350
|
+
environmentId: string;
|
|
351
|
+
/** @description Page number */
|
|
352
|
+
page: number;
|
|
353
|
+
/** @description Number of items per page */
|
|
354
|
+
pagesize: number;
|
|
355
|
+
/** @description Search term */
|
|
356
|
+
search: string;
|
|
357
|
+
/** @description Sort order */
|
|
358
|
+
order: string;
|
|
179
359
|
};
|
|
180
360
|
}
|
|
181
361
|
interface operations {
|
|
362
|
+
/** Returns a paginated list of connections for the authenticated user */
|
|
363
|
+
GetConnections: {
|
|
364
|
+
parameters: {
|
|
365
|
+
query: {
|
|
366
|
+
/** Page number */
|
|
367
|
+
page?: number;
|
|
368
|
+
/** Number of items per page */
|
|
369
|
+
pagesize?: number;
|
|
370
|
+
/** Search term */
|
|
371
|
+
search?: string;
|
|
372
|
+
/** Sort order */
|
|
373
|
+
order?: string;
|
|
374
|
+
/** Filter connections */
|
|
375
|
+
filter?: string;
|
|
376
|
+
/** Filter by connection kind */
|
|
377
|
+
kind?: string[];
|
|
378
|
+
/** Filter by connection status */
|
|
379
|
+
status?: ("discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found")[];
|
|
380
|
+
};
|
|
381
|
+
};
|
|
382
|
+
responses: {
|
|
383
|
+
/** List of connections */
|
|
384
|
+
200: {
|
|
385
|
+
content: {
|
|
386
|
+
"application/json": {
|
|
387
|
+
/** @description List of connections on this page */
|
|
388
|
+
connections: {
|
|
389
|
+
/**
|
|
390
|
+
* Format: uuid
|
|
391
|
+
* @description Connection ID
|
|
392
|
+
*/
|
|
393
|
+
id: string;
|
|
394
|
+
/** @description Connection Name */
|
|
395
|
+
name: string;
|
|
396
|
+
/**
|
|
397
|
+
* Format: uuid
|
|
398
|
+
* @description Associated Credential ID
|
|
399
|
+
*/
|
|
400
|
+
credential_id?: string;
|
|
401
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
402
|
+
type: string;
|
|
403
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
404
|
+
sub_type: string;
|
|
405
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
406
|
+
kind: string;
|
|
407
|
+
/** @description Additional connection metadata */
|
|
408
|
+
metadata?: {
|
|
409
|
+
[key: string]: unknown;
|
|
410
|
+
};
|
|
411
|
+
/**
|
|
412
|
+
* @description Connection Status
|
|
413
|
+
* @enum {string}
|
|
414
|
+
*/
|
|
415
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
416
|
+
/**
|
|
417
|
+
* Format: uuid
|
|
418
|
+
* @description User ID who owns this connection
|
|
419
|
+
*/
|
|
420
|
+
user_id?: string;
|
|
421
|
+
/** Format: date-time */
|
|
422
|
+
created_at?: string;
|
|
423
|
+
/** Format: date-time */
|
|
424
|
+
updated_at?: string;
|
|
425
|
+
/** Format: date-time */
|
|
426
|
+
deleted_at?: string;
|
|
427
|
+
/** @description Associated environments for this connection */
|
|
428
|
+
environments?: {
|
|
429
|
+
/**
|
|
430
|
+
* Format: uuid
|
|
431
|
+
* @description ID
|
|
432
|
+
*/
|
|
433
|
+
id: string;
|
|
434
|
+
/** @description Environment name */
|
|
435
|
+
name: string;
|
|
436
|
+
/** @description Environment description */
|
|
437
|
+
description: string;
|
|
438
|
+
/**
|
|
439
|
+
* Format: uuid
|
|
440
|
+
* @description Environment organization ID
|
|
441
|
+
*/
|
|
442
|
+
organization_id: string;
|
|
443
|
+
/**
|
|
444
|
+
* Format: uuid
|
|
445
|
+
* @description Environment owner
|
|
446
|
+
*/
|
|
447
|
+
owner?: string;
|
|
448
|
+
/** Format: date-time */
|
|
449
|
+
created_at?: string;
|
|
450
|
+
metadata?: {
|
|
451
|
+
[key: string]: unknown;
|
|
452
|
+
};
|
|
453
|
+
/** Format: date-time */
|
|
454
|
+
updated_at?: string;
|
|
455
|
+
/** Format: date-time */
|
|
456
|
+
deleted_at?: string;
|
|
457
|
+
}[];
|
|
458
|
+
/**
|
|
459
|
+
* @description Specifies the version of the schema used for the definition.
|
|
460
|
+
* @default connections.meshery.io/v1beta1
|
|
461
|
+
* @example [
|
|
462
|
+
* "v1",
|
|
463
|
+
* "v1alpha1",
|
|
464
|
+
* "v2beta3",
|
|
465
|
+
* "v1.custom-suffix"
|
|
466
|
+
* ]
|
|
467
|
+
*/
|
|
468
|
+
schemaVersion: string;
|
|
469
|
+
}[];
|
|
470
|
+
/** @description Total number of connections on all pages */
|
|
471
|
+
total_count: number;
|
|
472
|
+
/** @description Current page number */
|
|
473
|
+
page: number;
|
|
474
|
+
/** @description Number of elements per page */
|
|
475
|
+
page_size: number;
|
|
476
|
+
};
|
|
477
|
+
};
|
|
478
|
+
};
|
|
479
|
+
/** Server error */
|
|
480
|
+
500: unknown;
|
|
481
|
+
};
|
|
482
|
+
};
|
|
483
|
+
/** Register a new connection with credentials */
|
|
484
|
+
RegisterConnection: {
|
|
485
|
+
responses: {
|
|
486
|
+
/** Connection registered successfully */
|
|
487
|
+
201: {
|
|
488
|
+
content: {
|
|
489
|
+
"application/json": {
|
|
490
|
+
/**
|
|
491
|
+
* Format: uuid
|
|
492
|
+
* @description Connection ID
|
|
493
|
+
*/
|
|
494
|
+
id: string;
|
|
495
|
+
/** @description Connection Name */
|
|
496
|
+
name: string;
|
|
497
|
+
/**
|
|
498
|
+
* Format: uuid
|
|
499
|
+
* @description Associated Credential ID
|
|
500
|
+
*/
|
|
501
|
+
credential_id?: string;
|
|
502
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
503
|
+
type: string;
|
|
504
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
505
|
+
sub_type: string;
|
|
506
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
507
|
+
kind: string;
|
|
508
|
+
/** @description Additional connection metadata */
|
|
509
|
+
metadata?: {
|
|
510
|
+
[key: string]: unknown;
|
|
511
|
+
};
|
|
512
|
+
/**
|
|
513
|
+
* @description Connection Status
|
|
514
|
+
* @enum {string}
|
|
515
|
+
*/
|
|
516
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
517
|
+
/**
|
|
518
|
+
* Format: uuid
|
|
519
|
+
* @description User ID who owns this connection
|
|
520
|
+
*/
|
|
521
|
+
user_id?: string;
|
|
522
|
+
/** Format: date-time */
|
|
523
|
+
created_at?: string;
|
|
524
|
+
/** Format: date-time */
|
|
525
|
+
updated_at?: string;
|
|
526
|
+
/** Format: date-time */
|
|
527
|
+
deleted_at?: string;
|
|
528
|
+
/** @description Associated environments for this connection */
|
|
529
|
+
environments?: {
|
|
530
|
+
/**
|
|
531
|
+
* Format: uuid
|
|
532
|
+
* @description ID
|
|
533
|
+
*/
|
|
534
|
+
id: string;
|
|
535
|
+
/** @description Environment name */
|
|
536
|
+
name: string;
|
|
537
|
+
/** @description Environment description */
|
|
538
|
+
description: string;
|
|
539
|
+
/**
|
|
540
|
+
* Format: uuid
|
|
541
|
+
* @description Environment organization ID
|
|
542
|
+
*/
|
|
543
|
+
organization_id: string;
|
|
544
|
+
/**
|
|
545
|
+
* Format: uuid
|
|
546
|
+
* @description Environment owner
|
|
547
|
+
*/
|
|
548
|
+
owner?: string;
|
|
549
|
+
/** Format: date-time */
|
|
550
|
+
created_at?: string;
|
|
551
|
+
metadata?: {
|
|
552
|
+
[key: string]: unknown;
|
|
553
|
+
};
|
|
554
|
+
/** Format: date-time */
|
|
555
|
+
updated_at?: string;
|
|
556
|
+
/** Format: date-time */
|
|
557
|
+
deleted_at?: string;
|
|
558
|
+
}[];
|
|
559
|
+
/**
|
|
560
|
+
* @description Specifies the version of the schema used for the definition.
|
|
561
|
+
* @default connections.meshery.io/v1beta1
|
|
562
|
+
* @example [
|
|
563
|
+
* "v1",
|
|
564
|
+
* "v1alpha1",
|
|
565
|
+
* "v2beta3",
|
|
566
|
+
* "v1.custom-suffix"
|
|
567
|
+
* ]
|
|
568
|
+
*/
|
|
569
|
+
schemaVersion: string;
|
|
570
|
+
};
|
|
571
|
+
};
|
|
572
|
+
};
|
|
573
|
+
/** Invalid request parameters */
|
|
574
|
+
400: unknown;
|
|
575
|
+
/** Server error */
|
|
576
|
+
500: unknown;
|
|
577
|
+
};
|
|
578
|
+
requestBody: {
|
|
579
|
+
content: {
|
|
580
|
+
"application/json": {
|
|
581
|
+
/**
|
|
582
|
+
* Format: uuid
|
|
583
|
+
* @description Connection ID
|
|
584
|
+
*/
|
|
585
|
+
id?: string;
|
|
586
|
+
/** @description Connection name */
|
|
587
|
+
name: string;
|
|
588
|
+
/** @description Connection kind */
|
|
589
|
+
kind: string;
|
|
590
|
+
/** @description Connection type */
|
|
591
|
+
type: string;
|
|
592
|
+
/** @description Connection sub-type */
|
|
593
|
+
sub_type: string;
|
|
594
|
+
/** @description Credential secret data */
|
|
595
|
+
credential_secret?: {
|
|
596
|
+
[key: string]: unknown;
|
|
597
|
+
};
|
|
598
|
+
/** @description Connection metadata */
|
|
599
|
+
metadata?: {
|
|
600
|
+
[key: string]: unknown;
|
|
601
|
+
};
|
|
602
|
+
/** @description Connection status */
|
|
603
|
+
status: string;
|
|
604
|
+
/**
|
|
605
|
+
* Format: uuid
|
|
606
|
+
* @description Associated credential ID
|
|
607
|
+
*/
|
|
608
|
+
credential_id?: string;
|
|
609
|
+
};
|
|
610
|
+
};
|
|
611
|
+
};
|
|
612
|
+
};
|
|
613
|
+
/** Returns connections filtered by kind (meshery, kubernetes, etc.) */
|
|
614
|
+
GetConnectionsByKind: {
|
|
615
|
+
parameters: {
|
|
616
|
+
path: {
|
|
617
|
+
/** Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
618
|
+
connectionKind: string;
|
|
619
|
+
};
|
|
620
|
+
query: {
|
|
621
|
+
/** Page number */
|
|
622
|
+
page?: number;
|
|
623
|
+
/** Number of items per page */
|
|
624
|
+
pagesize?: number;
|
|
625
|
+
/** Search term */
|
|
626
|
+
search?: string;
|
|
627
|
+
/** Sort order */
|
|
628
|
+
order?: string;
|
|
629
|
+
/** Filter by connection status */
|
|
630
|
+
status?: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
631
|
+
/** Filter by Meshery instance ID (for kubernetes connections) */
|
|
632
|
+
meshery_instance_id?: string;
|
|
633
|
+
/** Include credentials in response (for kubernetes connections) */
|
|
634
|
+
with_credentials?: boolean;
|
|
635
|
+
};
|
|
636
|
+
};
|
|
637
|
+
responses: {
|
|
638
|
+
/** List of connections by kind */
|
|
639
|
+
200: {
|
|
640
|
+
content: {
|
|
641
|
+
"application/json": {
|
|
642
|
+
/** @description List of connections on this page */
|
|
643
|
+
connections: {
|
|
644
|
+
/**
|
|
645
|
+
* Format: uuid
|
|
646
|
+
* @description Connection ID
|
|
647
|
+
*/
|
|
648
|
+
id: string;
|
|
649
|
+
/** @description Connection Name */
|
|
650
|
+
name: string;
|
|
651
|
+
/**
|
|
652
|
+
* Format: uuid
|
|
653
|
+
* @description Associated Credential ID
|
|
654
|
+
*/
|
|
655
|
+
credential_id?: string;
|
|
656
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
657
|
+
type: string;
|
|
658
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
659
|
+
sub_type: string;
|
|
660
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
661
|
+
kind: string;
|
|
662
|
+
/** @description Additional connection metadata */
|
|
663
|
+
metadata?: {
|
|
664
|
+
[key: string]: unknown;
|
|
665
|
+
};
|
|
666
|
+
/**
|
|
667
|
+
* @description Connection Status
|
|
668
|
+
* @enum {string}
|
|
669
|
+
*/
|
|
670
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
671
|
+
/**
|
|
672
|
+
* Format: uuid
|
|
673
|
+
* @description User ID who owns this connection
|
|
674
|
+
*/
|
|
675
|
+
user_id?: string;
|
|
676
|
+
/** Format: date-time */
|
|
677
|
+
created_at?: string;
|
|
678
|
+
/** Format: date-time */
|
|
679
|
+
updated_at?: string;
|
|
680
|
+
/** Format: date-time */
|
|
681
|
+
deleted_at?: string;
|
|
682
|
+
/** @description Associated environments for this connection */
|
|
683
|
+
environments?: {
|
|
684
|
+
/**
|
|
685
|
+
* Format: uuid
|
|
686
|
+
* @description ID
|
|
687
|
+
*/
|
|
688
|
+
id: string;
|
|
689
|
+
/** @description Environment name */
|
|
690
|
+
name: string;
|
|
691
|
+
/** @description Environment description */
|
|
692
|
+
description: string;
|
|
693
|
+
/**
|
|
694
|
+
* Format: uuid
|
|
695
|
+
* @description Environment organization ID
|
|
696
|
+
*/
|
|
697
|
+
organization_id: string;
|
|
698
|
+
/**
|
|
699
|
+
* Format: uuid
|
|
700
|
+
* @description Environment owner
|
|
701
|
+
*/
|
|
702
|
+
owner?: string;
|
|
703
|
+
/** Format: date-time */
|
|
704
|
+
created_at?: string;
|
|
705
|
+
metadata?: {
|
|
706
|
+
[key: string]: unknown;
|
|
707
|
+
};
|
|
708
|
+
/** Format: date-time */
|
|
709
|
+
updated_at?: string;
|
|
710
|
+
/** Format: date-time */
|
|
711
|
+
deleted_at?: string;
|
|
712
|
+
}[];
|
|
713
|
+
/**
|
|
714
|
+
* @description Specifies the version of the schema used for the definition.
|
|
715
|
+
* @default connections.meshery.io/v1beta1
|
|
716
|
+
* @example [
|
|
717
|
+
* "v1",
|
|
718
|
+
* "v1alpha1",
|
|
719
|
+
* "v2beta3",
|
|
720
|
+
* "v1.custom-suffix"
|
|
721
|
+
* ]
|
|
722
|
+
*/
|
|
723
|
+
schemaVersion: string;
|
|
724
|
+
}[];
|
|
725
|
+
/** @description Total number of connections on all pages */
|
|
726
|
+
total_count: number;
|
|
727
|
+
/** @description Current page number */
|
|
728
|
+
page: number;
|
|
729
|
+
/** @description Number of elements per page */
|
|
730
|
+
page_size: number;
|
|
731
|
+
} | {
|
|
732
|
+
/** @description List of Meshery instances */
|
|
733
|
+
meshery_instances: {
|
|
734
|
+
/** @description Instance ID */
|
|
735
|
+
id?: string;
|
|
736
|
+
/** @description Instance name */
|
|
737
|
+
name?: string;
|
|
738
|
+
/** @description Server ID */
|
|
739
|
+
server_id?: string;
|
|
740
|
+
/** @description Meshery server version */
|
|
741
|
+
server_version?: string;
|
|
742
|
+
/** @description Server location URL */
|
|
743
|
+
server_location?: string;
|
|
744
|
+
/** @description Server build SHA */
|
|
745
|
+
server_build_sha?: string;
|
|
746
|
+
/** @description Creation timestamp */
|
|
747
|
+
created_at?: string;
|
|
748
|
+
/** @description Last update timestamp */
|
|
749
|
+
updated_at?: string;
|
|
750
|
+
/** @description Deletion timestamp */
|
|
751
|
+
deleted_at?: string;
|
|
752
|
+
}[];
|
|
753
|
+
/** @description Current page number */
|
|
754
|
+
page: number;
|
|
755
|
+
/** @description Number of items per page */
|
|
756
|
+
page_size: number;
|
|
757
|
+
/** @description Total number of instances */
|
|
758
|
+
total_count: number;
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
/** Server error */
|
|
763
|
+
500: unknown;
|
|
764
|
+
};
|
|
765
|
+
};
|
|
766
|
+
/** Returns aggregated status information for all connections */
|
|
767
|
+
GetConnectionsStatus: {
|
|
768
|
+
parameters: {
|
|
769
|
+
query: {
|
|
770
|
+
/** Page number */
|
|
771
|
+
page?: number;
|
|
772
|
+
/** Number of items per page */
|
|
773
|
+
pagesize?: number;
|
|
774
|
+
/** Search term */
|
|
775
|
+
search?: string;
|
|
776
|
+
/** Sort order */
|
|
777
|
+
order?: string;
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
responses: {
|
|
781
|
+
/** Connection status summary */
|
|
782
|
+
200: {
|
|
783
|
+
content: {
|
|
784
|
+
"application/json": {
|
|
785
|
+
/** @description Total number of status entries */
|
|
786
|
+
total_count: number;
|
|
787
|
+
/** @description Current page number */
|
|
788
|
+
page: number;
|
|
789
|
+
/** @description Number of items per page */
|
|
790
|
+
page_size: number;
|
|
791
|
+
/** @description List of status counts */
|
|
792
|
+
connections_status: {
|
|
793
|
+
/** @description Status value */
|
|
794
|
+
status: string;
|
|
795
|
+
/** @description Number of connections with this status */
|
|
796
|
+
count: number;
|
|
797
|
+
}[];
|
|
798
|
+
};
|
|
799
|
+
};
|
|
800
|
+
};
|
|
801
|
+
/** Server error */
|
|
802
|
+
500: unknown;
|
|
803
|
+
};
|
|
804
|
+
};
|
|
805
|
+
/** Update the status of a specific connection */
|
|
806
|
+
UpdateConnectionStatusByID: {
|
|
807
|
+
parameters: {
|
|
808
|
+
path: {
|
|
809
|
+
/** Connection ID */
|
|
810
|
+
connectionId: string;
|
|
811
|
+
};
|
|
812
|
+
};
|
|
813
|
+
responses: {
|
|
814
|
+
/** Connection status updated successfully */
|
|
815
|
+
200: {
|
|
816
|
+
content: {
|
|
817
|
+
"application/json": {
|
|
818
|
+
/** @description List of connections on this page */
|
|
819
|
+
connections: {
|
|
820
|
+
/**
|
|
821
|
+
* Format: uuid
|
|
822
|
+
* @description Connection ID
|
|
823
|
+
*/
|
|
824
|
+
id: string;
|
|
825
|
+
/** @description Connection Name */
|
|
826
|
+
name: string;
|
|
827
|
+
/**
|
|
828
|
+
* Format: uuid
|
|
829
|
+
* @description Associated Credential ID
|
|
830
|
+
*/
|
|
831
|
+
credential_id?: string;
|
|
832
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
833
|
+
type: string;
|
|
834
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
835
|
+
sub_type: string;
|
|
836
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
837
|
+
kind: string;
|
|
838
|
+
/** @description Additional connection metadata */
|
|
839
|
+
metadata?: {
|
|
840
|
+
[key: string]: unknown;
|
|
841
|
+
};
|
|
842
|
+
/**
|
|
843
|
+
* @description Connection Status
|
|
844
|
+
* @enum {string}
|
|
845
|
+
*/
|
|
846
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
847
|
+
/**
|
|
848
|
+
* Format: uuid
|
|
849
|
+
* @description User ID who owns this connection
|
|
850
|
+
*/
|
|
851
|
+
user_id?: string;
|
|
852
|
+
/** Format: date-time */
|
|
853
|
+
created_at?: string;
|
|
854
|
+
/** Format: date-time */
|
|
855
|
+
updated_at?: string;
|
|
856
|
+
/** Format: date-time */
|
|
857
|
+
deleted_at?: string;
|
|
858
|
+
/** @description Associated environments for this connection */
|
|
859
|
+
environments?: {
|
|
860
|
+
/**
|
|
861
|
+
* Format: uuid
|
|
862
|
+
* @description ID
|
|
863
|
+
*/
|
|
864
|
+
id: string;
|
|
865
|
+
/** @description Environment name */
|
|
866
|
+
name: string;
|
|
867
|
+
/** @description Environment description */
|
|
868
|
+
description: string;
|
|
869
|
+
/**
|
|
870
|
+
* Format: uuid
|
|
871
|
+
* @description Environment organization ID
|
|
872
|
+
*/
|
|
873
|
+
organization_id: string;
|
|
874
|
+
/**
|
|
875
|
+
* Format: uuid
|
|
876
|
+
* @description Environment owner
|
|
877
|
+
*/
|
|
878
|
+
owner?: string;
|
|
879
|
+
/** Format: date-time */
|
|
880
|
+
created_at?: string;
|
|
881
|
+
metadata?: {
|
|
882
|
+
[key: string]: unknown;
|
|
883
|
+
};
|
|
884
|
+
/** Format: date-time */
|
|
885
|
+
updated_at?: string;
|
|
886
|
+
/** Format: date-time */
|
|
887
|
+
deleted_at?: string;
|
|
888
|
+
}[];
|
|
889
|
+
/**
|
|
890
|
+
* @description Specifies the version of the schema used for the definition.
|
|
891
|
+
* @default connections.meshery.io/v1beta1
|
|
892
|
+
* @example [
|
|
893
|
+
* "v1",
|
|
894
|
+
* "v1alpha1",
|
|
895
|
+
* "v2beta3",
|
|
896
|
+
* "v1.custom-suffix"
|
|
897
|
+
* ]
|
|
898
|
+
*/
|
|
899
|
+
schemaVersion: string;
|
|
900
|
+
}[];
|
|
901
|
+
/** @description Total number of connections on all pages */
|
|
902
|
+
total_count: number;
|
|
903
|
+
/** @description Current page number */
|
|
904
|
+
page: number;
|
|
905
|
+
/** @description Number of elements per page */
|
|
906
|
+
page_size: number;
|
|
907
|
+
};
|
|
908
|
+
};
|
|
909
|
+
};
|
|
910
|
+
/** Connection not found */
|
|
911
|
+
404: unknown;
|
|
912
|
+
/** Server error */
|
|
913
|
+
500: unknown;
|
|
914
|
+
};
|
|
915
|
+
requestBody: {
|
|
916
|
+
content: {
|
|
917
|
+
"text/plain": "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
918
|
+
};
|
|
919
|
+
};
|
|
920
|
+
};
|
|
921
|
+
/** Returns a specific connection by kind and ID */
|
|
922
|
+
GetConnectionByID: {
|
|
923
|
+
parameters: {
|
|
924
|
+
path: {
|
|
925
|
+
/** Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
926
|
+
connectionKind: string;
|
|
927
|
+
/** Connection ID */
|
|
928
|
+
connectionId: string;
|
|
929
|
+
};
|
|
930
|
+
};
|
|
931
|
+
responses: {
|
|
932
|
+
/** Connection details */
|
|
933
|
+
200: {
|
|
934
|
+
content: {
|
|
935
|
+
"application/json": {
|
|
936
|
+
/**
|
|
937
|
+
* Format: uuid
|
|
938
|
+
* @description Connection ID
|
|
939
|
+
*/
|
|
940
|
+
id: string;
|
|
941
|
+
/** @description Connection Name */
|
|
942
|
+
name: string;
|
|
943
|
+
/**
|
|
944
|
+
* Format: uuid
|
|
945
|
+
* @description Associated Credential ID
|
|
946
|
+
*/
|
|
947
|
+
credential_id?: string;
|
|
948
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
949
|
+
type: string;
|
|
950
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
951
|
+
sub_type: string;
|
|
952
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
953
|
+
kind: string;
|
|
954
|
+
/** @description Additional connection metadata */
|
|
955
|
+
metadata?: {
|
|
956
|
+
[key: string]: unknown;
|
|
957
|
+
};
|
|
958
|
+
/**
|
|
959
|
+
* @description Connection Status
|
|
960
|
+
* @enum {string}
|
|
961
|
+
*/
|
|
962
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
963
|
+
/**
|
|
964
|
+
* Format: uuid
|
|
965
|
+
* @description User ID who owns this connection
|
|
966
|
+
*/
|
|
967
|
+
user_id?: string;
|
|
968
|
+
/** Format: date-time */
|
|
969
|
+
created_at?: string;
|
|
970
|
+
/** Format: date-time */
|
|
971
|
+
updated_at?: string;
|
|
972
|
+
/** Format: date-time */
|
|
973
|
+
deleted_at?: string;
|
|
974
|
+
/** @description Associated environments for this connection */
|
|
975
|
+
environments?: {
|
|
976
|
+
/**
|
|
977
|
+
* Format: uuid
|
|
978
|
+
* @description ID
|
|
979
|
+
*/
|
|
980
|
+
id: string;
|
|
981
|
+
/** @description Environment name */
|
|
982
|
+
name: string;
|
|
983
|
+
/** @description Environment description */
|
|
984
|
+
description: string;
|
|
985
|
+
/**
|
|
986
|
+
* Format: uuid
|
|
987
|
+
* @description Environment organization ID
|
|
988
|
+
*/
|
|
989
|
+
organization_id: string;
|
|
990
|
+
/**
|
|
991
|
+
* Format: uuid
|
|
992
|
+
* @description Environment owner
|
|
993
|
+
*/
|
|
994
|
+
owner?: string;
|
|
995
|
+
/** Format: date-time */
|
|
996
|
+
created_at?: string;
|
|
997
|
+
metadata?: {
|
|
998
|
+
[key: string]: unknown;
|
|
999
|
+
};
|
|
1000
|
+
/** Format: date-time */
|
|
1001
|
+
updated_at?: string;
|
|
1002
|
+
/** Format: date-time */
|
|
1003
|
+
deleted_at?: string;
|
|
1004
|
+
}[];
|
|
1005
|
+
/**
|
|
1006
|
+
* @description Specifies the version of the schema used for the definition.
|
|
1007
|
+
* @default connections.meshery.io/v1beta1
|
|
1008
|
+
* @example [
|
|
1009
|
+
* "v1",
|
|
1010
|
+
* "v1alpha1",
|
|
1011
|
+
* "v2beta3",
|
|
1012
|
+
* "v1.custom-suffix"
|
|
1013
|
+
* ]
|
|
1014
|
+
*/
|
|
1015
|
+
schemaVersion: string;
|
|
1016
|
+
};
|
|
1017
|
+
};
|
|
1018
|
+
};
|
|
1019
|
+
/** Connection not found */
|
|
1020
|
+
404: unknown;
|
|
1021
|
+
/** Server error */
|
|
1022
|
+
500: unknown;
|
|
1023
|
+
};
|
|
1024
|
+
};
|
|
1025
|
+
/** Update an existing connection */
|
|
1026
|
+
UpdateConnection: {
|
|
1027
|
+
parameters: {
|
|
1028
|
+
path: {
|
|
1029
|
+
/** Connection ID */
|
|
1030
|
+
connectionId: string;
|
|
1031
|
+
};
|
|
1032
|
+
};
|
|
1033
|
+
responses: {
|
|
1034
|
+
/** Connection updated successfully */
|
|
1035
|
+
200: {
|
|
1036
|
+
content: {
|
|
1037
|
+
"application/json": {
|
|
1038
|
+
/**
|
|
1039
|
+
* Format: uuid
|
|
1040
|
+
* @description Connection ID
|
|
1041
|
+
*/
|
|
1042
|
+
id: string;
|
|
1043
|
+
/** @description Connection Name */
|
|
1044
|
+
name: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* Format: uuid
|
|
1047
|
+
* @description Associated Credential ID
|
|
1048
|
+
*/
|
|
1049
|
+
credential_id?: string;
|
|
1050
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
1051
|
+
type: string;
|
|
1052
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
1053
|
+
sub_type: string;
|
|
1054
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
1055
|
+
kind: string;
|
|
1056
|
+
/** @description Additional connection metadata */
|
|
1057
|
+
metadata?: {
|
|
1058
|
+
[key: string]: unknown;
|
|
1059
|
+
};
|
|
1060
|
+
/**
|
|
1061
|
+
* @description Connection Status
|
|
1062
|
+
* @enum {string}
|
|
1063
|
+
*/
|
|
1064
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
1065
|
+
/**
|
|
1066
|
+
* Format: uuid
|
|
1067
|
+
* @description User ID who owns this connection
|
|
1068
|
+
*/
|
|
1069
|
+
user_id?: string;
|
|
1070
|
+
/** Format: date-time */
|
|
1071
|
+
created_at?: string;
|
|
1072
|
+
/** Format: date-time */
|
|
1073
|
+
updated_at?: string;
|
|
1074
|
+
/** Format: date-time */
|
|
1075
|
+
deleted_at?: string;
|
|
1076
|
+
/** @description Associated environments for this connection */
|
|
1077
|
+
environments?: {
|
|
1078
|
+
/**
|
|
1079
|
+
* Format: uuid
|
|
1080
|
+
* @description ID
|
|
1081
|
+
*/
|
|
1082
|
+
id: string;
|
|
1083
|
+
/** @description Environment name */
|
|
1084
|
+
name: string;
|
|
1085
|
+
/** @description Environment description */
|
|
1086
|
+
description: string;
|
|
1087
|
+
/**
|
|
1088
|
+
* Format: uuid
|
|
1089
|
+
* @description Environment organization ID
|
|
1090
|
+
*/
|
|
1091
|
+
organization_id: string;
|
|
1092
|
+
/**
|
|
1093
|
+
* Format: uuid
|
|
1094
|
+
* @description Environment owner
|
|
1095
|
+
*/
|
|
1096
|
+
owner?: string;
|
|
1097
|
+
/** Format: date-time */
|
|
1098
|
+
created_at?: string;
|
|
1099
|
+
metadata?: {
|
|
1100
|
+
[key: string]: unknown;
|
|
1101
|
+
};
|
|
1102
|
+
/** Format: date-time */
|
|
1103
|
+
updated_at?: string;
|
|
1104
|
+
/** Format: date-time */
|
|
1105
|
+
deleted_at?: string;
|
|
1106
|
+
}[];
|
|
1107
|
+
/**
|
|
1108
|
+
* @description Specifies the version of the schema used for the definition.
|
|
1109
|
+
* @default connections.meshery.io/v1beta1
|
|
1110
|
+
* @example [
|
|
1111
|
+
* "v1",
|
|
1112
|
+
* "v1alpha1",
|
|
1113
|
+
* "v2beta3",
|
|
1114
|
+
* "v1.custom-suffix"
|
|
1115
|
+
* ]
|
|
1116
|
+
*/
|
|
1117
|
+
schemaVersion: string;
|
|
1118
|
+
};
|
|
1119
|
+
};
|
|
1120
|
+
};
|
|
1121
|
+
/** Connection not found */
|
|
1122
|
+
404: unknown;
|
|
1123
|
+
/** Server error */
|
|
1124
|
+
500: unknown;
|
|
1125
|
+
};
|
|
1126
|
+
requestBody: {
|
|
1127
|
+
content: {
|
|
1128
|
+
"application/json": {
|
|
1129
|
+
/**
|
|
1130
|
+
* Format: uuid
|
|
1131
|
+
* @description Connection ID
|
|
1132
|
+
*/
|
|
1133
|
+
id?: string;
|
|
1134
|
+
/** @description Connection name */
|
|
1135
|
+
name: string;
|
|
1136
|
+
/** @description Connection kind */
|
|
1137
|
+
kind: string;
|
|
1138
|
+
/** @description Connection type */
|
|
1139
|
+
type: string;
|
|
1140
|
+
/** @description Connection sub-type */
|
|
1141
|
+
sub_type: string;
|
|
1142
|
+
/** @description Credential secret data */
|
|
1143
|
+
credential_secret?: {
|
|
1144
|
+
[key: string]: unknown;
|
|
1145
|
+
};
|
|
1146
|
+
/** @description Connection metadata */
|
|
1147
|
+
metadata?: {
|
|
1148
|
+
[key: string]: unknown;
|
|
1149
|
+
};
|
|
1150
|
+
/** @description Connection status */
|
|
1151
|
+
status: string;
|
|
1152
|
+
/**
|
|
1153
|
+
* Format: uuid
|
|
1154
|
+
* @description Associated credential ID
|
|
1155
|
+
*/
|
|
1156
|
+
credential_id?: string;
|
|
1157
|
+
};
|
|
1158
|
+
};
|
|
1159
|
+
};
|
|
1160
|
+
};
|
|
1161
|
+
/** Delete a specific connection */
|
|
1162
|
+
DeleteConnection: {
|
|
1163
|
+
parameters: {
|
|
1164
|
+
path: {
|
|
1165
|
+
/** Connection ID */
|
|
1166
|
+
connectionId: string;
|
|
1167
|
+
};
|
|
1168
|
+
};
|
|
1169
|
+
responses: {
|
|
1170
|
+
/** Connection deleted successfully */
|
|
1171
|
+
204: never;
|
|
1172
|
+
/** Connection not found */
|
|
1173
|
+
404: unknown;
|
|
1174
|
+
/** Server error */
|
|
1175
|
+
500: unknown;
|
|
1176
|
+
};
|
|
1177
|
+
};
|
|
1178
|
+
/** Delete a Meshery server connection by server ID */
|
|
1179
|
+
DeleteMesheryConnection: {
|
|
1180
|
+
parameters: {
|
|
1181
|
+
path: {
|
|
1182
|
+
/** Meshery server ID */
|
|
1183
|
+
mesheryServerId: string;
|
|
1184
|
+
};
|
|
1185
|
+
};
|
|
1186
|
+
responses: {
|
|
1187
|
+
/** Meshery connection deleted successfully */
|
|
1188
|
+
204: never;
|
|
1189
|
+
/** Connection not found */
|
|
1190
|
+
404: unknown;
|
|
1191
|
+
/** Server error */
|
|
1192
|
+
500: unknown;
|
|
1193
|
+
};
|
|
1194
|
+
};
|
|
1195
|
+
/** Get Kubernetes context for a specific connection */
|
|
1196
|
+
GetKubernetesContext: {
|
|
1197
|
+
parameters: {
|
|
1198
|
+
path: {
|
|
1199
|
+
/** Connection ID */
|
|
1200
|
+
connectionId: string;
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
responses: {
|
|
1204
|
+
/** Kubernetes context */
|
|
1205
|
+
200: {
|
|
1206
|
+
content: {
|
|
1207
|
+
"application/json": {
|
|
1208
|
+
[key: string]: unknown;
|
|
1209
|
+
};
|
|
1210
|
+
};
|
|
1211
|
+
};
|
|
1212
|
+
/** Connection not found */
|
|
1213
|
+
404: unknown;
|
|
1214
|
+
/** Server error */
|
|
1215
|
+
500: unknown;
|
|
1216
|
+
};
|
|
1217
|
+
};
|
|
1218
|
+
/** Associate a connection with an environment */
|
|
1219
|
+
AddConnectionToEnvironment: {
|
|
1220
|
+
parameters: {
|
|
1221
|
+
path: {
|
|
1222
|
+
/** Environment ID */
|
|
1223
|
+
environmentId: string;
|
|
1224
|
+
/** Connection ID */
|
|
1225
|
+
connectionId: string;
|
|
1226
|
+
};
|
|
1227
|
+
};
|
|
1228
|
+
responses: {
|
|
1229
|
+
/** Connection added to environment successfully */
|
|
1230
|
+
200: unknown;
|
|
1231
|
+
/** Connection or environment not found */
|
|
1232
|
+
404: unknown;
|
|
1233
|
+
/** Server error */
|
|
1234
|
+
500: unknown;
|
|
1235
|
+
};
|
|
1236
|
+
};
|
|
1237
|
+
/** Disassociate a connection from an environment */
|
|
1238
|
+
RemoveConnectionFromEnvironment: {
|
|
1239
|
+
parameters: {
|
|
1240
|
+
path: {
|
|
1241
|
+
/** Environment ID */
|
|
1242
|
+
environmentId: string;
|
|
1243
|
+
/** Connection ID */
|
|
1244
|
+
connectionId: string;
|
|
1245
|
+
};
|
|
1246
|
+
};
|
|
1247
|
+
responses: {
|
|
1248
|
+
/** Connection removed from environment successfully */
|
|
1249
|
+
204: never;
|
|
1250
|
+
/** Connection or environment not found */
|
|
1251
|
+
404: unknown;
|
|
1252
|
+
/** Server error */
|
|
1253
|
+
500: unknown;
|
|
1254
|
+
};
|
|
1255
|
+
};
|
|
182
1256
|
}
|
|
183
1257
|
interface external {
|
|
184
1258
|
}
|