@meshery/schemas 1.2.22 → 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 +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,360 +4,87 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
get: operations["getEnvironmentById"];
|
|
15
|
-
put: operations["updateEnvironment"];
|
|
16
|
-
delete: operations["deleteEnvironment"];
|
|
17
|
-
};
|
|
18
|
-
"/api/environments/{environmentId}/connections": {
|
|
19
|
-
get: operations["getEnvironmentConnections"];
|
|
20
|
-
};
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
export interface components {
|
|
24
|
-
schemas: {
|
|
25
|
-
/**
|
|
26
|
-
* Environment
|
|
27
|
-
* @description Environments allow you to logically group related Connections and their associated Credentials. Learn more at https://docs.meshery.io/concepts/logical/environments
|
|
28
|
-
* @example {
|
|
29
|
-
* "id": "00000000-0000-0000-0000-000000000000",
|
|
30
|
-
* "schemaVersion": "environments.meshery.io/v1beta1",
|
|
31
|
-
* "name": "Production Environment",
|
|
32
|
-
* "description": "Connections and credentials for the production cluster.",
|
|
33
|
-
* "organization_id": "00000000-0000-0000-0000-000000000000",
|
|
34
|
-
* "owner": "00000000-0000-0000-0000-000000000000",
|
|
35
|
-
* "created_at": "0001-01-01T00:00:00Z",
|
|
36
|
-
* "metadata": {},
|
|
37
|
-
* "updated_at": "0001-01-01T00:00:00Z",
|
|
38
|
-
* "deleted_at": null
|
|
39
|
-
* }
|
|
40
|
-
*/
|
|
41
|
-
Environment: {
|
|
42
|
-
/**
|
|
43
|
-
* Format: uuid
|
|
44
|
-
* @description ID
|
|
45
|
-
*/
|
|
46
|
-
id: string;
|
|
47
|
-
/**
|
|
48
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
49
|
-
* @default environments.meshery.io/v1beta1
|
|
50
|
-
* @example [
|
|
51
|
-
* "v1",
|
|
52
|
-
* "v1alpha1",
|
|
53
|
-
* "v2beta3",
|
|
54
|
-
* "v1.custom-suffix",
|
|
55
|
-
* "models.meshery.io/v1beta1",
|
|
56
|
-
* "capability.meshery.io/v1alpha1"
|
|
57
|
-
* ]
|
|
58
|
-
*/
|
|
59
|
-
schemaVersion: string;
|
|
60
|
-
/** @description Environment name */
|
|
61
|
-
name: string;
|
|
62
|
-
/** @description Environment description */
|
|
63
|
-
description: string;
|
|
64
|
-
/**
|
|
65
|
-
* Format: uuid
|
|
66
|
-
* @description Environment organization ID
|
|
67
|
-
*/
|
|
68
|
-
organization_id: string;
|
|
69
|
-
/**
|
|
70
|
-
* Format: uuid
|
|
71
|
-
* @description Environment owner
|
|
72
|
-
*/
|
|
73
|
-
owner?: string;
|
|
74
|
-
/**
|
|
75
|
-
* Format: date-time
|
|
76
|
-
* @description Timestamp when the resource was created.
|
|
77
|
-
*/
|
|
78
|
-
created_at?: string;
|
|
79
|
-
/** @description Additional metadata associated with the environment. */
|
|
80
|
-
metadata?: { [key: string]: unknown };
|
|
81
|
-
/**
|
|
82
|
-
* Format: date-time
|
|
83
|
-
* @description Timestamp when the resource was updated.
|
|
84
|
-
*/
|
|
85
|
-
updated_at?: string;
|
|
86
|
-
/**
|
|
87
|
-
* Format: date-time
|
|
88
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
89
|
-
*/
|
|
90
|
-
deleted_at?: string | null;
|
|
91
|
-
};
|
|
92
|
-
EnvironmentConnectionMapping: {
|
|
93
|
-
/** Format: uuid */
|
|
94
|
-
id?: string;
|
|
95
|
-
/**
|
|
96
|
-
* Format: uuid
|
|
97
|
-
* @description ID of the associated environment.
|
|
98
|
-
*/
|
|
99
|
-
environment_id?: string;
|
|
100
|
-
/**
|
|
101
|
-
* Format: uuid
|
|
102
|
-
* @description ID of the associated connection.
|
|
103
|
-
*/
|
|
104
|
-
connection_id?: string;
|
|
105
|
-
/** Format: date-time */
|
|
106
|
-
created_at?: string;
|
|
107
|
-
/** Format: date-time */
|
|
108
|
-
updated_at?: string;
|
|
109
|
-
/**
|
|
110
|
-
* Format: date-time
|
|
111
|
-
* @description SQL null Timestamp to handle null values of time.
|
|
112
|
-
*/
|
|
113
|
-
deleted_at?: string;
|
|
114
|
-
};
|
|
115
|
-
EnvironmentPayload: {
|
|
116
|
-
/** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
|
|
117
|
-
name: string;
|
|
118
|
-
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
119
|
-
description?: string;
|
|
120
|
-
/**
|
|
121
|
-
* Format: uuid
|
|
122
|
-
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
123
|
-
*/
|
|
124
|
-
organization_id: string;
|
|
125
|
-
};
|
|
126
|
-
EnvironmentPage: {
|
|
127
|
-
page?: number;
|
|
128
|
-
page_size?: number;
|
|
129
|
-
total_count?: number;
|
|
130
|
-
/** @description Environments associated with this resource. */
|
|
131
|
-
environments?: {
|
|
132
|
-
/**
|
|
133
|
-
* Format: uuid
|
|
134
|
-
* @description ID
|
|
135
|
-
*/
|
|
136
|
-
id: string;
|
|
137
|
-
/**
|
|
138
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
139
|
-
* @default environments.meshery.io/v1beta1
|
|
140
|
-
* @example [
|
|
141
|
-
* "v1",
|
|
142
|
-
* "v1alpha1",
|
|
143
|
-
* "v2beta3",
|
|
144
|
-
* "v1.custom-suffix",
|
|
145
|
-
* "models.meshery.io/v1beta1",
|
|
146
|
-
* "capability.meshery.io/v1alpha1"
|
|
147
|
-
* ]
|
|
148
|
-
*/
|
|
149
|
-
schemaVersion: string;
|
|
150
|
-
/** @description Environment name */
|
|
151
|
-
name: string;
|
|
152
|
-
/** @description Environment description */
|
|
153
|
-
description: string;
|
|
154
|
-
/**
|
|
155
|
-
* Format: uuid
|
|
156
|
-
* @description Environment organization ID
|
|
157
|
-
*/
|
|
158
|
-
organization_id: string;
|
|
159
|
-
/**
|
|
160
|
-
* Format: uuid
|
|
161
|
-
* @description Environment owner
|
|
162
|
-
*/
|
|
163
|
-
owner?: string;
|
|
164
|
-
/**
|
|
165
|
-
* Format: date-time
|
|
166
|
-
* @description Timestamp when the resource was created.
|
|
167
|
-
*/
|
|
168
|
-
created_at?: string;
|
|
169
|
-
/** @description Additional metadata associated with the environment. */
|
|
170
|
-
metadata?: { [key: string]: unknown };
|
|
7
|
+
"/api/environments": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
171
14
|
/**
|
|
172
|
-
*
|
|
173
|
-
* @description
|
|
15
|
+
* Get all environments
|
|
16
|
+
* @description Gets all environments
|
|
174
17
|
*/
|
|
175
|
-
|
|
18
|
+
get: operations["getEnvironments"];
|
|
19
|
+
put?: never;
|
|
176
20
|
/**
|
|
177
|
-
*
|
|
178
|
-
* @description
|
|
21
|
+
* Create an environment
|
|
22
|
+
* @description Creates a new environment
|
|
179
23
|
*/
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
/** @description Number of items per page. */
|
|
187
|
-
page_size?: number;
|
|
188
|
-
/** @description Total number of items available. */
|
|
189
|
-
total_count?: number;
|
|
190
|
-
/** @description The connections of the environmentconnectionspage. */
|
|
191
|
-
connections?: { [key: string]: unknown }[];
|
|
192
|
-
};
|
|
193
|
-
};
|
|
194
|
-
responses: {
|
|
195
|
-
/** ok */
|
|
196
|
-
200: {
|
|
197
|
-
content: {
|
|
198
|
-
"text/plain": string;
|
|
199
|
-
};
|
|
200
|
-
};
|
|
201
|
-
/** Invalid request body or request param */
|
|
202
|
-
400: {
|
|
203
|
-
content: {
|
|
204
|
-
"text/plain": string;
|
|
205
|
-
};
|
|
206
|
-
};
|
|
207
|
-
/** Expired JWT token used or insufficient privilege */
|
|
208
|
-
401: {
|
|
209
|
-
content: {
|
|
210
|
-
"text/plain": string;
|
|
211
|
-
};
|
|
24
|
+
post: operations["createEnvironment"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
212
30
|
};
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
/** Internal server error */
|
|
220
|
-
500: {
|
|
221
|
-
content: {
|
|
222
|
-
"text/plain": string;
|
|
223
|
-
};
|
|
224
|
-
};
|
|
225
|
-
};
|
|
226
|
-
parameters: {
|
|
227
|
-
/** @description Environment ID */
|
|
228
|
-
environmentId: string;
|
|
229
|
-
/** @description Get responses that match search param value */
|
|
230
|
-
search: string;
|
|
231
|
-
/** @description Get ordered responses */
|
|
232
|
-
order: string;
|
|
233
|
-
/** @description Get responses by page */
|
|
234
|
-
page: string;
|
|
235
|
-
/** @description Get responses by pagesize */
|
|
236
|
-
pagesize: string;
|
|
237
|
-
/** @description User's organization ID */
|
|
238
|
-
orgIdQuery: string;
|
|
239
|
-
};
|
|
240
|
-
requestBodies: {
|
|
241
|
-
/** Body for creating environment */
|
|
242
|
-
environmentPayload: {
|
|
243
|
-
content: {
|
|
244
|
-
"application/json": {
|
|
245
|
-
/** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
|
|
246
|
-
name: string;
|
|
247
|
-
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
248
|
-
description?: string;
|
|
249
|
-
/**
|
|
250
|
-
* Format: uuid
|
|
251
|
-
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
252
|
-
*/
|
|
253
|
-
organization_id: string;
|
|
31
|
+
"/api/environments/{environmentId}": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
254
37
|
};
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
search?: string;
|
|
267
|
-
/** Get ordered responses */
|
|
268
|
-
order?: string;
|
|
269
|
-
/** Get responses by page */
|
|
270
|
-
page?: string;
|
|
271
|
-
/** Get responses by pagesize */
|
|
272
|
-
pagesize?: string;
|
|
273
|
-
/** User's organization ID */
|
|
274
|
-
orgId: string;
|
|
275
|
-
};
|
|
38
|
+
/** Get environment by ID */
|
|
39
|
+
get: operations["getEnvironmentById"];
|
|
40
|
+
/** Update an environment */
|
|
41
|
+
put: operations["updateEnvironment"];
|
|
42
|
+
post?: never;
|
|
43
|
+
/** Delete an environment */
|
|
44
|
+
delete: operations["deleteEnvironment"];
|
|
45
|
+
options?: never;
|
|
46
|
+
head?: never;
|
|
47
|
+
patch?: never;
|
|
48
|
+
trace?: never;
|
|
276
49
|
};
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
page_size?: number;
|
|
284
|
-
total_count?: number;
|
|
285
|
-
/** @description Environments associated with this resource. */
|
|
286
|
-
environments?: {
|
|
287
|
-
/**
|
|
288
|
-
* Format: uuid
|
|
289
|
-
* @description ID
|
|
290
|
-
*/
|
|
291
|
-
id: string;
|
|
292
|
-
/**
|
|
293
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
294
|
-
* @default environments.meshery.io/v1beta1
|
|
295
|
-
* @example [
|
|
296
|
-
* "v1",
|
|
297
|
-
* "v1alpha1",
|
|
298
|
-
* "v2beta3",
|
|
299
|
-
* "v1.custom-suffix",
|
|
300
|
-
* "models.meshery.io/v1beta1",
|
|
301
|
-
* "capability.meshery.io/v1alpha1"
|
|
302
|
-
* ]
|
|
303
|
-
*/
|
|
304
|
-
schemaVersion: string;
|
|
305
|
-
/** @description Environment name */
|
|
306
|
-
name: string;
|
|
307
|
-
/** @description Environment description */
|
|
308
|
-
description: string;
|
|
309
|
-
/**
|
|
310
|
-
* Format: uuid
|
|
311
|
-
* @description Environment organization ID
|
|
312
|
-
*/
|
|
313
|
-
organization_id: string;
|
|
314
|
-
/**
|
|
315
|
-
* Format: uuid
|
|
316
|
-
* @description Environment owner
|
|
317
|
-
*/
|
|
318
|
-
owner?: string;
|
|
319
|
-
/**
|
|
320
|
-
* Format: date-time
|
|
321
|
-
* @description Timestamp when the resource was created.
|
|
322
|
-
*/
|
|
323
|
-
created_at?: string;
|
|
324
|
-
/** @description Additional metadata associated with the environment. */
|
|
325
|
-
metadata?: { [key: string]: unknown };
|
|
326
|
-
/**
|
|
327
|
-
* Format: date-time
|
|
328
|
-
* @description Timestamp when the resource was updated.
|
|
329
|
-
*/
|
|
330
|
-
updated_at?: string;
|
|
331
|
-
/**
|
|
332
|
-
* Format: date-time
|
|
333
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
334
|
-
*/
|
|
335
|
-
deleted_at?: string | null;
|
|
336
|
-
}[];
|
|
337
|
-
};
|
|
338
|
-
};
|
|
339
|
-
};
|
|
340
|
-
/** Expired JWT token used or insufficient privilege */
|
|
341
|
-
401: {
|
|
342
|
-
content: {
|
|
343
|
-
"text/plain": string;
|
|
50
|
+
"/api/environments/{environmentId}/connections": {
|
|
51
|
+
parameters: {
|
|
52
|
+
query?: never;
|
|
53
|
+
header?: never;
|
|
54
|
+
path?: never;
|
|
55
|
+
cookie?: never;
|
|
344
56
|
};
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
57
|
+
/** Get environment connections */
|
|
58
|
+
get: operations["getEnvironmentConnections"];
|
|
59
|
+
put?: never;
|
|
60
|
+
post?: never;
|
|
61
|
+
delete?: never;
|
|
62
|
+
options?: never;
|
|
63
|
+
head?: never;
|
|
64
|
+
patch?: never;
|
|
65
|
+
trace?: never;
|
|
352
66
|
};
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
67
|
+
}
|
|
68
|
+
export type webhooks = Record<string, never>;
|
|
69
|
+
export interface components {
|
|
70
|
+
schemas: {
|
|
71
|
+
/**
|
|
72
|
+
* Environment
|
|
73
|
+
* @description Environments allow you to logically group related Connections and their associated Credentials. Learn more at https://docs.meshery.io/concepts/logical/environments
|
|
74
|
+
* @example {
|
|
75
|
+
* "id": "00000000-0000-0000-0000-000000000000",
|
|
76
|
+
* "schemaVersion": "environments.meshery.io/v1beta1",
|
|
77
|
+
* "name": "Production Environment",
|
|
78
|
+
* "description": "Connections and credentials for the production cluster.",
|
|
79
|
+
* "organization_id": "00000000-0000-0000-0000-000000000000",
|
|
80
|
+
* "owner": "00000000-0000-0000-0000-000000000000",
|
|
81
|
+
* "created_at": "0001-01-01T00:00:00Z",
|
|
82
|
+
* "metadata": {},
|
|
83
|
+
* "updated_at": "0001-01-01T00:00:00Z",
|
|
84
|
+
* "deleted_at": null
|
|
85
|
+
* }
|
|
86
|
+
*/
|
|
87
|
+
Environment: {
|
|
361
88
|
/**
|
|
362
89
|
* Format: uuid
|
|
363
90
|
* @description ID
|
|
@@ -367,13 +94,13 @@ export interface operations {
|
|
|
367
94
|
* @description Specifies the version of the schema to which the environment conforms.
|
|
368
95
|
* @default environments.meshery.io/v1beta1
|
|
369
96
|
* @example [
|
|
370
|
-
*
|
|
371
|
-
*
|
|
372
|
-
*
|
|
373
|
-
*
|
|
374
|
-
*
|
|
375
|
-
*
|
|
376
|
-
*
|
|
97
|
+
* "v1",
|
|
98
|
+
* "v1alpha1",
|
|
99
|
+
* "v2beta3",
|
|
100
|
+
* "v1.custom-suffix",
|
|
101
|
+
* "models.meshery.io/v1beta1",
|
|
102
|
+
* "capability.meshery.io/v1alpha1"
|
|
103
|
+
* ]
|
|
377
104
|
*/
|
|
378
105
|
schemaVersion: string;
|
|
379
106
|
/** @description Environment name */
|
|
@@ -396,7 +123,7 @@ export interface operations {
|
|
|
396
123
|
*/
|
|
397
124
|
created_at?: string;
|
|
398
125
|
/** @description Additional metadata associated with the environment. */
|
|
399
|
-
metadata?:
|
|
126
|
+
metadata?: Record<string, never>;
|
|
400
127
|
/**
|
|
401
128
|
* Format: date-time
|
|
402
129
|
* @description Timestamp when the resource was updated.
|
|
@@ -407,353 +134,795 @@ export interface operations {
|
|
|
407
134
|
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
408
135
|
*/
|
|
409
136
|
deleted_at?: string | null;
|
|
410
|
-
};
|
|
411
|
-
};
|
|
412
|
-
};
|
|
413
|
-
/** Invalid request body or request param */
|
|
414
|
-
400: {
|
|
415
|
-
content: {
|
|
416
|
-
"text/plain": string;
|
|
417
137
|
};
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
138
|
+
EnvironmentConnectionMapping: {
|
|
139
|
+
/** Format: uuid */
|
|
140
|
+
id?: string;
|
|
141
|
+
/**
|
|
142
|
+
* Format: uuid
|
|
143
|
+
* @description ID of the associated environment.
|
|
144
|
+
*/
|
|
145
|
+
environment_id?: string;
|
|
146
|
+
/**
|
|
147
|
+
* Format: uuid
|
|
148
|
+
* @description ID of the associated connection.
|
|
149
|
+
*/
|
|
150
|
+
connection_id?: string;
|
|
151
|
+
/** Format: date-time */
|
|
152
|
+
created_at?: string;
|
|
153
|
+
/** Format: date-time */
|
|
154
|
+
updated_at?: string;
|
|
155
|
+
/**
|
|
156
|
+
* Format: date-time
|
|
157
|
+
* @description SQL null Timestamp to handle null values of time.
|
|
158
|
+
*/
|
|
159
|
+
deleted_at?: string;
|
|
429
160
|
};
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
/**
|
|
441
|
-
* Format: uuid
|
|
442
|
-
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
443
|
-
*/
|
|
444
|
-
organization_id: string;
|
|
161
|
+
EnvironmentPayload: {
|
|
162
|
+
/** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
|
|
163
|
+
name: string;
|
|
164
|
+
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
165
|
+
description?: string;
|
|
166
|
+
/**
|
|
167
|
+
* Format: uuid
|
|
168
|
+
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
169
|
+
*/
|
|
170
|
+
organization_id: string;
|
|
445
171
|
};
|
|
446
|
-
|
|
447
|
-
};
|
|
448
|
-
};
|
|
449
|
-
getEnvironmentById: {
|
|
450
|
-
parameters: {
|
|
451
|
-
path: {
|
|
452
|
-
/** Environment ID */
|
|
453
|
-
environmentId: string;
|
|
454
|
-
};
|
|
455
|
-
query: {
|
|
456
|
-
/** User's organization ID */
|
|
457
|
-
orgId: string;
|
|
458
|
-
};
|
|
459
|
-
};
|
|
460
|
-
responses: {
|
|
461
|
-
/** Environment page */
|
|
462
|
-
200: {
|
|
463
|
-
content: {
|
|
464
|
-
"application/json": {
|
|
172
|
+
EnvironmentPage: {
|
|
465
173
|
page?: number;
|
|
466
174
|
page_size?: number;
|
|
467
175
|
total_count?: number;
|
|
468
176
|
/** @description Environments associated with this resource. */
|
|
469
177
|
environments?: {
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
178
|
+
/**
|
|
179
|
+
* Format: uuid
|
|
180
|
+
* @description ID
|
|
181
|
+
*/
|
|
182
|
+
id: string;
|
|
183
|
+
/**
|
|
184
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
185
|
+
* @default environments.meshery.io/v1beta1
|
|
186
|
+
* @example [
|
|
187
|
+
* "v1",
|
|
188
|
+
* "v1alpha1",
|
|
189
|
+
* "v2beta3",
|
|
190
|
+
* "v1.custom-suffix",
|
|
191
|
+
* "models.meshery.io/v1beta1",
|
|
192
|
+
* "capability.meshery.io/v1alpha1"
|
|
193
|
+
* ]
|
|
194
|
+
*/
|
|
195
|
+
schemaVersion: string;
|
|
196
|
+
/** @description Environment name */
|
|
197
|
+
name: string;
|
|
198
|
+
/** @description Environment description */
|
|
199
|
+
description: string;
|
|
200
|
+
/**
|
|
201
|
+
* Format: uuid
|
|
202
|
+
* @description Environment organization ID
|
|
203
|
+
*/
|
|
204
|
+
organization_id: string;
|
|
205
|
+
/**
|
|
206
|
+
* Format: uuid
|
|
207
|
+
* @description Environment owner
|
|
208
|
+
*/
|
|
209
|
+
owner?: string;
|
|
210
|
+
/**
|
|
211
|
+
* Format: date-time
|
|
212
|
+
* @description Timestamp when the resource was created.
|
|
213
|
+
*/
|
|
214
|
+
created_at?: string;
|
|
215
|
+
/** @description Additional metadata associated with the environment. */
|
|
216
|
+
metadata?: Record<string, never>;
|
|
217
|
+
/**
|
|
218
|
+
* Format: date-time
|
|
219
|
+
* @description Timestamp when the resource was updated.
|
|
220
|
+
*/
|
|
221
|
+
updated_at?: string;
|
|
222
|
+
/**
|
|
223
|
+
* Format: date-time
|
|
224
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
225
|
+
*/
|
|
226
|
+
deleted_at?: string | null;
|
|
519
227
|
}[];
|
|
520
|
-
};
|
|
521
|
-
};
|
|
522
|
-
};
|
|
523
|
-
/** Invalid request body or request param */
|
|
524
|
-
400: {
|
|
525
|
-
content: {
|
|
526
|
-
"text/plain": string;
|
|
527
|
-
};
|
|
528
|
-
};
|
|
529
|
-
/** Expired JWT token used or insufficient privilege */
|
|
530
|
-
401: {
|
|
531
|
-
content: {
|
|
532
|
-
"text/plain": string;
|
|
533
228
|
};
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
404: {
|
|
537
|
-
content: {
|
|
538
|
-
"text/plain": string;
|
|
539
|
-
};
|
|
540
|
-
};
|
|
541
|
-
/** Internal server error */
|
|
542
|
-
500: {
|
|
543
|
-
content: {
|
|
544
|
-
"text/plain": string;
|
|
545
|
-
};
|
|
546
|
-
};
|
|
547
|
-
};
|
|
548
|
-
};
|
|
549
|
-
updateEnvironment: {
|
|
550
|
-
parameters: {
|
|
551
|
-
path: {
|
|
552
|
-
/** Environment ID */
|
|
553
|
-
environmentId: string;
|
|
554
|
-
};
|
|
555
|
-
};
|
|
556
|
-
responses: {
|
|
557
|
-
/** Environment page */
|
|
558
|
-
200: {
|
|
559
|
-
content: {
|
|
560
|
-
"application/json": {
|
|
229
|
+
EnvironmentConnectionsPage: {
|
|
230
|
+
/** @description Current page number of the result set. */
|
|
561
231
|
page?: number;
|
|
232
|
+
/** @description Number of items per page. */
|
|
562
233
|
page_size?: number;
|
|
234
|
+
/** @description Total number of items available. */
|
|
563
235
|
total_count?: number;
|
|
564
|
-
/** @description
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
* Format: uuid
|
|
568
|
-
* @description ID
|
|
569
|
-
*/
|
|
570
|
-
id: string;
|
|
571
|
-
/**
|
|
572
|
-
* @description Specifies the version of the schema to which the environment conforms.
|
|
573
|
-
* @default environments.meshery.io/v1beta1
|
|
574
|
-
* @example [
|
|
575
|
-
* "v1",
|
|
576
|
-
* "v1alpha1",
|
|
577
|
-
* "v2beta3",
|
|
578
|
-
* "v1.custom-suffix",
|
|
579
|
-
* "models.meshery.io/v1beta1",
|
|
580
|
-
* "capability.meshery.io/v1alpha1"
|
|
581
|
-
* ]
|
|
582
|
-
*/
|
|
583
|
-
schemaVersion: string;
|
|
584
|
-
/** @description Environment name */
|
|
585
|
-
name: string;
|
|
586
|
-
/** @description Environment description */
|
|
587
|
-
description: string;
|
|
588
|
-
/**
|
|
589
|
-
* Format: uuid
|
|
590
|
-
* @description Environment organization ID
|
|
591
|
-
*/
|
|
592
|
-
organization_id: string;
|
|
593
|
-
/**
|
|
594
|
-
* Format: uuid
|
|
595
|
-
* @description Environment owner
|
|
596
|
-
*/
|
|
597
|
-
owner?: string;
|
|
598
|
-
/**
|
|
599
|
-
* Format: date-time
|
|
600
|
-
* @description Timestamp when the resource was created.
|
|
601
|
-
*/
|
|
602
|
-
created_at?: string;
|
|
603
|
-
/** @description Additional metadata associated with the environment. */
|
|
604
|
-
metadata?: { [key: string]: unknown };
|
|
605
|
-
/**
|
|
606
|
-
* Format: date-time
|
|
607
|
-
* @description Timestamp when the resource was updated.
|
|
608
|
-
*/
|
|
609
|
-
updated_at?: string;
|
|
610
|
-
/**
|
|
611
|
-
* Format: date-time
|
|
612
|
-
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
613
|
-
*/
|
|
614
|
-
deleted_at?: string | null;
|
|
236
|
+
/** @description The connections of the environmentconnectionspage. */
|
|
237
|
+
connections?: {
|
|
238
|
+
[key: string]: unknown;
|
|
615
239
|
}[];
|
|
616
|
-
};
|
|
617
240
|
};
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
|
|
622
|
-
|
|
241
|
+
};
|
|
242
|
+
responses: {
|
|
243
|
+
/** @description ok */
|
|
244
|
+
200: {
|
|
245
|
+
headers: {
|
|
246
|
+
[name: string]: unknown;
|
|
247
|
+
};
|
|
248
|
+
content: {
|
|
249
|
+
"text/plain": string;
|
|
250
|
+
};
|
|
623
251
|
};
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
252
|
+
/** @description Invalid request body or request param */
|
|
253
|
+
400: {
|
|
254
|
+
headers: {
|
|
255
|
+
[name: string]: unknown;
|
|
256
|
+
};
|
|
257
|
+
content: {
|
|
258
|
+
"text/plain": string;
|
|
259
|
+
};
|
|
629
260
|
};
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
634
|
-
|
|
261
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
262
|
+
401: {
|
|
263
|
+
headers: {
|
|
264
|
+
[name: string]: unknown;
|
|
265
|
+
};
|
|
266
|
+
content: {
|
|
267
|
+
"text/plain": string;
|
|
268
|
+
};
|
|
635
269
|
};
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
270
|
+
/** @description Result not found */
|
|
271
|
+
404: {
|
|
272
|
+
headers: {
|
|
273
|
+
[name: string]: unknown;
|
|
274
|
+
};
|
|
275
|
+
content: {
|
|
276
|
+
"text/plain": string;
|
|
277
|
+
};
|
|
641
278
|
};
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
651
|
-
description?: string;
|
|
652
|
-
/**
|
|
653
|
-
* Format: uuid
|
|
654
|
-
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
655
|
-
*/
|
|
656
|
-
organization_id: string;
|
|
279
|
+
/** @description Internal server error */
|
|
280
|
+
500: {
|
|
281
|
+
headers: {
|
|
282
|
+
[name: string]: unknown;
|
|
283
|
+
};
|
|
284
|
+
content: {
|
|
285
|
+
"text/plain": string;
|
|
286
|
+
};
|
|
657
287
|
};
|
|
658
|
-
};
|
|
659
288
|
};
|
|
660
|
-
};
|
|
661
|
-
deleteEnvironment: {
|
|
662
289
|
parameters: {
|
|
663
|
-
|
|
664
|
-
/** Environment ID */
|
|
290
|
+
/** @description Environment ID */
|
|
665
291
|
environmentId: string;
|
|
666
|
-
|
|
292
|
+
/** @description Get responses that match search param value */
|
|
293
|
+
search: string;
|
|
294
|
+
/** @description Get ordered responses */
|
|
295
|
+
order: string;
|
|
296
|
+
/** @description Get responses by page */
|
|
297
|
+
page: string;
|
|
298
|
+
/** @description Get responses by pagesize */
|
|
299
|
+
pagesize: string;
|
|
300
|
+
/** @description User's organization ID */
|
|
301
|
+
orgIdQuery: string;
|
|
667
302
|
};
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
303
|
+
requestBodies: {
|
|
304
|
+
/** @description Body for creating environment */
|
|
305
|
+
environmentPayload: {
|
|
306
|
+
content: {
|
|
307
|
+
"application/json": {
|
|
308
|
+
/** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
|
|
309
|
+
name: string;
|
|
310
|
+
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
311
|
+
description?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Format: uuid
|
|
314
|
+
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
315
|
+
*/
|
|
316
|
+
organization_id: string;
|
|
317
|
+
};
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
};
|
|
321
|
+
headers: never;
|
|
322
|
+
pathItems: never;
|
|
323
|
+
}
|
|
324
|
+
export type $defs = Record<string, never>;
|
|
325
|
+
export interface operations {
|
|
326
|
+
getEnvironments: {
|
|
327
|
+
parameters: {
|
|
328
|
+
query: {
|
|
329
|
+
/** @description Get responses that match search param value */
|
|
330
|
+
search?: string;
|
|
331
|
+
/** @description Get ordered responses */
|
|
332
|
+
order?: string;
|
|
333
|
+
/** @description Get responses by page */
|
|
334
|
+
page?: string;
|
|
335
|
+
/** @description Get responses by pagesize */
|
|
336
|
+
pagesize?: string;
|
|
337
|
+
/** @description User's organization ID */
|
|
338
|
+
orgId: string;
|
|
339
|
+
};
|
|
340
|
+
header?: never;
|
|
341
|
+
path?: never;
|
|
342
|
+
cookie?: never;
|
|
343
|
+
};
|
|
344
|
+
requestBody?: never;
|
|
345
|
+
responses: {
|
|
346
|
+
/** @description Environments */
|
|
347
|
+
200: {
|
|
348
|
+
headers: {
|
|
349
|
+
[name: string]: unknown;
|
|
350
|
+
};
|
|
351
|
+
content: {
|
|
352
|
+
"application/json": {
|
|
353
|
+
page?: number;
|
|
354
|
+
page_size?: number;
|
|
355
|
+
total_count?: number;
|
|
356
|
+
/** @description Environments associated with this resource. */
|
|
357
|
+
environments?: {
|
|
358
|
+
/**
|
|
359
|
+
* Format: uuid
|
|
360
|
+
* @description ID
|
|
361
|
+
*/
|
|
362
|
+
id: string;
|
|
363
|
+
/**
|
|
364
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
365
|
+
* @default environments.meshery.io/v1beta1
|
|
366
|
+
* @example [
|
|
367
|
+
* "v1",
|
|
368
|
+
* "v1alpha1",
|
|
369
|
+
* "v2beta3",
|
|
370
|
+
* "v1.custom-suffix",
|
|
371
|
+
* "models.meshery.io/v1beta1",
|
|
372
|
+
* "capability.meshery.io/v1alpha1"
|
|
373
|
+
* ]
|
|
374
|
+
*/
|
|
375
|
+
schemaVersion: string;
|
|
376
|
+
/** @description Environment name */
|
|
377
|
+
name: string;
|
|
378
|
+
/** @description Environment description */
|
|
379
|
+
description: string;
|
|
380
|
+
/**
|
|
381
|
+
* Format: uuid
|
|
382
|
+
* @description Environment organization ID
|
|
383
|
+
*/
|
|
384
|
+
organization_id: string;
|
|
385
|
+
/**
|
|
386
|
+
* Format: uuid
|
|
387
|
+
* @description Environment owner
|
|
388
|
+
*/
|
|
389
|
+
owner?: string;
|
|
390
|
+
/**
|
|
391
|
+
* Format: date-time
|
|
392
|
+
* @description Timestamp when the resource was created.
|
|
393
|
+
*/
|
|
394
|
+
created_at?: string;
|
|
395
|
+
/** @description Additional metadata associated with the environment. */
|
|
396
|
+
metadata?: Record<string, never>;
|
|
397
|
+
/**
|
|
398
|
+
* Format: date-time
|
|
399
|
+
* @description Timestamp when the resource was updated.
|
|
400
|
+
*/
|
|
401
|
+
updated_at?: string;
|
|
402
|
+
/**
|
|
403
|
+
* Format: date-time
|
|
404
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
405
|
+
*/
|
|
406
|
+
deleted_at?: string | null;
|
|
407
|
+
}[];
|
|
408
|
+
};
|
|
409
|
+
};
|
|
410
|
+
};
|
|
411
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
412
|
+
401: {
|
|
413
|
+
headers: {
|
|
414
|
+
[name: string]: unknown;
|
|
415
|
+
};
|
|
416
|
+
content: {
|
|
417
|
+
"text/plain": string;
|
|
418
|
+
};
|
|
419
|
+
};
|
|
420
|
+
/** @description Internal server error */
|
|
421
|
+
500: {
|
|
422
|
+
headers: {
|
|
423
|
+
[name: string]: unknown;
|
|
424
|
+
};
|
|
425
|
+
content: {
|
|
426
|
+
"text/plain": string;
|
|
427
|
+
};
|
|
428
|
+
};
|
|
675
429
|
};
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
430
|
+
};
|
|
431
|
+
createEnvironment: {
|
|
432
|
+
parameters: {
|
|
433
|
+
query?: never;
|
|
434
|
+
header?: never;
|
|
435
|
+
path?: never;
|
|
436
|
+
cookie?: never;
|
|
681
437
|
};
|
|
682
|
-
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
438
|
+
/** @description Body for creating environment */
|
|
439
|
+
requestBody: {
|
|
440
|
+
content: {
|
|
441
|
+
"application/json": {
|
|
442
|
+
/** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
|
|
443
|
+
name: string;
|
|
444
|
+
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
445
|
+
description?: string;
|
|
446
|
+
/**
|
|
447
|
+
* Format: uuid
|
|
448
|
+
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
449
|
+
*/
|
|
450
|
+
organization_id: string;
|
|
451
|
+
};
|
|
452
|
+
};
|
|
687
453
|
};
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
454
|
+
responses: {
|
|
455
|
+
/** @description Created environment */
|
|
456
|
+
201: {
|
|
457
|
+
headers: {
|
|
458
|
+
[name: string]: unknown;
|
|
459
|
+
};
|
|
460
|
+
content: {
|
|
461
|
+
"application/json": {
|
|
462
|
+
/**
|
|
463
|
+
* Format: uuid
|
|
464
|
+
* @description ID
|
|
465
|
+
*/
|
|
466
|
+
id: string;
|
|
467
|
+
/**
|
|
468
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
469
|
+
* @default environments.meshery.io/v1beta1
|
|
470
|
+
* @example [
|
|
471
|
+
* "v1",
|
|
472
|
+
* "v1alpha1",
|
|
473
|
+
* "v2beta3",
|
|
474
|
+
* "v1.custom-suffix",
|
|
475
|
+
* "models.meshery.io/v1beta1",
|
|
476
|
+
* "capability.meshery.io/v1alpha1"
|
|
477
|
+
* ]
|
|
478
|
+
*/
|
|
479
|
+
schemaVersion: string;
|
|
480
|
+
/** @description Environment name */
|
|
481
|
+
name: string;
|
|
482
|
+
/** @description Environment description */
|
|
483
|
+
description: string;
|
|
484
|
+
/**
|
|
485
|
+
* Format: uuid
|
|
486
|
+
* @description Environment organization ID
|
|
487
|
+
*/
|
|
488
|
+
organization_id: string;
|
|
489
|
+
/**
|
|
490
|
+
* Format: uuid
|
|
491
|
+
* @description Environment owner
|
|
492
|
+
*/
|
|
493
|
+
owner?: string;
|
|
494
|
+
/**
|
|
495
|
+
* Format: date-time
|
|
496
|
+
* @description Timestamp when the resource was created.
|
|
497
|
+
*/
|
|
498
|
+
created_at?: string;
|
|
499
|
+
/** @description Additional metadata associated with the environment. */
|
|
500
|
+
metadata?: Record<string, never>;
|
|
501
|
+
/**
|
|
502
|
+
* Format: date-time
|
|
503
|
+
* @description Timestamp when the resource was updated.
|
|
504
|
+
*/
|
|
505
|
+
updated_at?: string;
|
|
506
|
+
/**
|
|
507
|
+
* Format: date-time
|
|
508
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
509
|
+
*/
|
|
510
|
+
deleted_at?: string | null;
|
|
511
|
+
};
|
|
512
|
+
};
|
|
513
|
+
};
|
|
514
|
+
/** @description Invalid request body or request param */
|
|
515
|
+
400: {
|
|
516
|
+
headers: {
|
|
517
|
+
[name: string]: unknown;
|
|
518
|
+
};
|
|
519
|
+
content: {
|
|
520
|
+
"text/plain": string;
|
|
521
|
+
};
|
|
522
|
+
};
|
|
523
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
524
|
+
401: {
|
|
525
|
+
headers: {
|
|
526
|
+
[name: string]: unknown;
|
|
527
|
+
};
|
|
528
|
+
content: {
|
|
529
|
+
"text/plain": string;
|
|
530
|
+
};
|
|
531
|
+
};
|
|
532
|
+
/** @description Internal server error */
|
|
533
|
+
500: {
|
|
534
|
+
headers: {
|
|
535
|
+
[name: string]: unknown;
|
|
536
|
+
};
|
|
537
|
+
content: {
|
|
538
|
+
"text/plain": string;
|
|
539
|
+
};
|
|
540
|
+
};
|
|
693
541
|
};
|
|
694
|
-
};
|
|
695
542
|
};
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
543
|
+
getEnvironmentById: {
|
|
544
|
+
parameters: {
|
|
545
|
+
query: {
|
|
546
|
+
/** @description User's organization ID */
|
|
547
|
+
orgId: string;
|
|
548
|
+
};
|
|
549
|
+
header?: never;
|
|
550
|
+
path: {
|
|
551
|
+
/** @description Environment ID */
|
|
552
|
+
environmentId: string;
|
|
553
|
+
};
|
|
554
|
+
cookie?: never;
|
|
555
|
+
};
|
|
556
|
+
requestBody?: never;
|
|
557
|
+
responses: {
|
|
558
|
+
/** @description Environment page */
|
|
559
|
+
200: {
|
|
560
|
+
headers: {
|
|
561
|
+
[name: string]: unknown;
|
|
562
|
+
};
|
|
563
|
+
content: {
|
|
564
|
+
"application/json": {
|
|
565
|
+
page?: number;
|
|
566
|
+
page_size?: number;
|
|
567
|
+
total_count?: number;
|
|
568
|
+
/** @description Environments associated with this resource. */
|
|
569
|
+
environments?: {
|
|
570
|
+
/**
|
|
571
|
+
* Format: uuid
|
|
572
|
+
* @description ID
|
|
573
|
+
*/
|
|
574
|
+
id: string;
|
|
575
|
+
/**
|
|
576
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
577
|
+
* @default environments.meshery.io/v1beta1
|
|
578
|
+
* @example [
|
|
579
|
+
* "v1",
|
|
580
|
+
* "v1alpha1",
|
|
581
|
+
* "v2beta3",
|
|
582
|
+
* "v1.custom-suffix",
|
|
583
|
+
* "models.meshery.io/v1beta1",
|
|
584
|
+
* "capability.meshery.io/v1alpha1"
|
|
585
|
+
* ]
|
|
586
|
+
*/
|
|
587
|
+
schemaVersion: string;
|
|
588
|
+
/** @description Environment name */
|
|
589
|
+
name: string;
|
|
590
|
+
/** @description Environment description */
|
|
591
|
+
description: string;
|
|
592
|
+
/**
|
|
593
|
+
* Format: uuid
|
|
594
|
+
* @description Environment organization ID
|
|
595
|
+
*/
|
|
596
|
+
organization_id: string;
|
|
597
|
+
/**
|
|
598
|
+
* Format: uuid
|
|
599
|
+
* @description Environment owner
|
|
600
|
+
*/
|
|
601
|
+
owner?: string;
|
|
602
|
+
/**
|
|
603
|
+
* Format: date-time
|
|
604
|
+
* @description Timestamp when the resource was created.
|
|
605
|
+
*/
|
|
606
|
+
created_at?: string;
|
|
607
|
+
/** @description Additional metadata associated with the environment. */
|
|
608
|
+
metadata?: Record<string, never>;
|
|
609
|
+
/**
|
|
610
|
+
* Format: date-time
|
|
611
|
+
* @description Timestamp when the resource was updated.
|
|
612
|
+
*/
|
|
613
|
+
updated_at?: string;
|
|
614
|
+
/**
|
|
615
|
+
* Format: date-time
|
|
616
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
617
|
+
*/
|
|
618
|
+
deleted_at?: string | null;
|
|
619
|
+
}[];
|
|
620
|
+
};
|
|
621
|
+
};
|
|
622
|
+
};
|
|
623
|
+
/** @description Invalid request body or request param */
|
|
624
|
+
400: {
|
|
625
|
+
headers: {
|
|
626
|
+
[name: string]: unknown;
|
|
627
|
+
};
|
|
628
|
+
content: {
|
|
629
|
+
"text/plain": string;
|
|
630
|
+
};
|
|
631
|
+
};
|
|
632
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
633
|
+
401: {
|
|
634
|
+
headers: {
|
|
635
|
+
[name: string]: unknown;
|
|
636
|
+
};
|
|
637
|
+
content: {
|
|
638
|
+
"text/plain": string;
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
/** @description Result not found */
|
|
642
|
+
404: {
|
|
643
|
+
headers: {
|
|
644
|
+
[name: string]: unknown;
|
|
645
|
+
};
|
|
646
|
+
content: {
|
|
647
|
+
"text/plain": string;
|
|
648
|
+
};
|
|
649
|
+
};
|
|
650
|
+
/** @description Internal server error */
|
|
651
|
+
500: {
|
|
652
|
+
headers: {
|
|
653
|
+
[name: string]: unknown;
|
|
654
|
+
};
|
|
655
|
+
content: {
|
|
656
|
+
"text/plain": string;
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
};
|
|
714
660
|
};
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
661
|
+
updateEnvironment: {
|
|
662
|
+
parameters: {
|
|
663
|
+
query?: never;
|
|
664
|
+
header?: never;
|
|
665
|
+
path: {
|
|
666
|
+
/** @description Environment ID */
|
|
667
|
+
environmentId: string;
|
|
668
|
+
};
|
|
669
|
+
cookie?: never;
|
|
670
|
+
};
|
|
671
|
+
/** @description Body for creating environment */
|
|
672
|
+
requestBody: {
|
|
673
|
+
content: {
|
|
674
|
+
"application/json": {
|
|
675
|
+
/** @description An environment is a collection of resources. Provide a name that meaningfully represents these resources. You can change the name of the environment even after its creation. */
|
|
676
|
+
name: string;
|
|
677
|
+
/** @description An environment is a collection of resources, such as connections & credentail. Provide a detailed description to clarify the purpose of this environment and the types of resources it encompasses. You can modify the description at any Time. Learn more about environments [here](https://docs.meshery.io/concepts/logical/environments). */
|
|
678
|
+
description?: string;
|
|
679
|
+
/**
|
|
680
|
+
* Format: uuid
|
|
681
|
+
* @description Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.
|
|
682
|
+
*/
|
|
683
|
+
organization_id: string;
|
|
684
|
+
};
|
|
685
|
+
};
|
|
686
|
+
};
|
|
687
|
+
responses: {
|
|
688
|
+
/** @description Environment page */
|
|
689
|
+
200: {
|
|
690
|
+
headers: {
|
|
691
|
+
[name: string]: unknown;
|
|
692
|
+
};
|
|
693
|
+
content: {
|
|
694
|
+
"application/json": {
|
|
695
|
+
page?: number;
|
|
696
|
+
page_size?: number;
|
|
697
|
+
total_count?: number;
|
|
698
|
+
/** @description Environments associated with this resource. */
|
|
699
|
+
environments?: {
|
|
700
|
+
/**
|
|
701
|
+
* Format: uuid
|
|
702
|
+
* @description ID
|
|
703
|
+
*/
|
|
704
|
+
id: string;
|
|
705
|
+
/**
|
|
706
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
707
|
+
* @default environments.meshery.io/v1beta1
|
|
708
|
+
* @example [
|
|
709
|
+
* "v1",
|
|
710
|
+
* "v1alpha1",
|
|
711
|
+
* "v2beta3",
|
|
712
|
+
* "v1.custom-suffix",
|
|
713
|
+
* "models.meshery.io/v1beta1",
|
|
714
|
+
* "capability.meshery.io/v1alpha1"
|
|
715
|
+
* ]
|
|
716
|
+
*/
|
|
717
|
+
schemaVersion: string;
|
|
718
|
+
/** @description Environment name */
|
|
719
|
+
name: string;
|
|
720
|
+
/** @description Environment description */
|
|
721
|
+
description: string;
|
|
722
|
+
/**
|
|
723
|
+
* Format: uuid
|
|
724
|
+
* @description Environment organization ID
|
|
725
|
+
*/
|
|
726
|
+
organization_id: string;
|
|
727
|
+
/**
|
|
728
|
+
* Format: uuid
|
|
729
|
+
* @description Environment owner
|
|
730
|
+
*/
|
|
731
|
+
owner?: string;
|
|
732
|
+
/**
|
|
733
|
+
* Format: date-time
|
|
734
|
+
* @description Timestamp when the resource was created.
|
|
735
|
+
*/
|
|
736
|
+
created_at?: string;
|
|
737
|
+
/** @description Additional metadata associated with the environment. */
|
|
738
|
+
metadata?: Record<string, never>;
|
|
739
|
+
/**
|
|
740
|
+
* Format: date-time
|
|
741
|
+
* @description Timestamp when the resource was updated.
|
|
742
|
+
*/
|
|
743
|
+
updated_at?: string;
|
|
744
|
+
/**
|
|
745
|
+
* Format: date-time
|
|
746
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
747
|
+
*/
|
|
748
|
+
deleted_at?: string | null;
|
|
749
|
+
}[];
|
|
750
|
+
};
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
/** @description Invalid request body or request param */
|
|
754
|
+
400: {
|
|
755
|
+
headers: {
|
|
756
|
+
[name: string]: unknown;
|
|
757
|
+
};
|
|
758
|
+
content: {
|
|
759
|
+
"text/plain": string;
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
763
|
+
401: {
|
|
764
|
+
headers: {
|
|
765
|
+
[name: string]: unknown;
|
|
766
|
+
};
|
|
767
|
+
content: {
|
|
768
|
+
"text/plain": string;
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
/** @description Result not found */
|
|
772
|
+
404: {
|
|
773
|
+
headers: {
|
|
774
|
+
[name: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
content: {
|
|
777
|
+
"text/plain": string;
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
/** @description Internal server error */
|
|
781
|
+
500: {
|
|
782
|
+
headers: {
|
|
783
|
+
[name: string]: unknown;
|
|
784
|
+
};
|
|
785
|
+
content: {
|
|
786
|
+
"text/plain": string;
|
|
787
|
+
};
|
|
788
|
+
};
|
|
729
789
|
};
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
790
|
+
};
|
|
791
|
+
deleteEnvironment: {
|
|
792
|
+
parameters: {
|
|
793
|
+
query?: never;
|
|
794
|
+
header?: never;
|
|
795
|
+
path: {
|
|
796
|
+
/** @description Environment ID */
|
|
797
|
+
environmentId: string;
|
|
798
|
+
};
|
|
799
|
+
cookie?: never;
|
|
735
800
|
};
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
801
|
+
requestBody?: never;
|
|
802
|
+
responses: {
|
|
803
|
+
/** @description Environment deleted */
|
|
804
|
+
204: {
|
|
805
|
+
headers: {
|
|
806
|
+
[name: string]: unknown;
|
|
807
|
+
};
|
|
808
|
+
content?: never;
|
|
809
|
+
};
|
|
810
|
+
/** @description Invalid request body or request param */
|
|
811
|
+
400: {
|
|
812
|
+
headers: {
|
|
813
|
+
[name: string]: unknown;
|
|
814
|
+
};
|
|
815
|
+
content: {
|
|
816
|
+
"text/plain": string;
|
|
817
|
+
};
|
|
818
|
+
};
|
|
819
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
820
|
+
401: {
|
|
821
|
+
headers: {
|
|
822
|
+
[name: string]: unknown;
|
|
823
|
+
};
|
|
824
|
+
content: {
|
|
825
|
+
"text/plain": string;
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
/** @description Result not found */
|
|
829
|
+
404: {
|
|
830
|
+
headers: {
|
|
831
|
+
[name: string]: unknown;
|
|
832
|
+
};
|
|
833
|
+
content: {
|
|
834
|
+
"text/plain": string;
|
|
835
|
+
};
|
|
836
|
+
};
|
|
837
|
+
/** @description Internal server error */
|
|
838
|
+
500: {
|
|
839
|
+
headers: {
|
|
840
|
+
[name: string]: unknown;
|
|
841
|
+
};
|
|
842
|
+
content: {
|
|
843
|
+
"text/plain": string;
|
|
844
|
+
};
|
|
845
|
+
};
|
|
741
846
|
};
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
847
|
+
};
|
|
848
|
+
getEnvironmentConnections: {
|
|
849
|
+
parameters: {
|
|
850
|
+
query?: {
|
|
851
|
+
/** @description Get responses that match search param value */
|
|
852
|
+
search?: string;
|
|
853
|
+
/** @description Get ordered responses */
|
|
854
|
+
order?: string;
|
|
855
|
+
/** @description Get responses by page */
|
|
856
|
+
page?: string;
|
|
857
|
+
/** @description Get responses by pagesize */
|
|
858
|
+
pagesize?: string;
|
|
859
|
+
filter?: string;
|
|
860
|
+
};
|
|
861
|
+
header?: never;
|
|
862
|
+
path: {
|
|
863
|
+
/** @description Environment ID */
|
|
864
|
+
environmentId: string;
|
|
865
|
+
};
|
|
866
|
+
cookie?: never;
|
|
747
867
|
};
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
868
|
+
requestBody?: never;
|
|
869
|
+
responses: {
|
|
870
|
+
/** @description Environment connections */
|
|
871
|
+
200: {
|
|
872
|
+
headers: {
|
|
873
|
+
[name: string]: unknown;
|
|
874
|
+
};
|
|
875
|
+
content: {
|
|
876
|
+
"application/json": {
|
|
877
|
+
/** @description Current page number of the result set. */
|
|
878
|
+
page?: number;
|
|
879
|
+
/** @description Number of items per page. */
|
|
880
|
+
page_size?: number;
|
|
881
|
+
/** @description Total number of items available. */
|
|
882
|
+
total_count?: number;
|
|
883
|
+
/** @description The connections of the environmentconnectionspage. */
|
|
884
|
+
connections?: {
|
|
885
|
+
[key: string]: unknown;
|
|
886
|
+
}[];
|
|
887
|
+
};
|
|
888
|
+
};
|
|
889
|
+
};
|
|
890
|
+
/** @description Invalid request body or request param */
|
|
891
|
+
400: {
|
|
892
|
+
headers: {
|
|
893
|
+
[name: string]: unknown;
|
|
894
|
+
};
|
|
895
|
+
content: {
|
|
896
|
+
"text/plain": string;
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
900
|
+
401: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content: {
|
|
905
|
+
"text/plain": string;
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
/** @description Result not found */
|
|
909
|
+
404: {
|
|
910
|
+
headers: {
|
|
911
|
+
[name: string]: unknown;
|
|
912
|
+
};
|
|
913
|
+
content: {
|
|
914
|
+
"text/plain": string;
|
|
915
|
+
};
|
|
916
|
+
};
|
|
917
|
+
/** @description Internal server error */
|
|
918
|
+
500: {
|
|
919
|
+
headers: {
|
|
920
|
+
[name: string]: unknown;
|
|
921
|
+
};
|
|
922
|
+
content: {
|
|
923
|
+
"text/plain": string;
|
|
924
|
+
};
|
|
925
|
+
};
|
|
753
926
|
};
|
|
754
|
-
};
|
|
755
927
|
};
|
|
756
|
-
};
|
|
757
928
|
}
|
|
758
|
-
|
|
759
|
-
export interface external {}
|