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