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