@meshery/schemas 1.2.22 → 1.3.0
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 +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,565 +4,169 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
/** Returns a specific connection by its ID */
|
|
15
|
-
get: operations["getConnectionById"];
|
|
16
|
-
/** Update an existing connection */
|
|
17
|
-
put: operations["updateConnection"];
|
|
18
|
-
/** Delete a specific connection */
|
|
19
|
-
delete: operations["deleteConnection"];
|
|
20
|
-
};
|
|
21
|
-
"/api/integrations/connections/meshery/{mesheryServerId}": {
|
|
22
|
-
/** Delete a Meshery server connection by server ID */
|
|
23
|
-
delete: operations["deleteMesheryConnection"];
|
|
24
|
-
};
|
|
25
|
-
"/api/integrations/connections/kubernetes/{connectionId}/context": {
|
|
26
|
-
/** Get Kubernetes context for a specific connection */
|
|
27
|
-
get: operations["getKubernetesContext"];
|
|
28
|
-
};
|
|
29
|
-
"/api/environments/{environmentId}/connections/{connectionId}": {
|
|
30
|
-
/** Associate a connection with an environment */
|
|
31
|
-
post: operations["addConnectionToEnvironment"];
|
|
32
|
-
/** Disassociate a connection from an environment */
|
|
33
|
-
delete: operations["removeConnectionFromEnvironment"];
|
|
34
|
-
};
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
export interface components {
|
|
38
|
-
schemas: {
|
|
39
|
-
/** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
|
|
40
|
-
Connection: {
|
|
41
|
-
/**
|
|
42
|
-
* Format: uuid
|
|
43
|
-
* @description Connection ID
|
|
44
|
-
*/
|
|
45
|
-
id: string;
|
|
46
|
-
/** @description Connection Name */
|
|
47
|
-
name: string;
|
|
48
|
-
/**
|
|
49
|
-
* Format: uuid
|
|
50
|
-
* @description Associated Credential ID
|
|
51
|
-
*/
|
|
52
|
-
credential_id?: string;
|
|
53
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
54
|
-
type: string;
|
|
55
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
56
|
-
sub_type: string;
|
|
57
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
58
|
-
kind: string;
|
|
59
|
-
/** @description Additional connection metadata */
|
|
60
|
-
metadata?: { [key: string]: unknown };
|
|
61
|
-
/**
|
|
62
|
-
* @description Connection Status
|
|
63
|
-
* @enum {string}
|
|
64
|
-
*/
|
|
65
|
-
status:
|
|
66
|
-
| "discovered"
|
|
67
|
-
| "registered"
|
|
68
|
-
| "connected"
|
|
69
|
-
| "ignored"
|
|
70
|
-
| "maintenance"
|
|
71
|
-
| "disconnected"
|
|
72
|
-
| "deleted"
|
|
73
|
-
| "not found";
|
|
74
|
-
/**
|
|
75
|
-
* Format: uuid
|
|
76
|
-
* @description User ID who owns this connection
|
|
77
|
-
*/
|
|
78
|
-
user_id?: string;
|
|
79
|
-
/** Format: date-time */
|
|
80
|
-
created_at?: string;
|
|
81
|
-
/** Format: date-time */
|
|
82
|
-
updated_at?: string;
|
|
83
|
-
/**
|
|
84
|
-
* Format: date-time
|
|
85
|
-
* @description SQL null Timestamp to handle null values of time.
|
|
86
|
-
*/
|
|
87
|
-
deleted_at?: string;
|
|
88
|
-
/** @description Associated environments for this connection */
|
|
89
|
-
environments?: {
|
|
90
|
-
/**
|
|
91
|
-
* Format: uuid
|
|
92
|
-
* @description ID
|
|
93
|
-
*/
|
|
94
|
-
id: string;
|
|
95
|
-
/**
|
|
96
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
97
|
-
* @default environments.meshery.io/v1beta1
|
|
98
|
-
* @example [
|
|
99
|
-
* "v1",
|
|
100
|
-
* "v1alpha1",
|
|
101
|
-
* "v2beta3",
|
|
102
|
-
* "v1.custom-suffix",
|
|
103
|
-
* "models.meshery.io/v1beta1",
|
|
104
|
-
* "capability.meshery.io/v1alpha1"
|
|
105
|
-
* ]
|
|
106
|
-
*/
|
|
107
|
-
schemaVersion: string;
|
|
108
|
-
/** @description Environment name */
|
|
109
|
-
name: string;
|
|
110
|
-
/** @description Environment description */
|
|
111
|
-
description: string;
|
|
112
|
-
/**
|
|
113
|
-
* Format: uuid
|
|
114
|
-
* @description Environment organization ID
|
|
115
|
-
*/
|
|
116
|
-
organization_id: string;
|
|
117
|
-
/**
|
|
118
|
-
* Format: uuid
|
|
119
|
-
* @description Environment owner
|
|
120
|
-
*/
|
|
121
|
-
owner?: string;
|
|
122
|
-
/**
|
|
123
|
-
* Format: date-time
|
|
124
|
-
* @description Timestamp when the resource was created.
|
|
125
|
-
*/
|
|
126
|
-
created_at?: string;
|
|
127
|
-
/** @description Additional metadata associated with the environment. */
|
|
128
|
-
metadata?: { [key: string]: unknown };
|
|
7
|
+
"/api/integrations/connections": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
129
14
|
/**
|
|
130
|
-
*
|
|
131
|
-
* @description
|
|
15
|
+
* Get all connections
|
|
16
|
+
* @description Returns a paginated list of connections for the authenticated user with filtering, sorting and pagination support
|
|
132
17
|
*/
|
|
133
|
-
|
|
18
|
+
get: operations["getConnections"];
|
|
19
|
+
put?: never;
|
|
134
20
|
/**
|
|
135
|
-
*
|
|
136
|
-
* @description
|
|
21
|
+
* Register a new connection
|
|
22
|
+
* @description Register a new connection with credentials
|
|
137
23
|
*/
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
* "v1",
|
|
145
|
-
* "v1alpha1",
|
|
146
|
-
* "v2beta3",
|
|
147
|
-
* "v1.custom-suffix",
|
|
148
|
-
* "models.meshery.io/v1beta1",
|
|
149
|
-
* "capability.meshery.io/v1alpha1"
|
|
150
|
-
* ]
|
|
151
|
-
*/
|
|
152
|
-
schemaVersion: string;
|
|
24
|
+
post: operations["registerConnection"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
153
30
|
};
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
*/
|
|
162
|
-
id: string;
|
|
163
|
-
/** @description Connection Name */
|
|
164
|
-
name: string;
|
|
165
|
-
/**
|
|
166
|
-
* Format: uuid
|
|
167
|
-
* @description Associated Credential ID
|
|
168
|
-
*/
|
|
169
|
-
credential_id?: string;
|
|
170
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
171
|
-
type: string;
|
|
172
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
173
|
-
sub_type: string;
|
|
174
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
175
|
-
kind: string;
|
|
176
|
-
/** @description Additional connection metadata */
|
|
177
|
-
metadata?: { [key: string]: unknown };
|
|
178
|
-
/**
|
|
179
|
-
* @description Connection Status
|
|
180
|
-
* @enum {string}
|
|
181
|
-
*/
|
|
182
|
-
status:
|
|
183
|
-
| "discovered"
|
|
184
|
-
| "registered"
|
|
185
|
-
| "connected"
|
|
186
|
-
| "ignored"
|
|
187
|
-
| "maintenance"
|
|
188
|
-
| "disconnected"
|
|
189
|
-
| "deleted"
|
|
190
|
-
| "not found";
|
|
31
|
+
"/api/integrations/connections/{connectionId}": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
37
|
+
};
|
|
191
38
|
/**
|
|
192
|
-
*
|
|
193
|
-
* @description
|
|
39
|
+
* Get connection by ID
|
|
40
|
+
* @description Returns a specific connection by its ID
|
|
194
41
|
*/
|
|
195
|
-
|
|
196
|
-
/** Format: date-time */
|
|
197
|
-
created_at?: string;
|
|
198
|
-
/** Format: date-time */
|
|
199
|
-
updated_at?: string;
|
|
42
|
+
get: operations["getConnectionById"];
|
|
200
43
|
/**
|
|
201
|
-
*
|
|
202
|
-
* @description
|
|
44
|
+
* Update a connection
|
|
45
|
+
* @description Update an existing connection
|
|
203
46
|
*/
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
environments?: {
|
|
207
|
-
/**
|
|
208
|
-
* Format: uuid
|
|
209
|
-
* @description ID
|
|
210
|
-
*/
|
|
211
|
-
id: string;
|
|
212
|
-
/**
|
|
213
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
214
|
-
* @default environments.meshery.io/v1beta1
|
|
215
|
-
* @example [
|
|
216
|
-
* "v1",
|
|
217
|
-
* "v1alpha1",
|
|
218
|
-
* "v2beta3",
|
|
219
|
-
* "v1.custom-suffix",
|
|
220
|
-
* "models.meshery.io/v1beta1",
|
|
221
|
-
* "capability.meshery.io/v1alpha1"
|
|
222
|
-
* ]
|
|
223
|
-
*/
|
|
224
|
-
schemaVersion: string;
|
|
225
|
-
/** @description Environment name */
|
|
226
|
-
name: string;
|
|
227
|
-
/** @description Environment description */
|
|
228
|
-
description: string;
|
|
229
|
-
/**
|
|
230
|
-
* Format: uuid
|
|
231
|
-
* @description Environment organization ID
|
|
232
|
-
*/
|
|
233
|
-
organization_id: string;
|
|
234
|
-
/**
|
|
235
|
-
* Format: uuid
|
|
236
|
-
* @description Environment owner
|
|
237
|
-
*/
|
|
238
|
-
owner?: string;
|
|
239
|
-
/**
|
|
240
|
-
* Format: date-time
|
|
241
|
-
* @description Timestamp when the resource was created.
|
|
242
|
-
*/
|
|
243
|
-
created_at?: string;
|
|
244
|
-
/** @description Additional metadata associated with the environment. */
|
|
245
|
-
metadata?: { [key: string]: unknown };
|
|
246
|
-
/**
|
|
247
|
-
* Format: date-time
|
|
248
|
-
* @description Timestamp when the resource was updated.
|
|
249
|
-
*/
|
|
250
|
-
updated_at?: string;
|
|
251
|
-
/**
|
|
252
|
-
* Format: date-time
|
|
253
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
254
|
-
*/
|
|
255
|
-
deleted_at?: string | null;
|
|
256
|
-
}[];
|
|
47
|
+
put: operations["updateConnection"];
|
|
48
|
+
post?: never;
|
|
257
49
|
/**
|
|
258
|
-
*
|
|
259
|
-
* @
|
|
260
|
-
* @example [
|
|
261
|
-
* "v1",
|
|
262
|
-
* "v1alpha1",
|
|
263
|
-
* "v2beta3",
|
|
264
|
-
* "v1.custom-suffix",
|
|
265
|
-
* "models.meshery.io/v1beta1",
|
|
266
|
-
* "capability.meshery.io/v1alpha1"
|
|
267
|
-
* ]
|
|
50
|
+
* Delete a connection
|
|
51
|
+
* @description Delete a specific connection
|
|
268
52
|
*/
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
page: number;
|
|
275
|
-
/** @description Number of elements per page */
|
|
276
|
-
page_size: number;
|
|
277
|
-
/** @description Aggregate count of connections grouped by status */
|
|
278
|
-
statusSummary?: { [key: string]: number };
|
|
279
|
-
};
|
|
280
|
-
/**
|
|
281
|
-
* @description Connection Status Value
|
|
282
|
-
* @enum {string}
|
|
283
|
-
*/
|
|
284
|
-
ConnectionStatusValue:
|
|
285
|
-
| "discovered"
|
|
286
|
-
| "registered"
|
|
287
|
-
| "connected"
|
|
288
|
-
| "ignored"
|
|
289
|
-
| "maintenance"
|
|
290
|
-
| "disconnected"
|
|
291
|
-
| "deleted"
|
|
292
|
-
| "not found";
|
|
293
|
-
/** @description Payload for creating or updating a connection */
|
|
294
|
-
ConnectionPayload: {
|
|
295
|
-
/**
|
|
296
|
-
* Format: uuid
|
|
297
|
-
* @description Connection ID
|
|
298
|
-
*/
|
|
299
|
-
id?: string;
|
|
300
|
-
/** @description Connection name */
|
|
301
|
-
name: string;
|
|
302
|
-
/** @description Connection kind */
|
|
303
|
-
kind: string;
|
|
304
|
-
/** @description Connection type */
|
|
305
|
-
type: string;
|
|
306
|
-
/** @description Connection sub-type */
|
|
307
|
-
subType: string;
|
|
308
|
-
/** @description Credential secret data */
|
|
309
|
-
credentialSecret?: { [key: string]: unknown };
|
|
310
|
-
/** @description Connection metadata */
|
|
311
|
-
metadata?: { [key: string]: unknown };
|
|
312
|
-
/** @description Connection status */
|
|
313
|
-
status: string;
|
|
314
|
-
/**
|
|
315
|
-
* Format: uuid
|
|
316
|
-
* @description Associated credential ID
|
|
317
|
-
*/
|
|
318
|
-
credentialId?: string;
|
|
319
|
-
};
|
|
320
|
-
/** @description Status count information for connections */
|
|
321
|
-
ConnectionStatusInfo: {
|
|
322
|
-
/** @description Status value */
|
|
323
|
-
status: string;
|
|
324
|
-
/** @description Number of connections with this status */
|
|
325
|
-
count: number;
|
|
326
|
-
};
|
|
327
|
-
/** @description Paginated list of connection status counts */
|
|
328
|
-
ConnectionsStatusPage: {
|
|
329
|
-
/** @description Total number of status entries */
|
|
330
|
-
total_count: number;
|
|
331
|
-
/** @description Current page number */
|
|
332
|
-
page: number;
|
|
333
|
-
/** @description Number of items per page */
|
|
334
|
-
page_size: number;
|
|
335
|
-
/** @description List of status counts */
|
|
336
|
-
connectionsStatus: {
|
|
337
|
-
/** @description Status value */
|
|
338
|
-
status: string;
|
|
339
|
-
/** @description Number of connections with this status */
|
|
340
|
-
count: number;
|
|
341
|
-
}[];
|
|
53
|
+
delete: operations["deleteConnection"];
|
|
54
|
+
options?: never;
|
|
55
|
+
head?: never;
|
|
56
|
+
patch?: never;
|
|
57
|
+
trace?: never;
|
|
342
58
|
};
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
* Format: uuid
|
|
354
|
-
* @description Server ID
|
|
355
|
-
*/
|
|
356
|
-
server_id?: string;
|
|
357
|
-
/** @description Meshery server version */
|
|
358
|
-
server_version?: string;
|
|
359
|
-
/** @description Server location URL */
|
|
360
|
-
server_location?: string;
|
|
361
|
-
/** @description Server build SHA */
|
|
362
|
-
server_build_sha?: string;
|
|
363
|
-
/**
|
|
364
|
-
* Format: date-time
|
|
365
|
-
* @description Creation timestamp
|
|
366
|
-
*/
|
|
367
|
-
created_at?: string;
|
|
368
|
-
/**
|
|
369
|
-
* Format: date-time
|
|
370
|
-
* @description Last update timestamp
|
|
371
|
-
*/
|
|
372
|
-
updated_at?: string;
|
|
373
|
-
/**
|
|
374
|
-
* Format: date-time
|
|
375
|
-
* @description Deletion timestamp
|
|
376
|
-
*/
|
|
377
|
-
deleted_at?: string;
|
|
378
|
-
};
|
|
379
|
-
/** @description Paginated list of Meshery instances */
|
|
380
|
-
MesheryInstancePage: {
|
|
381
|
-
/** @description List of Meshery instances */
|
|
382
|
-
mesheryInstances: {
|
|
383
|
-
/**
|
|
384
|
-
* Format: uuid
|
|
385
|
-
* @description Instance ID
|
|
386
|
-
*/
|
|
387
|
-
id?: string;
|
|
388
|
-
/** @description Instance name */
|
|
389
|
-
name?: string;
|
|
59
|
+
"/api/integrations/connections/meshery/{mesheryServerId}": {
|
|
60
|
+
parameters: {
|
|
61
|
+
query?: never;
|
|
62
|
+
header?: never;
|
|
63
|
+
path?: never;
|
|
64
|
+
cookie?: never;
|
|
65
|
+
};
|
|
66
|
+
get?: never;
|
|
67
|
+
put?: never;
|
|
68
|
+
post?: never;
|
|
390
69
|
/**
|
|
391
|
-
*
|
|
392
|
-
* @description
|
|
70
|
+
* Delete Meshery instance connection
|
|
71
|
+
* @description Delete a Meshery server connection by server ID
|
|
393
72
|
*/
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
73
|
+
delete: operations["deleteMesheryConnection"];
|
|
74
|
+
options?: never;
|
|
75
|
+
head?: never;
|
|
76
|
+
patch?: never;
|
|
77
|
+
trace?: never;
|
|
78
|
+
};
|
|
79
|
+
"/api/integrations/connections/kubernetes/{connectionId}/context": {
|
|
80
|
+
parameters: {
|
|
81
|
+
query?: never;
|
|
82
|
+
header?: never;
|
|
83
|
+
path?: never;
|
|
84
|
+
cookie?: never;
|
|
85
|
+
};
|
|
401
86
|
/**
|
|
402
|
-
*
|
|
403
|
-
* @description
|
|
87
|
+
* Get Kubernetes context
|
|
88
|
+
* @description Get Kubernetes context for a specific connection
|
|
404
89
|
*/
|
|
405
|
-
|
|
90
|
+
get: operations["getKubernetesContext"];
|
|
91
|
+
put?: never;
|
|
92
|
+
post?: never;
|
|
93
|
+
delete?: never;
|
|
94
|
+
options?: never;
|
|
95
|
+
head?: never;
|
|
96
|
+
patch?: never;
|
|
97
|
+
trace?: never;
|
|
98
|
+
};
|
|
99
|
+
"/api/environments/{environmentId}/connections/{connectionId}": {
|
|
100
|
+
parameters: {
|
|
101
|
+
query?: never;
|
|
102
|
+
header?: never;
|
|
103
|
+
path?: never;
|
|
104
|
+
cookie?: never;
|
|
105
|
+
};
|
|
106
|
+
get?: never;
|
|
107
|
+
put?: never;
|
|
406
108
|
/**
|
|
407
|
-
*
|
|
408
|
-
* @description
|
|
109
|
+
* Add connection to environment
|
|
110
|
+
* @description Associate a connection with an environment
|
|
409
111
|
*/
|
|
410
|
-
|
|
112
|
+
post: operations["addConnectionToEnvironment"];
|
|
411
113
|
/**
|
|
412
|
-
*
|
|
413
|
-
* @description
|
|
114
|
+
* Remove connection from environment
|
|
115
|
+
* @description Disassociate a connection from an environment
|
|
414
116
|
*/
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
page_size: number;
|
|
421
|
-
/** @description Total number of instances */
|
|
422
|
-
total_count: number;
|
|
423
|
-
};
|
|
424
|
-
/** @description Meshery version compatibility check */
|
|
425
|
-
MesheryCompatibility: {
|
|
426
|
-
/** @description Meshery version string */
|
|
427
|
-
mesheryVersion?: string;
|
|
428
|
-
/** @description Whether to check compatibility */
|
|
429
|
-
checkCompatibility?: boolean;
|
|
430
|
-
};
|
|
431
|
-
};
|
|
432
|
-
responses: {
|
|
433
|
-
/** Invalid request body or request param */
|
|
434
|
-
400: {
|
|
435
|
-
content: {
|
|
436
|
-
"text/plain": string;
|
|
437
|
-
};
|
|
117
|
+
delete: operations["removeConnectionFromEnvironment"];
|
|
118
|
+
options?: never;
|
|
119
|
+
head?: never;
|
|
120
|
+
patch?: never;
|
|
121
|
+
trace?: never;
|
|
438
122
|
};
|
|
439
|
-
/** Expired JWT token used or insufficient privilege */
|
|
440
|
-
401: {
|
|
441
|
-
content: {
|
|
442
|
-
"text/plain": string;
|
|
443
|
-
};
|
|
444
|
-
};
|
|
445
|
-
/** Result not found */
|
|
446
|
-
404: {
|
|
447
|
-
content: {
|
|
448
|
-
"text/plain": string;
|
|
449
|
-
};
|
|
450
|
-
};
|
|
451
|
-
/** Internal server error */
|
|
452
|
-
500: {
|
|
453
|
-
content: {
|
|
454
|
-
"text/plain": string;
|
|
455
|
-
};
|
|
456
|
-
};
|
|
457
|
-
};
|
|
458
|
-
parameters: {
|
|
459
|
-
/** @description Connection ID */
|
|
460
|
-
connectionId: string;
|
|
461
|
-
/** @description Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
462
|
-
connectionKind: string;
|
|
463
|
-
/** @description Environment ID */
|
|
464
|
-
environmentId: string;
|
|
465
|
-
/** @description Page number */
|
|
466
|
-
page: number;
|
|
467
|
-
/** @description Number of items per page */
|
|
468
|
-
pagesize: number;
|
|
469
|
-
/** @description Search term */
|
|
470
|
-
search: string;
|
|
471
|
-
/** @description Sort order */
|
|
472
|
-
order: string;
|
|
473
|
-
};
|
|
474
123
|
}
|
|
475
|
-
|
|
476
|
-
export interface
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
id: string;
|
|
522
|
-
/** @description Connection Name */
|
|
523
|
-
name: string;
|
|
524
|
-
/**
|
|
525
|
-
* Format: uuid
|
|
526
|
-
* @description Associated Credential ID
|
|
527
|
-
*/
|
|
528
|
-
credential_id?: string;
|
|
529
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
530
|
-
type: string;
|
|
531
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
532
|
-
sub_type: string;
|
|
533
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
534
|
-
kind: string;
|
|
535
|
-
/** @description Additional connection metadata */
|
|
536
|
-
metadata?: { [key: string]: unknown };
|
|
537
|
-
/**
|
|
538
|
-
* @description Connection Status
|
|
539
|
-
* @enum {string}
|
|
540
|
-
*/
|
|
541
|
-
status:
|
|
542
|
-
| "discovered"
|
|
543
|
-
| "registered"
|
|
544
|
-
| "connected"
|
|
545
|
-
| "ignored"
|
|
546
|
-
| "maintenance"
|
|
547
|
-
| "disconnected"
|
|
548
|
-
| "deleted"
|
|
549
|
-
| "not found";
|
|
550
|
-
/**
|
|
551
|
-
* Format: uuid
|
|
552
|
-
* @description User ID who owns this connection
|
|
553
|
-
*/
|
|
554
|
-
user_id?: string;
|
|
555
|
-
/** Format: date-time */
|
|
556
|
-
created_at?: string;
|
|
557
|
-
/** Format: date-time */
|
|
558
|
-
updated_at?: string;
|
|
559
|
-
/**
|
|
560
|
-
* Format: date-time
|
|
561
|
-
* @description SQL null Timestamp to handle null values of time.
|
|
562
|
-
*/
|
|
563
|
-
deleted_at?: string;
|
|
564
|
-
/** @description Associated environments for this connection */
|
|
565
|
-
environments?: {
|
|
124
|
+
export type webhooks = Record<string, never>;
|
|
125
|
+
export interface components {
|
|
126
|
+
schemas: {
|
|
127
|
+
/** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
|
|
128
|
+
Connection: {
|
|
129
|
+
/**
|
|
130
|
+
* Format: uuid
|
|
131
|
+
* @description Connection ID
|
|
132
|
+
*/
|
|
133
|
+
id: string;
|
|
134
|
+
/** @description Connection Name */
|
|
135
|
+
name: string;
|
|
136
|
+
/**
|
|
137
|
+
* Format: uuid
|
|
138
|
+
* @description Associated Credential ID
|
|
139
|
+
*/
|
|
140
|
+
credential_id?: string;
|
|
141
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
142
|
+
type: string;
|
|
143
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
144
|
+
sub_type: string;
|
|
145
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
146
|
+
kind: string;
|
|
147
|
+
/** @description Additional connection metadata */
|
|
148
|
+
metadata?: Record<string, never>;
|
|
149
|
+
/**
|
|
150
|
+
* @description Connection Status
|
|
151
|
+
* @enum {string}
|
|
152
|
+
*/
|
|
153
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
154
|
+
/**
|
|
155
|
+
* Format: uuid
|
|
156
|
+
* @description User ID who owns this connection
|
|
157
|
+
*/
|
|
158
|
+
user_id?: string;
|
|
159
|
+
/** Format: date-time */
|
|
160
|
+
created_at?: string;
|
|
161
|
+
/** Format: date-time */
|
|
162
|
+
updated_at?: string;
|
|
163
|
+
/**
|
|
164
|
+
* Format: date-time
|
|
165
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
166
|
+
*/
|
|
167
|
+
deleted_at?: string;
|
|
168
|
+
/** @description Associated environments for this connection */
|
|
169
|
+
environments?: {
|
|
566
170
|
/**
|
|
567
171
|
* Format: uuid
|
|
568
172
|
* @description ID
|
|
@@ -572,13 +176,13 @@ export interface operations {
|
|
|
572
176
|
* @description Specifies the version of the schema to which the environment conforms.
|
|
573
177
|
* @default environments.meshery.io/v1beta1
|
|
574
178
|
* @example [
|
|
575
|
-
*
|
|
576
|
-
*
|
|
577
|
-
*
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
*
|
|
179
|
+
* "v1",
|
|
180
|
+
* "v1alpha1",
|
|
181
|
+
* "v2beta3",
|
|
182
|
+
* "v1.custom-suffix",
|
|
183
|
+
* "models.meshery.io/v1beta1",
|
|
184
|
+
* "capability.meshery.io/v1alpha1"
|
|
185
|
+
* ]
|
|
582
186
|
*/
|
|
583
187
|
schemaVersion: string;
|
|
584
188
|
/** @description Environment name */
|
|
@@ -601,7 +205,7 @@ export interface operations {
|
|
|
601
205
|
*/
|
|
602
206
|
created_at?: string;
|
|
603
207
|
/** @description Additional metadata associated with the environment. */
|
|
604
|
-
metadata?:
|
|
208
|
+
metadata?: Record<string, never>;
|
|
605
209
|
/**
|
|
606
210
|
* Format: date-time
|
|
607
211
|
* @description Timestamp when the resource was updated.
|
|
@@ -612,20 +216,129 @@ export interface operations {
|
|
|
612
216
|
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
613
217
|
*/
|
|
614
218
|
deleted_at?: string | null;
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
219
|
+
}[];
|
|
220
|
+
/**
|
|
221
|
+
* @description Specifies the version of the schema used for the definition.
|
|
222
|
+
* @default connections.meshery.io/v1beta2
|
|
223
|
+
* @example [
|
|
224
|
+
* "v1",
|
|
225
|
+
* "v1alpha1",
|
|
226
|
+
* "v2beta3",
|
|
227
|
+
* "v1.custom-suffix",
|
|
228
|
+
* "models.meshery.io/v1beta1",
|
|
229
|
+
* "capability.meshery.io/v1alpha1"
|
|
230
|
+
* ]
|
|
231
|
+
*/
|
|
232
|
+
schemaVersion: string;
|
|
233
|
+
};
|
|
234
|
+
/** @description Represents a page of connections with meta information about connections count */
|
|
235
|
+
ConnectionPage: {
|
|
236
|
+
/** @description List of connections on this page */
|
|
237
|
+
connections: {
|
|
238
|
+
/**
|
|
239
|
+
* Format: uuid
|
|
240
|
+
* @description Connection ID
|
|
241
|
+
*/
|
|
242
|
+
id: string;
|
|
243
|
+
/** @description Connection Name */
|
|
244
|
+
name: string;
|
|
245
|
+
/**
|
|
246
|
+
* Format: uuid
|
|
247
|
+
* @description Associated Credential ID
|
|
248
|
+
*/
|
|
249
|
+
credential_id?: string;
|
|
250
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
251
|
+
type: string;
|
|
252
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
253
|
+
sub_type: string;
|
|
254
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
255
|
+
kind: string;
|
|
256
|
+
/** @description Additional connection metadata */
|
|
257
|
+
metadata?: Record<string, never>;
|
|
258
|
+
/**
|
|
259
|
+
* @description Connection Status
|
|
260
|
+
* @enum {string}
|
|
261
|
+
*/
|
|
262
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
263
|
+
/**
|
|
264
|
+
* Format: uuid
|
|
265
|
+
* @description User ID who owns this connection
|
|
266
|
+
*/
|
|
267
|
+
user_id?: string;
|
|
268
|
+
/** Format: date-time */
|
|
269
|
+
created_at?: string;
|
|
270
|
+
/** Format: date-time */
|
|
271
|
+
updated_at?: string;
|
|
272
|
+
/**
|
|
273
|
+
* Format: date-time
|
|
274
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
275
|
+
*/
|
|
276
|
+
deleted_at?: string;
|
|
277
|
+
/** @description Associated environments for this connection */
|
|
278
|
+
environments?: {
|
|
279
|
+
/**
|
|
280
|
+
* Format: uuid
|
|
281
|
+
* @description ID
|
|
282
|
+
*/
|
|
283
|
+
id: string;
|
|
284
|
+
/**
|
|
285
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
286
|
+
* @default environments.meshery.io/v1beta1
|
|
287
|
+
* @example [
|
|
288
|
+
* "v1",
|
|
289
|
+
* "v1alpha1",
|
|
290
|
+
* "v2beta3",
|
|
291
|
+
* "v1.custom-suffix",
|
|
292
|
+
* "models.meshery.io/v1beta1",
|
|
293
|
+
* "capability.meshery.io/v1alpha1"
|
|
294
|
+
* ]
|
|
295
|
+
*/
|
|
296
|
+
schemaVersion: string;
|
|
297
|
+
/** @description Environment name */
|
|
298
|
+
name: string;
|
|
299
|
+
/** @description Environment description */
|
|
300
|
+
description: string;
|
|
301
|
+
/**
|
|
302
|
+
* Format: uuid
|
|
303
|
+
* @description Environment organization ID
|
|
304
|
+
*/
|
|
305
|
+
organization_id: string;
|
|
306
|
+
/**
|
|
307
|
+
* Format: uuid
|
|
308
|
+
* @description Environment owner
|
|
309
|
+
*/
|
|
310
|
+
owner?: string;
|
|
311
|
+
/**
|
|
312
|
+
* Format: date-time
|
|
313
|
+
* @description Timestamp when the resource was created.
|
|
314
|
+
*/
|
|
315
|
+
created_at?: string;
|
|
316
|
+
/** @description Additional metadata associated with the environment. */
|
|
317
|
+
metadata?: Record<string, never>;
|
|
318
|
+
/**
|
|
319
|
+
* Format: date-time
|
|
320
|
+
* @description Timestamp when the resource was updated.
|
|
321
|
+
*/
|
|
322
|
+
updated_at?: string;
|
|
323
|
+
/**
|
|
324
|
+
* Format: date-time
|
|
325
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
326
|
+
*/
|
|
327
|
+
deleted_at?: string | null;
|
|
328
|
+
}[];
|
|
329
|
+
/**
|
|
330
|
+
* @description Specifies the version of the schema used for the definition.
|
|
331
|
+
* @default connections.meshery.io/v1beta2
|
|
332
|
+
* @example [
|
|
333
|
+
* "v1",
|
|
334
|
+
* "v1alpha1",
|
|
335
|
+
* "v2beta3",
|
|
336
|
+
* "v1.custom-suffix",
|
|
337
|
+
* "models.meshery.io/v1beta1",
|
|
338
|
+
* "capability.meshery.io/v1alpha1"
|
|
339
|
+
* ]
|
|
340
|
+
*/
|
|
341
|
+
schemaVersion: string;
|
|
629
342
|
}[];
|
|
630
343
|
/** @description Total number of connections on all pages */
|
|
631
344
|
total_count: number;
|
|
@@ -634,697 +347,1171 @@ export interface operations {
|
|
|
634
347
|
/** @description Number of elements per page */
|
|
635
348
|
page_size: number;
|
|
636
349
|
/** @description Aggregate count of connections grouped by status */
|
|
637
|
-
statusSummary?: {
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
};
|
|
641
|
-
/** Expired JWT token used or insufficient privilege */
|
|
642
|
-
401: {
|
|
643
|
-
content: {
|
|
644
|
-
"text/plain": string;
|
|
350
|
+
statusSummary?: {
|
|
351
|
+
[key: string]: number;
|
|
352
|
+
};
|
|
645
353
|
};
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
};
|
|
654
|
-
};
|
|
655
|
-
/** Register a new connection with credentials */
|
|
656
|
-
registerConnection: {
|
|
657
|
-
responses: {
|
|
658
|
-
/** Connection registered */
|
|
659
|
-
201: {
|
|
660
|
-
content: {
|
|
661
|
-
"application/json": {
|
|
354
|
+
/**
|
|
355
|
+
* @description Connection Status Value
|
|
356
|
+
* @enum {string}
|
|
357
|
+
*/
|
|
358
|
+
ConnectionStatusValue: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
359
|
+
/** @description Payload for creating or updating a connection */
|
|
360
|
+
ConnectionPayload: {
|
|
662
361
|
/**
|
|
663
362
|
* Format: uuid
|
|
664
363
|
* @description Connection ID
|
|
665
364
|
*/
|
|
666
|
-
id
|
|
667
|
-
/** @description Connection
|
|
365
|
+
id?: string;
|
|
366
|
+
/** @description Connection name */
|
|
668
367
|
name: string;
|
|
669
|
-
/**
|
|
670
|
-
* Format: uuid
|
|
671
|
-
* @description Associated Credential ID
|
|
672
|
-
*/
|
|
673
|
-
credential_id?: string;
|
|
674
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
675
|
-
type: string;
|
|
676
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
677
|
-
sub_type: string;
|
|
678
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
368
|
+
/** @description Connection kind */
|
|
679
369
|
kind: string;
|
|
680
|
-
/** @description
|
|
681
|
-
|
|
682
|
-
/**
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
| "ignored"
|
|
691
|
-
| "maintenance"
|
|
692
|
-
| "disconnected"
|
|
693
|
-
| "deleted"
|
|
694
|
-
| "not found";
|
|
370
|
+
/** @description Connection type */
|
|
371
|
+
type: string;
|
|
372
|
+
/** @description Connection sub-type */
|
|
373
|
+
subType: string;
|
|
374
|
+
/** @description Credential secret data */
|
|
375
|
+
credentialSecret?: Record<string, never>;
|
|
376
|
+
/** @description Connection metadata */
|
|
377
|
+
metadata?: Record<string, never>;
|
|
378
|
+
/** @description Connection status */
|
|
379
|
+
status: string;
|
|
695
380
|
/**
|
|
696
381
|
* Format: uuid
|
|
697
|
-
* @description
|
|
382
|
+
* @description Associated credential ID
|
|
698
383
|
*/
|
|
699
|
-
|
|
700
|
-
/** Format: date-time */
|
|
701
|
-
created_at?: string;
|
|
702
|
-
/** Format: date-time */
|
|
703
|
-
updated_at?: string;
|
|
704
|
-
/**
|
|
705
|
-
* Format: date-time
|
|
706
|
-
* @description SQL null Timestamp to handle null values of time.
|
|
707
|
-
*/
|
|
708
|
-
deleted_at?: string;
|
|
709
|
-
/** @description Associated environments for this connection */
|
|
710
|
-
environments?: {
|
|
711
|
-
/**
|
|
712
|
-
* Format: uuid
|
|
713
|
-
* @description ID
|
|
714
|
-
*/
|
|
715
|
-
id: string;
|
|
716
|
-
/**
|
|
717
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
718
|
-
* @default environments.meshery.io/v1beta1
|
|
719
|
-
* @example [
|
|
720
|
-
* "v1",
|
|
721
|
-
* "v1alpha1",
|
|
722
|
-
* "v2beta3",
|
|
723
|
-
* "v1.custom-suffix",
|
|
724
|
-
* "models.meshery.io/v1beta1",
|
|
725
|
-
* "capability.meshery.io/v1alpha1"
|
|
726
|
-
* ]
|
|
727
|
-
*/
|
|
728
|
-
schemaVersion: string;
|
|
729
|
-
/** @description Environment name */
|
|
730
|
-
name: string;
|
|
731
|
-
/** @description Environment description */
|
|
732
|
-
description: string;
|
|
733
|
-
/**
|
|
734
|
-
* Format: uuid
|
|
735
|
-
* @description Environment organization ID
|
|
736
|
-
*/
|
|
737
|
-
organization_id: string;
|
|
738
|
-
/**
|
|
739
|
-
* Format: uuid
|
|
740
|
-
* @description Environment owner
|
|
741
|
-
*/
|
|
742
|
-
owner?: string;
|
|
743
|
-
/**
|
|
744
|
-
* Format: date-time
|
|
745
|
-
* @description Timestamp when the resource was created.
|
|
746
|
-
*/
|
|
747
|
-
created_at?: string;
|
|
748
|
-
/** @description Additional metadata associated with the environment. */
|
|
749
|
-
metadata?: { [key: string]: unknown };
|
|
750
|
-
/**
|
|
751
|
-
* Format: date-time
|
|
752
|
-
* @description Timestamp when the resource was updated.
|
|
753
|
-
*/
|
|
754
|
-
updated_at?: string;
|
|
755
|
-
/**
|
|
756
|
-
* Format: date-time
|
|
757
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
758
|
-
*/
|
|
759
|
-
deleted_at?: string | null;
|
|
760
|
-
}[];
|
|
761
|
-
/**
|
|
762
|
-
* @description Specifies the version of the schema used for the definition.
|
|
763
|
-
* @default connections.meshery.io/v1beta2
|
|
764
|
-
* @example [
|
|
765
|
-
* "v1",
|
|
766
|
-
* "v1alpha1",
|
|
767
|
-
* "v2beta3",
|
|
768
|
-
* "v1.custom-suffix",
|
|
769
|
-
* "models.meshery.io/v1beta1",
|
|
770
|
-
* "capability.meshery.io/v1alpha1"
|
|
771
|
-
* ]
|
|
772
|
-
*/
|
|
773
|
-
schemaVersion: string;
|
|
774
|
-
};
|
|
384
|
+
credentialId?: string;
|
|
775
385
|
};
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
386
|
+
/** @description Status count information for connections */
|
|
387
|
+
ConnectionStatusInfo: {
|
|
388
|
+
/** @description Status value */
|
|
389
|
+
status: string;
|
|
390
|
+
/** @description Number of connections with this status */
|
|
391
|
+
count: number;
|
|
781
392
|
};
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
content: {
|
|
798
|
-
"application/json": {
|
|
799
|
-
/**
|
|
800
|
-
* Format: uuid
|
|
801
|
-
* @description Connection ID
|
|
802
|
-
*/
|
|
803
|
-
id?: string;
|
|
804
|
-
/** @description Connection name */
|
|
805
|
-
name: string;
|
|
806
|
-
/** @description Connection kind */
|
|
807
|
-
kind: string;
|
|
808
|
-
/** @description Connection type */
|
|
809
|
-
type: string;
|
|
810
|
-
/** @description Connection sub-type */
|
|
811
|
-
subType: string;
|
|
812
|
-
/** @description Credential secret data */
|
|
813
|
-
credentialSecret?: { [key: string]: unknown };
|
|
814
|
-
/** @description Connection metadata */
|
|
815
|
-
metadata?: { [key: string]: unknown };
|
|
816
|
-
/** @description Connection status */
|
|
817
|
-
status: string;
|
|
818
|
-
/**
|
|
819
|
-
* Format: uuid
|
|
820
|
-
* @description Associated credential ID
|
|
821
|
-
*/
|
|
822
|
-
credentialId?: string;
|
|
393
|
+
/** @description Paginated list of connection status counts */
|
|
394
|
+
ConnectionsStatusPage: {
|
|
395
|
+
/** @description Total number of status entries */
|
|
396
|
+
total_count: number;
|
|
397
|
+
/** @description Current page number */
|
|
398
|
+
page: number;
|
|
399
|
+
/** @description Number of items per page */
|
|
400
|
+
page_size: number;
|
|
401
|
+
/** @description List of status counts */
|
|
402
|
+
connectionsStatus: {
|
|
403
|
+
/** @description Status value */
|
|
404
|
+
status: string;
|
|
405
|
+
/** @description Number of connections with this status */
|
|
406
|
+
count: number;
|
|
407
|
+
}[];
|
|
823
408
|
};
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
};
|
|
827
|
-
/** Returns a specific connection by its ID */
|
|
828
|
-
getConnectionById: {
|
|
829
|
-
parameters: {
|
|
830
|
-
path: {
|
|
831
|
-
/** Connection ID */
|
|
832
|
-
connectionId: string;
|
|
833
|
-
};
|
|
834
|
-
};
|
|
835
|
-
responses: {
|
|
836
|
-
/** Connection details */
|
|
837
|
-
200: {
|
|
838
|
-
content: {
|
|
839
|
-
"application/json": {
|
|
409
|
+
/** @description Meshery server instance information */
|
|
410
|
+
MesheryInstance: {
|
|
840
411
|
/**
|
|
841
412
|
* Format: uuid
|
|
842
|
-
* @description
|
|
413
|
+
* @description Instance ID
|
|
843
414
|
*/
|
|
844
|
-
id
|
|
845
|
-
/** @description
|
|
846
|
-
name
|
|
415
|
+
id?: string;
|
|
416
|
+
/** @description Instance name */
|
|
417
|
+
name?: string;
|
|
847
418
|
/**
|
|
848
419
|
* Format: uuid
|
|
849
|
-
* @description
|
|
420
|
+
* @description Server ID
|
|
850
421
|
*/
|
|
851
|
-
|
|
852
|
-
/** @description
|
|
853
|
-
|
|
854
|
-
/** @description
|
|
855
|
-
|
|
856
|
-
/** @description
|
|
857
|
-
|
|
858
|
-
/** @description Additional connection metadata */
|
|
859
|
-
metadata?: { [key: string]: unknown };
|
|
860
|
-
/**
|
|
861
|
-
* @description Connection Status
|
|
862
|
-
* @enum {string}
|
|
863
|
-
*/
|
|
864
|
-
status:
|
|
865
|
-
| "discovered"
|
|
866
|
-
| "registered"
|
|
867
|
-
| "connected"
|
|
868
|
-
| "ignored"
|
|
869
|
-
| "maintenance"
|
|
870
|
-
| "disconnected"
|
|
871
|
-
| "deleted"
|
|
872
|
-
| "not found";
|
|
422
|
+
server_id?: string;
|
|
423
|
+
/** @description Meshery server version */
|
|
424
|
+
server_version?: string;
|
|
425
|
+
/** @description Server location URL */
|
|
426
|
+
server_location?: string;
|
|
427
|
+
/** @description Server build SHA */
|
|
428
|
+
server_build_sha?: string;
|
|
873
429
|
/**
|
|
874
|
-
* Format:
|
|
875
|
-
* @description
|
|
430
|
+
* Format: date-time
|
|
431
|
+
* @description Creation timestamp
|
|
876
432
|
*/
|
|
877
|
-
user_id?: string;
|
|
878
|
-
/** Format: date-time */
|
|
879
433
|
created_at?: string;
|
|
880
|
-
/** Format: date-time */
|
|
881
|
-
updated_at?: string;
|
|
882
434
|
/**
|
|
883
435
|
* Format: date-time
|
|
884
|
-
* @description
|
|
885
|
-
*/
|
|
886
|
-
deleted_at?: string;
|
|
887
|
-
/** @description Associated environments for this connection */
|
|
888
|
-
environments?: {
|
|
889
|
-
/**
|
|
890
|
-
* Format: uuid
|
|
891
|
-
* @description ID
|
|
892
|
-
*/
|
|
893
|
-
id: string;
|
|
894
|
-
/**
|
|
895
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
896
|
-
* @default environments.meshery.io/v1beta1
|
|
897
|
-
* @example [
|
|
898
|
-
* "v1",
|
|
899
|
-
* "v1alpha1",
|
|
900
|
-
* "v2beta3",
|
|
901
|
-
* "v1.custom-suffix",
|
|
902
|
-
* "models.meshery.io/v1beta1",
|
|
903
|
-
* "capability.meshery.io/v1alpha1"
|
|
904
|
-
* ]
|
|
905
|
-
*/
|
|
906
|
-
schemaVersion: string;
|
|
907
|
-
/** @description Environment name */
|
|
908
|
-
name: string;
|
|
909
|
-
/** @description Environment description */
|
|
910
|
-
description: string;
|
|
911
|
-
/**
|
|
912
|
-
* Format: uuid
|
|
913
|
-
* @description Environment organization ID
|
|
914
|
-
*/
|
|
915
|
-
organization_id: string;
|
|
916
|
-
/**
|
|
917
|
-
* Format: uuid
|
|
918
|
-
* @description Environment owner
|
|
919
|
-
*/
|
|
920
|
-
owner?: string;
|
|
921
|
-
/**
|
|
922
|
-
* Format: date-time
|
|
923
|
-
* @description Timestamp when the resource was created.
|
|
924
|
-
*/
|
|
925
|
-
created_at?: string;
|
|
926
|
-
/** @description Additional metadata associated with the environment. */
|
|
927
|
-
metadata?: { [key: string]: unknown };
|
|
928
|
-
/**
|
|
929
|
-
* Format: date-time
|
|
930
|
-
* @description Timestamp when the resource was updated.
|
|
931
|
-
*/
|
|
932
|
-
updated_at?: string;
|
|
933
|
-
/**
|
|
934
|
-
* Format: date-time
|
|
935
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
936
|
-
*/
|
|
937
|
-
deleted_at?: string | null;
|
|
938
|
-
}[];
|
|
939
|
-
/**
|
|
940
|
-
* @description Specifies the version of the schema used for the definition.
|
|
941
|
-
* @default connections.meshery.io/v1beta2
|
|
942
|
-
* @example [
|
|
943
|
-
* "v1",
|
|
944
|
-
* "v1alpha1",
|
|
945
|
-
* "v2beta3",
|
|
946
|
-
* "v1.custom-suffix",
|
|
947
|
-
* "models.meshery.io/v1beta1",
|
|
948
|
-
* "capability.meshery.io/v1alpha1"
|
|
949
|
-
* ]
|
|
950
|
-
*/
|
|
951
|
-
schemaVersion: string;
|
|
952
|
-
};
|
|
953
|
-
};
|
|
954
|
-
};
|
|
955
|
-
/** Expired JWT token used or insufficient privilege */
|
|
956
|
-
401: {
|
|
957
|
-
content: {
|
|
958
|
-
"text/plain": string;
|
|
959
|
-
};
|
|
960
|
-
};
|
|
961
|
-
/** Result not found */
|
|
962
|
-
404: {
|
|
963
|
-
content: {
|
|
964
|
-
"text/plain": string;
|
|
965
|
-
};
|
|
966
|
-
};
|
|
967
|
-
/** Internal server error */
|
|
968
|
-
500: {
|
|
969
|
-
content: {
|
|
970
|
-
"text/plain": string;
|
|
971
|
-
};
|
|
972
|
-
};
|
|
973
|
-
};
|
|
974
|
-
};
|
|
975
|
-
/** Update an existing connection */
|
|
976
|
-
updateConnection: {
|
|
977
|
-
parameters: {
|
|
978
|
-
path: {
|
|
979
|
-
/** Connection ID */
|
|
980
|
-
connectionId: string;
|
|
981
|
-
};
|
|
982
|
-
};
|
|
983
|
-
responses: {
|
|
984
|
-
/** Connection updated */
|
|
985
|
-
200: {
|
|
986
|
-
content: {
|
|
987
|
-
"application/json": {
|
|
988
|
-
/**
|
|
989
|
-
* Format: uuid
|
|
990
|
-
* @description Connection ID
|
|
991
|
-
*/
|
|
992
|
-
id: string;
|
|
993
|
-
/** @description Connection Name */
|
|
994
|
-
name: string;
|
|
995
|
-
/**
|
|
996
|
-
* Format: uuid
|
|
997
|
-
* @description Associated Credential ID
|
|
998
|
-
*/
|
|
999
|
-
credential_id?: string;
|
|
1000
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
1001
|
-
type: string;
|
|
1002
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
1003
|
-
sub_type: string;
|
|
1004
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
1005
|
-
kind: string;
|
|
1006
|
-
/** @description Additional connection metadata */
|
|
1007
|
-
metadata?: { [key: string]: unknown };
|
|
1008
|
-
/**
|
|
1009
|
-
* @description Connection Status
|
|
1010
|
-
* @enum {string}
|
|
1011
|
-
*/
|
|
1012
|
-
status:
|
|
1013
|
-
| "discovered"
|
|
1014
|
-
| "registered"
|
|
1015
|
-
| "connected"
|
|
1016
|
-
| "ignored"
|
|
1017
|
-
| "maintenance"
|
|
1018
|
-
| "disconnected"
|
|
1019
|
-
| "deleted"
|
|
1020
|
-
| "not found";
|
|
1021
|
-
/**
|
|
1022
|
-
* Format: uuid
|
|
1023
|
-
* @description User ID who owns this connection
|
|
436
|
+
* @description Last update timestamp
|
|
1024
437
|
*/
|
|
1025
|
-
user_id?: string;
|
|
1026
|
-
/** Format: date-time */
|
|
1027
|
-
created_at?: string;
|
|
1028
|
-
/** Format: date-time */
|
|
1029
438
|
updated_at?: string;
|
|
1030
439
|
/**
|
|
1031
440
|
* Format: date-time
|
|
1032
|
-
* @description
|
|
441
|
+
* @description Deletion timestamp
|
|
1033
442
|
*/
|
|
1034
443
|
deleted_at?: string;
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1039
|
-
|
|
1040
|
-
|
|
1041
|
-
|
|
1042
|
-
|
|
1043
|
-
|
|
1044
|
-
|
|
1045
|
-
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
|
|
1049
|
-
|
|
1050
|
-
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
|
|
1072
|
-
|
|
1073
|
-
created_at?: string;
|
|
1074
|
-
/** @description Additional metadata associated with the environment. */
|
|
1075
|
-
metadata?: { [key: string]: unknown };
|
|
1076
|
-
/**
|
|
1077
|
-
* Format: date-time
|
|
1078
|
-
* @description Timestamp when the resource was updated.
|
|
1079
|
-
*/
|
|
1080
|
-
updated_at?: string;
|
|
1081
|
-
/**
|
|
1082
|
-
* Format: date-time
|
|
1083
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
1084
|
-
*/
|
|
1085
|
-
deleted_at?: string | null;
|
|
444
|
+
};
|
|
445
|
+
/** @description Paginated list of Meshery instances */
|
|
446
|
+
MesheryInstancePage: {
|
|
447
|
+
/** @description List of Meshery instances */
|
|
448
|
+
mesheryInstances: {
|
|
449
|
+
/**
|
|
450
|
+
* Format: uuid
|
|
451
|
+
* @description Instance ID
|
|
452
|
+
*/
|
|
453
|
+
id?: string;
|
|
454
|
+
/** @description Instance name */
|
|
455
|
+
name?: string;
|
|
456
|
+
/**
|
|
457
|
+
* Format: uuid
|
|
458
|
+
* @description Server ID
|
|
459
|
+
*/
|
|
460
|
+
server_id?: string;
|
|
461
|
+
/** @description Meshery server version */
|
|
462
|
+
server_version?: string;
|
|
463
|
+
/** @description Server location URL */
|
|
464
|
+
server_location?: string;
|
|
465
|
+
/** @description Server build SHA */
|
|
466
|
+
server_build_sha?: string;
|
|
467
|
+
/**
|
|
468
|
+
* Format: date-time
|
|
469
|
+
* @description Creation timestamp
|
|
470
|
+
*/
|
|
471
|
+
created_at?: string;
|
|
472
|
+
/**
|
|
473
|
+
* Format: date-time
|
|
474
|
+
* @description Last update timestamp
|
|
475
|
+
*/
|
|
476
|
+
updated_at?: string;
|
|
477
|
+
/**
|
|
478
|
+
* Format: date-time
|
|
479
|
+
* @description Deletion timestamp
|
|
480
|
+
*/
|
|
481
|
+
deleted_at?: string;
|
|
1086
482
|
}[];
|
|
1087
|
-
/**
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
* "v2beta3",
|
|
1094
|
-
* "v1.custom-suffix",
|
|
1095
|
-
* "models.meshery.io/v1beta1",
|
|
1096
|
-
* "capability.meshery.io/v1alpha1"
|
|
1097
|
-
* ]
|
|
1098
|
-
*/
|
|
1099
|
-
schemaVersion: string;
|
|
1100
|
-
};
|
|
483
|
+
/** @description Current page number */
|
|
484
|
+
page: number;
|
|
485
|
+
/** @description Number of items per page */
|
|
486
|
+
page_size: number;
|
|
487
|
+
/** @description Total number of instances */
|
|
488
|
+
total_count: number;
|
|
1101
489
|
};
|
|
1102
|
-
|
|
1103
|
-
|
|
1104
|
-
|
|
1105
|
-
|
|
1106
|
-
|
|
490
|
+
/** @description Meshery version compatibility check */
|
|
491
|
+
MesheryCompatibility: {
|
|
492
|
+
/** @description Meshery version string */
|
|
493
|
+
mesheryVersion?: string;
|
|
494
|
+
/** @description Whether to check compatibility */
|
|
495
|
+
checkCompatibility?: boolean;
|
|
1107
496
|
};
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
|
|
1111
|
-
|
|
1112
|
-
|
|
497
|
+
};
|
|
498
|
+
responses: {
|
|
499
|
+
/** @description Invalid request body or request param */
|
|
500
|
+
400: {
|
|
501
|
+
headers: {
|
|
502
|
+
[name: string]: unknown;
|
|
503
|
+
};
|
|
504
|
+
content: {
|
|
505
|
+
"text/plain": string;
|
|
506
|
+
};
|
|
1113
507
|
};
|
|
1114
|
-
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
508
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
509
|
+
401: {
|
|
510
|
+
headers: {
|
|
511
|
+
[name: string]: unknown;
|
|
512
|
+
};
|
|
513
|
+
content: {
|
|
514
|
+
"text/plain": string;
|
|
515
|
+
};
|
|
1119
516
|
};
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
517
|
+
/** @description Result not found */
|
|
518
|
+
404: {
|
|
519
|
+
headers: {
|
|
520
|
+
[name: string]: unknown;
|
|
521
|
+
};
|
|
522
|
+
content: {
|
|
523
|
+
"text/plain": string;
|
|
524
|
+
};
|
|
1125
525
|
};
|
|
1126
|
-
|
|
1127
|
-
|
|
1128
|
-
|
|
1129
|
-
|
|
1130
|
-
|
|
1131
|
-
|
|
1132
|
-
|
|
1133
|
-
|
|
1134
|
-
*/
|
|
1135
|
-
id?: string;
|
|
1136
|
-
/** @description Connection name */
|
|
1137
|
-
name: string;
|
|
1138
|
-
/** @description Connection kind */
|
|
1139
|
-
kind: string;
|
|
1140
|
-
/** @description Connection type */
|
|
1141
|
-
type: string;
|
|
1142
|
-
/** @description Connection sub-type */
|
|
1143
|
-
subType: string;
|
|
1144
|
-
/** @description Credential secret data */
|
|
1145
|
-
credentialSecret?: { [key: string]: unknown };
|
|
1146
|
-
/** @description Connection metadata */
|
|
1147
|
-
metadata?: { [key: string]: unknown };
|
|
1148
|
-
/** @description Connection status */
|
|
1149
|
-
status: string;
|
|
1150
|
-
/**
|
|
1151
|
-
* Format: uuid
|
|
1152
|
-
* @description Associated credential ID
|
|
1153
|
-
*/
|
|
1154
|
-
credentialId?: string;
|
|
526
|
+
/** @description Internal server error */
|
|
527
|
+
500: {
|
|
528
|
+
headers: {
|
|
529
|
+
[name: string]: unknown;
|
|
530
|
+
};
|
|
531
|
+
content: {
|
|
532
|
+
"text/plain": string;
|
|
533
|
+
};
|
|
1155
534
|
};
|
|
1156
|
-
};
|
|
1157
535
|
};
|
|
1158
|
-
};
|
|
1159
|
-
/** Delete a specific connection */
|
|
1160
|
-
deleteConnection: {
|
|
1161
536
|
parameters: {
|
|
1162
|
-
|
|
1163
|
-
/** Connection ID */
|
|
537
|
+
/** @description Connection ID */
|
|
1164
538
|
connectionId: string;
|
|
1165
|
-
|
|
539
|
+
/** @description Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
540
|
+
connectionKind: string;
|
|
541
|
+
/** @description Environment ID */
|
|
542
|
+
environmentId: string;
|
|
543
|
+
/** @description Page number */
|
|
544
|
+
page: number;
|
|
545
|
+
/** @description Number of items per page */
|
|
546
|
+
pagesize: number;
|
|
547
|
+
/** @description Search term */
|
|
548
|
+
search: string;
|
|
549
|
+
/** @description Sort order */
|
|
550
|
+
order: string;
|
|
1166
551
|
};
|
|
1167
|
-
|
|
1168
|
-
|
|
1169
|
-
|
|
1170
|
-
|
|
1171
|
-
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
552
|
+
requestBodies: never;
|
|
553
|
+
headers: never;
|
|
554
|
+
pathItems: never;
|
|
555
|
+
}
|
|
556
|
+
export type $defs = Record<string, never>;
|
|
557
|
+
export interface operations {
|
|
558
|
+
getConnections: {
|
|
559
|
+
parameters: {
|
|
560
|
+
query?: {
|
|
561
|
+
/** @description Page number */
|
|
562
|
+
page?: number;
|
|
563
|
+
/** @description Number of items per page */
|
|
564
|
+
pagesize?: number;
|
|
565
|
+
/** @description Search term */
|
|
566
|
+
search?: string;
|
|
567
|
+
/** @description Sort order */
|
|
568
|
+
order?: string;
|
|
569
|
+
/** @description Filter connections (general filter string) */
|
|
570
|
+
filter?: string;
|
|
571
|
+
/** @description Filter by connection kind (e.g., kubernetes, prometheus, grafana) */
|
|
572
|
+
kind?: string[];
|
|
573
|
+
/** @description Filter by connection status */
|
|
574
|
+
status?: ("discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found")[];
|
|
575
|
+
/** @description Filter by connection type */
|
|
576
|
+
type?: string[];
|
|
577
|
+
/** @description Filter by connection name (partial match supported) */
|
|
578
|
+
name?: string;
|
|
579
|
+
};
|
|
580
|
+
header?: never;
|
|
581
|
+
path?: never;
|
|
582
|
+
cookie?: never;
|
|
1180
583
|
};
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
584
|
+
requestBody?: never;
|
|
585
|
+
responses: {
|
|
586
|
+
/** @description Paginated list of connections with summary information */
|
|
587
|
+
200: {
|
|
588
|
+
headers: {
|
|
589
|
+
[name: string]: unknown;
|
|
590
|
+
};
|
|
591
|
+
content: {
|
|
592
|
+
"application/json": {
|
|
593
|
+
/** @description List of connections on this page */
|
|
594
|
+
connections: {
|
|
595
|
+
/**
|
|
596
|
+
* Format: uuid
|
|
597
|
+
* @description Connection ID
|
|
598
|
+
*/
|
|
599
|
+
id: string;
|
|
600
|
+
/** @description Connection Name */
|
|
601
|
+
name: string;
|
|
602
|
+
/**
|
|
603
|
+
* Format: uuid
|
|
604
|
+
* @description Associated Credential ID
|
|
605
|
+
*/
|
|
606
|
+
credential_id?: string;
|
|
607
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
608
|
+
type: string;
|
|
609
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
610
|
+
sub_type: string;
|
|
611
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
612
|
+
kind: string;
|
|
613
|
+
/** @description Additional connection metadata */
|
|
614
|
+
metadata?: Record<string, never>;
|
|
615
|
+
/**
|
|
616
|
+
* @description Connection Status
|
|
617
|
+
* @enum {string}
|
|
618
|
+
*/
|
|
619
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
620
|
+
/**
|
|
621
|
+
* Format: uuid
|
|
622
|
+
* @description User ID who owns this connection
|
|
623
|
+
*/
|
|
624
|
+
user_id?: string;
|
|
625
|
+
/** Format: date-time */
|
|
626
|
+
created_at?: string;
|
|
627
|
+
/** Format: date-time */
|
|
628
|
+
updated_at?: string;
|
|
629
|
+
/**
|
|
630
|
+
* Format: date-time
|
|
631
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
632
|
+
*/
|
|
633
|
+
deleted_at?: string;
|
|
634
|
+
/** @description Associated environments for this connection */
|
|
635
|
+
environments?: {
|
|
636
|
+
/**
|
|
637
|
+
* Format: uuid
|
|
638
|
+
* @description ID
|
|
639
|
+
*/
|
|
640
|
+
id: string;
|
|
641
|
+
/**
|
|
642
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
643
|
+
* @default environments.meshery.io/v1beta1
|
|
644
|
+
* @example [
|
|
645
|
+
* "v1",
|
|
646
|
+
* "v1alpha1",
|
|
647
|
+
* "v2beta3",
|
|
648
|
+
* "v1.custom-suffix",
|
|
649
|
+
* "models.meshery.io/v1beta1",
|
|
650
|
+
* "capability.meshery.io/v1alpha1"
|
|
651
|
+
* ]
|
|
652
|
+
*/
|
|
653
|
+
schemaVersion: string;
|
|
654
|
+
/** @description Environment name */
|
|
655
|
+
name: string;
|
|
656
|
+
/** @description Environment description */
|
|
657
|
+
description: string;
|
|
658
|
+
/**
|
|
659
|
+
* Format: uuid
|
|
660
|
+
* @description Environment organization ID
|
|
661
|
+
*/
|
|
662
|
+
organization_id: string;
|
|
663
|
+
/**
|
|
664
|
+
* Format: uuid
|
|
665
|
+
* @description Environment owner
|
|
666
|
+
*/
|
|
667
|
+
owner?: string;
|
|
668
|
+
/**
|
|
669
|
+
* Format: date-time
|
|
670
|
+
* @description Timestamp when the resource was created.
|
|
671
|
+
*/
|
|
672
|
+
created_at?: string;
|
|
673
|
+
/** @description Additional metadata associated with the environment. */
|
|
674
|
+
metadata?: Record<string, never>;
|
|
675
|
+
/**
|
|
676
|
+
* Format: date-time
|
|
677
|
+
* @description Timestamp when the resource was updated.
|
|
678
|
+
*/
|
|
679
|
+
updated_at?: string;
|
|
680
|
+
/**
|
|
681
|
+
* Format: date-time
|
|
682
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
683
|
+
*/
|
|
684
|
+
deleted_at?: string | null;
|
|
685
|
+
}[];
|
|
686
|
+
/**
|
|
687
|
+
* @description Specifies the version of the schema used for the definition.
|
|
688
|
+
* @default connections.meshery.io/v1beta2
|
|
689
|
+
* @example [
|
|
690
|
+
* "v1",
|
|
691
|
+
* "v1alpha1",
|
|
692
|
+
* "v2beta3",
|
|
693
|
+
* "v1.custom-suffix",
|
|
694
|
+
* "models.meshery.io/v1beta1",
|
|
695
|
+
* "capability.meshery.io/v1alpha1"
|
|
696
|
+
* ]
|
|
697
|
+
*/
|
|
698
|
+
schemaVersion: string;
|
|
699
|
+
}[];
|
|
700
|
+
/** @description Total number of connections on all pages */
|
|
701
|
+
total_count: number;
|
|
702
|
+
/** @description Current page number */
|
|
703
|
+
page: number;
|
|
704
|
+
/** @description Number of elements per page */
|
|
705
|
+
page_size: number;
|
|
706
|
+
/** @description Aggregate count of connections grouped by status */
|
|
707
|
+
statusSummary?: {
|
|
708
|
+
[key: string]: number;
|
|
709
|
+
};
|
|
710
|
+
};
|
|
711
|
+
};
|
|
712
|
+
};
|
|
713
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
714
|
+
401: {
|
|
715
|
+
headers: {
|
|
716
|
+
[name: string]: unknown;
|
|
717
|
+
};
|
|
718
|
+
content: {
|
|
719
|
+
"text/plain": string;
|
|
720
|
+
};
|
|
721
|
+
};
|
|
722
|
+
/** @description Internal server error */
|
|
723
|
+
500: {
|
|
724
|
+
headers: {
|
|
725
|
+
[name: string]: unknown;
|
|
726
|
+
};
|
|
727
|
+
content: {
|
|
728
|
+
"text/plain": string;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
1186
731
|
};
|
|
1187
|
-
};
|
|
1188
732
|
};
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
|
|
1195
|
-
mesheryServerId: string;
|
|
1196
|
-
};
|
|
1197
|
-
};
|
|
1198
|
-
responses: {
|
|
1199
|
-
/** Meshery connection deleted */
|
|
1200
|
-
204: never;
|
|
1201
|
-
/** Expired JWT token used or insufficient privilege */
|
|
1202
|
-
401: {
|
|
1203
|
-
content: {
|
|
1204
|
-
"text/plain": string;
|
|
733
|
+
registerConnection: {
|
|
734
|
+
parameters: {
|
|
735
|
+
query?: never;
|
|
736
|
+
header?: never;
|
|
737
|
+
path?: never;
|
|
738
|
+
cookie?: never;
|
|
1205
739
|
};
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
740
|
+
requestBody: {
|
|
741
|
+
content: {
|
|
742
|
+
"application/json": {
|
|
743
|
+
/**
|
|
744
|
+
* Format: uuid
|
|
745
|
+
* @description Connection ID
|
|
746
|
+
*/
|
|
747
|
+
id?: string;
|
|
748
|
+
/** @description Connection name */
|
|
749
|
+
name: string;
|
|
750
|
+
/** @description Connection kind */
|
|
751
|
+
kind: string;
|
|
752
|
+
/** @description Connection type */
|
|
753
|
+
type: string;
|
|
754
|
+
/** @description Connection sub-type */
|
|
755
|
+
subType: string;
|
|
756
|
+
/** @description Credential secret data */
|
|
757
|
+
credentialSecret?: Record<string, never>;
|
|
758
|
+
/** @description Connection metadata */
|
|
759
|
+
metadata?: Record<string, never>;
|
|
760
|
+
/** @description Connection status */
|
|
761
|
+
status: string;
|
|
762
|
+
/**
|
|
763
|
+
* Format: uuid
|
|
764
|
+
* @description Associated credential ID
|
|
765
|
+
*/
|
|
766
|
+
credentialId?: string;
|
|
767
|
+
};
|
|
768
|
+
};
|
|
1211
769
|
};
|
|
1212
|
-
|
|
1213
|
-
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
770
|
+
responses: {
|
|
771
|
+
/** @description Connection registered */
|
|
772
|
+
201: {
|
|
773
|
+
headers: {
|
|
774
|
+
[name: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
content: {
|
|
777
|
+
"application/json": {
|
|
778
|
+
/**
|
|
779
|
+
* Format: uuid
|
|
780
|
+
* @description Connection ID
|
|
781
|
+
*/
|
|
782
|
+
id: string;
|
|
783
|
+
/** @description Connection Name */
|
|
784
|
+
name: string;
|
|
785
|
+
/**
|
|
786
|
+
* Format: uuid
|
|
787
|
+
* @description Associated Credential ID
|
|
788
|
+
*/
|
|
789
|
+
credential_id?: string;
|
|
790
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
791
|
+
type: string;
|
|
792
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
793
|
+
sub_type: string;
|
|
794
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
795
|
+
kind: string;
|
|
796
|
+
/** @description Additional connection metadata */
|
|
797
|
+
metadata?: Record<string, never>;
|
|
798
|
+
/**
|
|
799
|
+
* @description Connection Status
|
|
800
|
+
* @enum {string}
|
|
801
|
+
*/
|
|
802
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
803
|
+
/**
|
|
804
|
+
* Format: uuid
|
|
805
|
+
* @description User ID who owns this connection
|
|
806
|
+
*/
|
|
807
|
+
user_id?: string;
|
|
808
|
+
/** Format: date-time */
|
|
809
|
+
created_at?: string;
|
|
810
|
+
/** Format: date-time */
|
|
811
|
+
updated_at?: string;
|
|
812
|
+
/**
|
|
813
|
+
* Format: date-time
|
|
814
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
815
|
+
*/
|
|
816
|
+
deleted_at?: string;
|
|
817
|
+
/** @description Associated environments for this connection */
|
|
818
|
+
environments?: {
|
|
819
|
+
/**
|
|
820
|
+
* Format: uuid
|
|
821
|
+
* @description ID
|
|
822
|
+
*/
|
|
823
|
+
id: string;
|
|
824
|
+
/**
|
|
825
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
826
|
+
* @default environments.meshery.io/v1beta1
|
|
827
|
+
* @example [
|
|
828
|
+
* "v1",
|
|
829
|
+
* "v1alpha1",
|
|
830
|
+
* "v2beta3",
|
|
831
|
+
* "v1.custom-suffix",
|
|
832
|
+
* "models.meshery.io/v1beta1",
|
|
833
|
+
* "capability.meshery.io/v1alpha1"
|
|
834
|
+
* ]
|
|
835
|
+
*/
|
|
836
|
+
schemaVersion: string;
|
|
837
|
+
/** @description Environment name */
|
|
838
|
+
name: string;
|
|
839
|
+
/** @description Environment description */
|
|
840
|
+
description: string;
|
|
841
|
+
/**
|
|
842
|
+
* Format: uuid
|
|
843
|
+
* @description Environment organization ID
|
|
844
|
+
*/
|
|
845
|
+
organization_id: string;
|
|
846
|
+
/**
|
|
847
|
+
* Format: uuid
|
|
848
|
+
* @description Environment owner
|
|
849
|
+
*/
|
|
850
|
+
owner?: string;
|
|
851
|
+
/**
|
|
852
|
+
* Format: date-time
|
|
853
|
+
* @description Timestamp when the resource was created.
|
|
854
|
+
*/
|
|
855
|
+
created_at?: string;
|
|
856
|
+
/** @description Additional metadata associated with the environment. */
|
|
857
|
+
metadata?: Record<string, never>;
|
|
858
|
+
/**
|
|
859
|
+
* Format: date-time
|
|
860
|
+
* @description Timestamp when the resource was updated.
|
|
861
|
+
*/
|
|
862
|
+
updated_at?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Format: date-time
|
|
865
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
866
|
+
*/
|
|
867
|
+
deleted_at?: string | null;
|
|
868
|
+
}[];
|
|
869
|
+
/**
|
|
870
|
+
* @description Specifies the version of the schema used for the definition.
|
|
871
|
+
* @default connections.meshery.io/v1beta2
|
|
872
|
+
* @example [
|
|
873
|
+
* "v1",
|
|
874
|
+
* "v1alpha1",
|
|
875
|
+
* "v2beta3",
|
|
876
|
+
* "v1.custom-suffix",
|
|
877
|
+
* "models.meshery.io/v1beta1",
|
|
878
|
+
* "capability.meshery.io/v1alpha1"
|
|
879
|
+
* ]
|
|
880
|
+
*/
|
|
881
|
+
schemaVersion: string;
|
|
882
|
+
};
|
|
883
|
+
};
|
|
884
|
+
};
|
|
885
|
+
/** @description Invalid request body or request param */
|
|
886
|
+
400: {
|
|
887
|
+
headers: {
|
|
888
|
+
[name: string]: unknown;
|
|
889
|
+
};
|
|
890
|
+
content: {
|
|
891
|
+
"text/plain": string;
|
|
892
|
+
};
|
|
893
|
+
};
|
|
894
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
895
|
+
401: {
|
|
896
|
+
headers: {
|
|
897
|
+
[name: string]: unknown;
|
|
898
|
+
};
|
|
899
|
+
content: {
|
|
900
|
+
"text/plain": string;
|
|
901
|
+
};
|
|
902
|
+
};
|
|
903
|
+
/** @description Internal server error */
|
|
904
|
+
500: {
|
|
905
|
+
headers: {
|
|
906
|
+
[name: string]: unknown;
|
|
907
|
+
};
|
|
908
|
+
content: {
|
|
909
|
+
"text/plain": string;
|
|
910
|
+
};
|
|
911
|
+
};
|
|
1217
912
|
};
|
|
1218
|
-
};
|
|
1219
913
|
};
|
|
1220
|
-
|
|
1221
|
-
|
|
1222
|
-
|
|
1223
|
-
|
|
1224
|
-
|
|
1225
|
-
|
|
1226
|
-
|
|
1227
|
-
|
|
1228
|
-
|
|
1229
|
-
responses: {
|
|
1230
|
-
/** Kubernetes context */
|
|
1231
|
-
200: {
|
|
1232
|
-
content: {
|
|
1233
|
-
"application/json": { [key: string]: unknown };
|
|
914
|
+
getConnectionById: {
|
|
915
|
+
parameters: {
|
|
916
|
+
query?: never;
|
|
917
|
+
header?: never;
|
|
918
|
+
path: {
|
|
919
|
+
/** @description Connection ID */
|
|
920
|
+
connectionId: string;
|
|
921
|
+
};
|
|
922
|
+
cookie?: never;
|
|
1234
923
|
};
|
|
1235
|
-
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1239
|
-
|
|
924
|
+
requestBody?: never;
|
|
925
|
+
responses: {
|
|
926
|
+
/** @description Connection details */
|
|
927
|
+
200: {
|
|
928
|
+
headers: {
|
|
929
|
+
[name: string]: unknown;
|
|
930
|
+
};
|
|
931
|
+
content: {
|
|
932
|
+
"application/json": {
|
|
933
|
+
/**
|
|
934
|
+
* Format: uuid
|
|
935
|
+
* @description Connection ID
|
|
936
|
+
*/
|
|
937
|
+
id: string;
|
|
938
|
+
/** @description Connection Name */
|
|
939
|
+
name: string;
|
|
940
|
+
/**
|
|
941
|
+
* Format: uuid
|
|
942
|
+
* @description Associated Credential ID
|
|
943
|
+
*/
|
|
944
|
+
credential_id?: string;
|
|
945
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
946
|
+
type: string;
|
|
947
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
948
|
+
sub_type: string;
|
|
949
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
950
|
+
kind: string;
|
|
951
|
+
/** @description Additional connection metadata */
|
|
952
|
+
metadata?: Record<string, never>;
|
|
953
|
+
/**
|
|
954
|
+
* @description Connection Status
|
|
955
|
+
* @enum {string}
|
|
956
|
+
*/
|
|
957
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
958
|
+
/**
|
|
959
|
+
* Format: uuid
|
|
960
|
+
* @description User ID who owns this connection
|
|
961
|
+
*/
|
|
962
|
+
user_id?: string;
|
|
963
|
+
/** Format: date-time */
|
|
964
|
+
created_at?: string;
|
|
965
|
+
/** Format: date-time */
|
|
966
|
+
updated_at?: string;
|
|
967
|
+
/**
|
|
968
|
+
* Format: date-time
|
|
969
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
970
|
+
*/
|
|
971
|
+
deleted_at?: string;
|
|
972
|
+
/** @description Associated environments for this connection */
|
|
973
|
+
environments?: {
|
|
974
|
+
/**
|
|
975
|
+
* Format: uuid
|
|
976
|
+
* @description ID
|
|
977
|
+
*/
|
|
978
|
+
id: string;
|
|
979
|
+
/**
|
|
980
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
981
|
+
* @default environments.meshery.io/v1beta1
|
|
982
|
+
* @example [
|
|
983
|
+
* "v1",
|
|
984
|
+
* "v1alpha1",
|
|
985
|
+
* "v2beta3",
|
|
986
|
+
* "v1.custom-suffix",
|
|
987
|
+
* "models.meshery.io/v1beta1",
|
|
988
|
+
* "capability.meshery.io/v1alpha1"
|
|
989
|
+
* ]
|
|
990
|
+
*/
|
|
991
|
+
schemaVersion: string;
|
|
992
|
+
/** @description Environment name */
|
|
993
|
+
name: string;
|
|
994
|
+
/** @description Environment description */
|
|
995
|
+
description: string;
|
|
996
|
+
/**
|
|
997
|
+
* Format: uuid
|
|
998
|
+
* @description Environment organization ID
|
|
999
|
+
*/
|
|
1000
|
+
organization_id: string;
|
|
1001
|
+
/**
|
|
1002
|
+
* Format: uuid
|
|
1003
|
+
* @description Environment owner
|
|
1004
|
+
*/
|
|
1005
|
+
owner?: string;
|
|
1006
|
+
/**
|
|
1007
|
+
* Format: date-time
|
|
1008
|
+
* @description Timestamp when the resource was created.
|
|
1009
|
+
*/
|
|
1010
|
+
created_at?: string;
|
|
1011
|
+
/** @description Additional metadata associated with the environment. */
|
|
1012
|
+
metadata?: Record<string, never>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Format: date-time
|
|
1015
|
+
* @description Timestamp when the resource was updated.
|
|
1016
|
+
*/
|
|
1017
|
+
updated_at?: string;
|
|
1018
|
+
/**
|
|
1019
|
+
* Format: date-time
|
|
1020
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
1021
|
+
*/
|
|
1022
|
+
deleted_at?: string | null;
|
|
1023
|
+
}[];
|
|
1024
|
+
/**
|
|
1025
|
+
* @description Specifies the version of the schema used for the definition.
|
|
1026
|
+
* @default connections.meshery.io/v1beta2
|
|
1027
|
+
* @example [
|
|
1028
|
+
* "v1",
|
|
1029
|
+
* "v1alpha1",
|
|
1030
|
+
* "v2beta3",
|
|
1031
|
+
* "v1.custom-suffix",
|
|
1032
|
+
* "models.meshery.io/v1beta1",
|
|
1033
|
+
* "capability.meshery.io/v1alpha1"
|
|
1034
|
+
* ]
|
|
1035
|
+
*/
|
|
1036
|
+
schemaVersion: string;
|
|
1037
|
+
};
|
|
1038
|
+
};
|
|
1039
|
+
};
|
|
1040
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1041
|
+
401: {
|
|
1042
|
+
headers: {
|
|
1043
|
+
[name: string]: unknown;
|
|
1044
|
+
};
|
|
1045
|
+
content: {
|
|
1046
|
+
"text/plain": string;
|
|
1047
|
+
};
|
|
1048
|
+
};
|
|
1049
|
+
/** @description Result not found */
|
|
1050
|
+
404: {
|
|
1051
|
+
headers: {
|
|
1052
|
+
[name: string]: unknown;
|
|
1053
|
+
};
|
|
1054
|
+
content: {
|
|
1055
|
+
"text/plain": string;
|
|
1056
|
+
};
|
|
1057
|
+
};
|
|
1058
|
+
/** @description Internal server error */
|
|
1059
|
+
500: {
|
|
1060
|
+
headers: {
|
|
1061
|
+
[name: string]: unknown;
|
|
1062
|
+
};
|
|
1063
|
+
content: {
|
|
1064
|
+
"text/plain": string;
|
|
1065
|
+
};
|
|
1066
|
+
};
|
|
1240
1067
|
};
|
|
1241
|
-
|
|
1242
|
-
|
|
1243
|
-
|
|
1244
|
-
|
|
1245
|
-
|
|
1068
|
+
};
|
|
1069
|
+
updateConnection: {
|
|
1070
|
+
parameters: {
|
|
1071
|
+
query?: never;
|
|
1072
|
+
header?: never;
|
|
1073
|
+
path: {
|
|
1074
|
+
/** @description Connection ID */
|
|
1075
|
+
connectionId: string;
|
|
1076
|
+
};
|
|
1077
|
+
cookie?: never;
|
|
1246
1078
|
};
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1079
|
+
requestBody: {
|
|
1080
|
+
content: {
|
|
1081
|
+
"application/json": {
|
|
1082
|
+
/**
|
|
1083
|
+
* Format: uuid
|
|
1084
|
+
* @description Connection ID
|
|
1085
|
+
*/
|
|
1086
|
+
id?: string;
|
|
1087
|
+
/** @description Connection name */
|
|
1088
|
+
name: string;
|
|
1089
|
+
/** @description Connection kind */
|
|
1090
|
+
kind: string;
|
|
1091
|
+
/** @description Connection type */
|
|
1092
|
+
type: string;
|
|
1093
|
+
/** @description Connection sub-type */
|
|
1094
|
+
subType: string;
|
|
1095
|
+
/** @description Credential secret data */
|
|
1096
|
+
credentialSecret?: Record<string, never>;
|
|
1097
|
+
/** @description Connection metadata */
|
|
1098
|
+
metadata?: Record<string, never>;
|
|
1099
|
+
/** @description Connection status */
|
|
1100
|
+
status: string;
|
|
1101
|
+
/**
|
|
1102
|
+
* Format: uuid
|
|
1103
|
+
* @description Associated credential ID
|
|
1104
|
+
*/
|
|
1105
|
+
credentialId?: string;
|
|
1106
|
+
};
|
|
1107
|
+
};
|
|
1108
|
+
};
|
|
1109
|
+
responses: {
|
|
1110
|
+
/** @description Connection updated */
|
|
1111
|
+
200: {
|
|
1112
|
+
headers: {
|
|
1113
|
+
[name: string]: unknown;
|
|
1114
|
+
};
|
|
1115
|
+
content: {
|
|
1116
|
+
"application/json": {
|
|
1117
|
+
/**
|
|
1118
|
+
* Format: uuid
|
|
1119
|
+
* @description Connection ID
|
|
1120
|
+
*/
|
|
1121
|
+
id: string;
|
|
1122
|
+
/** @description Connection Name */
|
|
1123
|
+
name: string;
|
|
1124
|
+
/**
|
|
1125
|
+
* Format: uuid
|
|
1126
|
+
* @description Associated Credential ID
|
|
1127
|
+
*/
|
|
1128
|
+
credential_id?: string;
|
|
1129
|
+
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
1130
|
+
type: string;
|
|
1131
|
+
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
1132
|
+
sub_type: string;
|
|
1133
|
+
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
1134
|
+
kind: string;
|
|
1135
|
+
/** @description Additional connection metadata */
|
|
1136
|
+
metadata?: Record<string, never>;
|
|
1137
|
+
/**
|
|
1138
|
+
* @description Connection Status
|
|
1139
|
+
* @enum {string}
|
|
1140
|
+
*/
|
|
1141
|
+
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
1142
|
+
/**
|
|
1143
|
+
* Format: uuid
|
|
1144
|
+
* @description User ID who owns this connection
|
|
1145
|
+
*/
|
|
1146
|
+
user_id?: string;
|
|
1147
|
+
/** Format: date-time */
|
|
1148
|
+
created_at?: string;
|
|
1149
|
+
/** Format: date-time */
|
|
1150
|
+
updated_at?: string;
|
|
1151
|
+
/**
|
|
1152
|
+
* Format: date-time
|
|
1153
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
1154
|
+
*/
|
|
1155
|
+
deleted_at?: string;
|
|
1156
|
+
/** @description Associated environments for this connection */
|
|
1157
|
+
environments?: {
|
|
1158
|
+
/**
|
|
1159
|
+
* Format: uuid
|
|
1160
|
+
* @description ID
|
|
1161
|
+
*/
|
|
1162
|
+
id: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
1165
|
+
* @default environments.meshery.io/v1beta1
|
|
1166
|
+
* @example [
|
|
1167
|
+
* "v1",
|
|
1168
|
+
* "v1alpha1",
|
|
1169
|
+
* "v2beta3",
|
|
1170
|
+
* "v1.custom-suffix",
|
|
1171
|
+
* "models.meshery.io/v1beta1",
|
|
1172
|
+
* "capability.meshery.io/v1alpha1"
|
|
1173
|
+
* ]
|
|
1174
|
+
*/
|
|
1175
|
+
schemaVersion: string;
|
|
1176
|
+
/** @description Environment name */
|
|
1177
|
+
name: string;
|
|
1178
|
+
/** @description Environment description */
|
|
1179
|
+
description: string;
|
|
1180
|
+
/**
|
|
1181
|
+
* Format: uuid
|
|
1182
|
+
* @description Environment organization ID
|
|
1183
|
+
*/
|
|
1184
|
+
organization_id: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* Format: uuid
|
|
1187
|
+
* @description Environment owner
|
|
1188
|
+
*/
|
|
1189
|
+
owner?: string;
|
|
1190
|
+
/**
|
|
1191
|
+
* Format: date-time
|
|
1192
|
+
* @description Timestamp when the resource was created.
|
|
1193
|
+
*/
|
|
1194
|
+
created_at?: string;
|
|
1195
|
+
/** @description Additional metadata associated with the environment. */
|
|
1196
|
+
metadata?: Record<string, never>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Format: date-time
|
|
1199
|
+
* @description Timestamp when the resource was updated.
|
|
1200
|
+
*/
|
|
1201
|
+
updated_at?: string;
|
|
1202
|
+
/**
|
|
1203
|
+
* Format: date-time
|
|
1204
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
1205
|
+
*/
|
|
1206
|
+
deleted_at?: string | null;
|
|
1207
|
+
}[];
|
|
1208
|
+
/**
|
|
1209
|
+
* @description Specifies the version of the schema used for the definition.
|
|
1210
|
+
* @default connections.meshery.io/v1beta2
|
|
1211
|
+
* @example [
|
|
1212
|
+
* "v1",
|
|
1213
|
+
* "v1alpha1",
|
|
1214
|
+
* "v2beta3",
|
|
1215
|
+
* "v1.custom-suffix",
|
|
1216
|
+
* "models.meshery.io/v1beta1",
|
|
1217
|
+
* "capability.meshery.io/v1alpha1"
|
|
1218
|
+
* ]
|
|
1219
|
+
*/
|
|
1220
|
+
schemaVersion: string;
|
|
1221
|
+
};
|
|
1222
|
+
};
|
|
1223
|
+
};
|
|
1224
|
+
/** @description Invalid request body or request param */
|
|
1225
|
+
400: {
|
|
1226
|
+
headers: {
|
|
1227
|
+
[name: string]: unknown;
|
|
1228
|
+
};
|
|
1229
|
+
content: {
|
|
1230
|
+
"text/plain": string;
|
|
1231
|
+
};
|
|
1232
|
+
};
|
|
1233
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1234
|
+
401: {
|
|
1235
|
+
headers: {
|
|
1236
|
+
[name: string]: unknown;
|
|
1237
|
+
};
|
|
1238
|
+
content: {
|
|
1239
|
+
"text/plain": string;
|
|
1240
|
+
};
|
|
1241
|
+
};
|
|
1242
|
+
/** @description Result not found */
|
|
1243
|
+
404: {
|
|
1244
|
+
headers: {
|
|
1245
|
+
[name: string]: unknown;
|
|
1246
|
+
};
|
|
1247
|
+
content: {
|
|
1248
|
+
"text/plain": string;
|
|
1249
|
+
};
|
|
1250
|
+
};
|
|
1251
|
+
/** @description Internal server error */
|
|
1252
|
+
500: {
|
|
1253
|
+
headers: {
|
|
1254
|
+
[name: string]: unknown;
|
|
1255
|
+
};
|
|
1256
|
+
content: {
|
|
1257
|
+
"text/plain": string;
|
|
1258
|
+
};
|
|
1259
|
+
};
|
|
1252
1260
|
};
|
|
1253
|
-
};
|
|
1254
|
-
};
|
|
1255
|
-
};
|
|
1256
|
-
/** Associate a connection with an environment */
|
|
1257
|
-
addConnectionToEnvironment: {
|
|
1258
|
-
parameters: {
|
|
1259
|
-
path: {
|
|
1260
|
-
/** Environment ID */
|
|
1261
|
-
environmentId: string;
|
|
1262
|
-
/** Connection ID */
|
|
1263
|
-
connectionId: string;
|
|
1264
|
-
};
|
|
1265
1261
|
};
|
|
1266
|
-
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1271
|
-
|
|
1272
|
-
|
|
1262
|
+
deleteConnection: {
|
|
1263
|
+
parameters: {
|
|
1264
|
+
query?: never;
|
|
1265
|
+
header?: never;
|
|
1266
|
+
path: {
|
|
1267
|
+
/** @description Connection ID */
|
|
1268
|
+
connectionId: string;
|
|
1269
|
+
};
|
|
1270
|
+
cookie?: never;
|
|
1273
1271
|
};
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
|
|
1278
|
-
|
|
1272
|
+
requestBody?: never;
|
|
1273
|
+
responses: {
|
|
1274
|
+
/** @description Connection deleted */
|
|
1275
|
+
204: {
|
|
1276
|
+
headers: {
|
|
1277
|
+
[name: string]: unknown;
|
|
1278
|
+
};
|
|
1279
|
+
content?: never;
|
|
1280
|
+
};
|
|
1281
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1282
|
+
401: {
|
|
1283
|
+
headers: {
|
|
1284
|
+
[name: string]: unknown;
|
|
1285
|
+
};
|
|
1286
|
+
content: {
|
|
1287
|
+
"text/plain": string;
|
|
1288
|
+
};
|
|
1289
|
+
};
|
|
1290
|
+
/** @description Result not found */
|
|
1291
|
+
404: {
|
|
1292
|
+
headers: {
|
|
1293
|
+
[name: string]: unknown;
|
|
1294
|
+
};
|
|
1295
|
+
content: {
|
|
1296
|
+
"text/plain": string;
|
|
1297
|
+
};
|
|
1298
|
+
};
|
|
1299
|
+
/** @description Internal server error */
|
|
1300
|
+
500: {
|
|
1301
|
+
headers: {
|
|
1302
|
+
[name: string]: unknown;
|
|
1303
|
+
};
|
|
1304
|
+
content: {
|
|
1305
|
+
"text/plain": string;
|
|
1306
|
+
};
|
|
1307
|
+
};
|
|
1279
1308
|
};
|
|
1280
|
-
|
|
1281
|
-
|
|
1282
|
-
|
|
1283
|
-
|
|
1284
|
-
|
|
1309
|
+
};
|
|
1310
|
+
deleteMesheryConnection: {
|
|
1311
|
+
parameters: {
|
|
1312
|
+
query?: never;
|
|
1313
|
+
header?: never;
|
|
1314
|
+
path: {
|
|
1315
|
+
/** @description Meshery server ID */
|
|
1316
|
+
mesheryServerId: string;
|
|
1317
|
+
};
|
|
1318
|
+
cookie?: never;
|
|
1285
1319
|
};
|
|
1286
|
-
|
|
1287
|
-
|
|
1288
|
-
|
|
1289
|
-
|
|
1290
|
-
|
|
1320
|
+
requestBody?: never;
|
|
1321
|
+
responses: {
|
|
1322
|
+
/** @description Meshery connection deleted */
|
|
1323
|
+
204: {
|
|
1324
|
+
headers: {
|
|
1325
|
+
[name: string]: unknown;
|
|
1326
|
+
};
|
|
1327
|
+
content?: never;
|
|
1328
|
+
};
|
|
1329
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1330
|
+
401: {
|
|
1331
|
+
headers: {
|
|
1332
|
+
[name: string]: unknown;
|
|
1333
|
+
};
|
|
1334
|
+
content: {
|
|
1335
|
+
"text/plain": string;
|
|
1336
|
+
};
|
|
1337
|
+
};
|
|
1338
|
+
/** @description Result not found */
|
|
1339
|
+
404: {
|
|
1340
|
+
headers: {
|
|
1341
|
+
[name: string]: unknown;
|
|
1342
|
+
};
|
|
1343
|
+
content: {
|
|
1344
|
+
"text/plain": string;
|
|
1345
|
+
};
|
|
1346
|
+
};
|
|
1347
|
+
/** @description Internal server error */
|
|
1348
|
+
500: {
|
|
1349
|
+
headers: {
|
|
1350
|
+
[name: string]: unknown;
|
|
1351
|
+
};
|
|
1352
|
+
content: {
|
|
1353
|
+
"text/plain": string;
|
|
1354
|
+
};
|
|
1355
|
+
};
|
|
1291
1356
|
};
|
|
1292
|
-
};
|
|
1293
1357
|
};
|
|
1294
|
-
|
|
1295
|
-
|
|
1296
|
-
|
|
1297
|
-
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
|
|
1302
|
-
|
|
1303
|
-
|
|
1358
|
+
getKubernetesContext: {
|
|
1359
|
+
parameters: {
|
|
1360
|
+
query?: never;
|
|
1361
|
+
header?: never;
|
|
1362
|
+
path: {
|
|
1363
|
+
/** @description Connection ID */
|
|
1364
|
+
connectionId: string;
|
|
1365
|
+
};
|
|
1366
|
+
cookie?: never;
|
|
1367
|
+
};
|
|
1368
|
+
requestBody?: never;
|
|
1369
|
+
responses: {
|
|
1370
|
+
/** @description Kubernetes context */
|
|
1371
|
+
200: {
|
|
1372
|
+
headers: {
|
|
1373
|
+
[name: string]: unknown;
|
|
1374
|
+
};
|
|
1375
|
+
content: {
|
|
1376
|
+
"application/json": Record<string, never>;
|
|
1377
|
+
};
|
|
1378
|
+
};
|
|
1379
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1380
|
+
401: {
|
|
1381
|
+
headers: {
|
|
1382
|
+
[name: string]: unknown;
|
|
1383
|
+
};
|
|
1384
|
+
content: {
|
|
1385
|
+
"text/plain": string;
|
|
1386
|
+
};
|
|
1387
|
+
};
|
|
1388
|
+
/** @description Result not found */
|
|
1389
|
+
404: {
|
|
1390
|
+
headers: {
|
|
1391
|
+
[name: string]: unknown;
|
|
1392
|
+
};
|
|
1393
|
+
content: {
|
|
1394
|
+
"text/plain": string;
|
|
1395
|
+
};
|
|
1396
|
+
};
|
|
1397
|
+
/** @description Internal server error */
|
|
1398
|
+
500: {
|
|
1399
|
+
headers: {
|
|
1400
|
+
[name: string]: unknown;
|
|
1401
|
+
};
|
|
1402
|
+
content: {
|
|
1403
|
+
"text/plain": string;
|
|
1404
|
+
};
|
|
1405
|
+
};
|
|
1406
|
+
};
|
|
1304
1407
|
};
|
|
1305
|
-
|
|
1306
|
-
|
|
1307
|
-
|
|
1308
|
-
|
|
1309
|
-
|
|
1310
|
-
|
|
1311
|
-
|
|
1408
|
+
addConnectionToEnvironment: {
|
|
1409
|
+
parameters: {
|
|
1410
|
+
query?: never;
|
|
1411
|
+
header?: never;
|
|
1412
|
+
path: {
|
|
1413
|
+
/** @description Environment ID */
|
|
1414
|
+
environmentId: string;
|
|
1415
|
+
/** @description Connection ID */
|
|
1416
|
+
connectionId: string;
|
|
1417
|
+
};
|
|
1418
|
+
cookie?: never;
|
|
1419
|
+
};
|
|
1420
|
+
requestBody?: never;
|
|
1421
|
+
responses: {
|
|
1422
|
+
/** @description Connection added to environment */
|
|
1423
|
+
201: {
|
|
1424
|
+
headers: {
|
|
1425
|
+
[name: string]: unknown;
|
|
1426
|
+
};
|
|
1427
|
+
content?: never;
|
|
1428
|
+
};
|
|
1429
|
+
/** @description Invalid request body or request param */
|
|
1430
|
+
400: {
|
|
1431
|
+
headers: {
|
|
1432
|
+
[name: string]: unknown;
|
|
1433
|
+
};
|
|
1434
|
+
content: {
|
|
1435
|
+
"text/plain": string;
|
|
1436
|
+
};
|
|
1437
|
+
};
|
|
1438
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1439
|
+
401: {
|
|
1440
|
+
headers: {
|
|
1441
|
+
[name: string]: unknown;
|
|
1442
|
+
};
|
|
1443
|
+
content: {
|
|
1444
|
+
"text/plain": string;
|
|
1445
|
+
};
|
|
1446
|
+
};
|
|
1447
|
+
/** @description Result not found */
|
|
1448
|
+
404: {
|
|
1449
|
+
headers: {
|
|
1450
|
+
[name: string]: unknown;
|
|
1451
|
+
};
|
|
1452
|
+
content: {
|
|
1453
|
+
"text/plain": string;
|
|
1454
|
+
};
|
|
1455
|
+
};
|
|
1456
|
+
/** @description Internal server error */
|
|
1457
|
+
500: {
|
|
1458
|
+
headers: {
|
|
1459
|
+
[name: string]: unknown;
|
|
1460
|
+
};
|
|
1461
|
+
content: {
|
|
1462
|
+
"text/plain": string;
|
|
1463
|
+
};
|
|
1464
|
+
};
|
|
1312
1465
|
};
|
|
1313
|
-
|
|
1314
|
-
|
|
1315
|
-
|
|
1316
|
-
|
|
1317
|
-
|
|
1466
|
+
};
|
|
1467
|
+
removeConnectionFromEnvironment: {
|
|
1468
|
+
parameters: {
|
|
1469
|
+
query?: never;
|
|
1470
|
+
header?: never;
|
|
1471
|
+
path: {
|
|
1472
|
+
/** @description Environment ID */
|
|
1473
|
+
environmentId: string;
|
|
1474
|
+
/** @description Connection ID */
|
|
1475
|
+
connectionId: string;
|
|
1476
|
+
};
|
|
1477
|
+
cookie?: never;
|
|
1318
1478
|
};
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1479
|
+
requestBody?: never;
|
|
1480
|
+
responses: {
|
|
1481
|
+
/** @description Connection removed from environment */
|
|
1482
|
+
204: {
|
|
1483
|
+
headers: {
|
|
1484
|
+
[name: string]: unknown;
|
|
1485
|
+
};
|
|
1486
|
+
content?: never;
|
|
1487
|
+
};
|
|
1488
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1489
|
+
401: {
|
|
1490
|
+
headers: {
|
|
1491
|
+
[name: string]: unknown;
|
|
1492
|
+
};
|
|
1493
|
+
content: {
|
|
1494
|
+
"text/plain": string;
|
|
1495
|
+
};
|
|
1496
|
+
};
|
|
1497
|
+
/** @description Result not found */
|
|
1498
|
+
404: {
|
|
1499
|
+
headers: {
|
|
1500
|
+
[name: string]: unknown;
|
|
1501
|
+
};
|
|
1502
|
+
content: {
|
|
1503
|
+
"text/plain": string;
|
|
1504
|
+
};
|
|
1505
|
+
};
|
|
1506
|
+
/** @description Internal server error */
|
|
1507
|
+
500: {
|
|
1508
|
+
headers: {
|
|
1509
|
+
[name: string]: unknown;
|
|
1510
|
+
};
|
|
1511
|
+
content: {
|
|
1512
|
+
"text/plain": string;
|
|
1513
|
+
};
|
|
1514
|
+
};
|
|
1324
1515
|
};
|
|
1325
|
-
};
|
|
1326
1516
|
};
|
|
1327
|
-
};
|
|
1328
1517
|
}
|
|
1329
|
-
|
|
1330
|
-
export interface external {}
|