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