@meshery/schemas 1.3.8 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +4154 -1704
- package/dist/cloudApi.d.ts +4154 -1704
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
- package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
- package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
- package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
- package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
- package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
- package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
- package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
- package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
- package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
- package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
- package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
- package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
- package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
- package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
- package/dist/constructs/v1beta1/system/System.d.ts +250 -385
- package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
- package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
- package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
- package/dist/constructs/v1beta1/view/View.d.ts +664 -833
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
- package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
- package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
- package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
- package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
- package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
- package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
- package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
- package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
- package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
- package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
- package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
- package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
- package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
- package/dist/constructs/v1beta2/view/View.d.ts +669 -838
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
- 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 +857 -753
- package/dist/constructs/v1beta3/connection/Connection.d.ts +5919 -1416
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +25 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +25 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
- package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
- package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
- package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
- package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
- package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
- package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
- package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
- package/dist/index.d.mts +5032 -5501
- package/dist/index.d.ts +5032 -5501
- package/dist/mesheryApi.d.mts +3334 -884
- package/dist/mesheryApi.d.ts +3334 -884
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/dist/permissions.d.mts +25 -1
- package/dist/permissions.d.ts +25 -1
- package/dist/permissions.js +1 -1
- package/dist/permissions.mjs +1 -1
- package/package.json +1 -1
|
@@ -4,87 +4,360 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
7
|
+
"/api/environments": {
|
|
8
|
+
/** Gets all environments */
|
|
9
|
+
get: operations["getEnvironments"];
|
|
10
|
+
/** Creates a new environment */
|
|
11
|
+
post: operations["createEnvironment"];
|
|
12
|
+
};
|
|
13
|
+
"/api/environments/{environmentId}": {
|
|
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?: {
|
|
14
132
|
/**
|
|
15
|
-
*
|
|
16
|
-
* @description
|
|
133
|
+
* Format: uuid
|
|
134
|
+
* @description ID
|
|
17
135
|
*/
|
|
18
|
-
|
|
19
|
-
put?: never;
|
|
136
|
+
id: string;
|
|
20
137
|
/**
|
|
21
|
-
*
|
|
22
|
-
* @
|
|
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
|
+
* ]
|
|
23
148
|
*/
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
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 };
|
|
171
|
+
/**
|
|
172
|
+
* Format: date-time
|
|
173
|
+
* @description Timestamp when the resource was updated.
|
|
174
|
+
*/
|
|
175
|
+
updated_at?: string;
|
|
176
|
+
/**
|
|
177
|
+
* Format: date-time
|
|
178
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
179
|
+
*/
|
|
180
|
+
deleted_at?: string | null;
|
|
181
|
+
}[];
|
|
30
182
|
};
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
183
|
+
EnvironmentConnectionsPage: {
|
|
184
|
+
/** @description Current page number of the result set. */
|
|
185
|
+
page?: number;
|
|
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
|
+
};
|
|
49
212
|
};
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
213
|
+
/** Result not found */
|
|
214
|
+
404: {
|
|
215
|
+
content: {
|
|
216
|
+
"text/plain": string;
|
|
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;
|
|
56
254
|
};
|
|
57
|
-
|
|
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;
|
|
255
|
+
};
|
|
66
256
|
};
|
|
257
|
+
};
|
|
67
258
|
}
|
|
68
|
-
|
|
69
|
-
export interface
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
259
|
+
|
|
260
|
+
export interface operations {
|
|
261
|
+
/** Gets all environments */
|
|
262
|
+
getEnvironments: {
|
|
263
|
+
parameters: {
|
|
264
|
+
query: {
|
|
265
|
+
/** Get responses that match search param value */
|
|
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
|
+
};
|
|
276
|
+
};
|
|
277
|
+
responses: {
|
|
278
|
+
/** Environments */
|
|
279
|
+
200: {
|
|
280
|
+
content: {
|
|
281
|
+
"application/json": {
|
|
282
|
+
page?: number;
|
|
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;
|
|
344
|
+
};
|
|
345
|
+
};
|
|
346
|
+
/** Internal server error */
|
|
347
|
+
500: {
|
|
348
|
+
content: {
|
|
349
|
+
"text/plain": string;
|
|
350
|
+
};
|
|
351
|
+
};
|
|
352
|
+
};
|
|
353
|
+
};
|
|
354
|
+
/** Creates a new environment */
|
|
355
|
+
createEnvironment: {
|
|
356
|
+
responses: {
|
|
357
|
+
/** Created environment */
|
|
358
|
+
201: {
|
|
359
|
+
content: {
|
|
360
|
+
"application/json": {
|
|
88
361
|
/**
|
|
89
362
|
* Format: uuid
|
|
90
363
|
* @description ID
|
|
@@ -94,13 +367,13 @@ export interface components {
|
|
|
94
367
|
* @description Specifies the version of the schema to which the environment conforms.
|
|
95
368
|
* @default environments.meshery.io/v1beta1
|
|
96
369
|
* @example [
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
370
|
+
* "v1",
|
|
371
|
+
* "v1alpha1",
|
|
372
|
+
* "v2beta3",
|
|
373
|
+
* "v1.custom-suffix",
|
|
374
|
+
* "models.meshery.io/v1beta1",
|
|
375
|
+
* "capability.meshery.io/v1alpha1"
|
|
376
|
+
* ]
|
|
104
377
|
*/
|
|
105
378
|
schemaVersion: string;
|
|
106
379
|
/** @description Environment name */
|
|
@@ -123,7 +396,7 @@ export interface components {
|
|
|
123
396
|
*/
|
|
124
397
|
created_at?: string;
|
|
125
398
|
/** @description Additional metadata associated with the environment. */
|
|
126
|
-
metadata?:
|
|
399
|
+
metadata?: { [key: string]: unknown };
|
|
127
400
|
/**
|
|
128
401
|
* Format: date-time
|
|
129
402
|
* @description Timestamp when the resource was updated.
|
|
@@ -134,795 +407,353 @@ export interface components {
|
|
|
134
407
|
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
135
408
|
*/
|
|
136
409
|
deleted_at?: string | null;
|
|
410
|
+
};
|
|
137
411
|
};
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
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;
|
|
412
|
+
};
|
|
413
|
+
/** Invalid request body or request param */
|
|
414
|
+
400: {
|
|
415
|
+
content: {
|
|
416
|
+
"text/plain": string;
|
|
160
417
|
};
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
418
|
+
};
|
|
419
|
+
/** Expired JWT token used or insufficient privilege */
|
|
420
|
+
401: {
|
|
421
|
+
content: {
|
|
422
|
+
"text/plain": string;
|
|
423
|
+
};
|
|
424
|
+
};
|
|
425
|
+
/** Internal server error */
|
|
426
|
+
500: {
|
|
427
|
+
content: {
|
|
428
|
+
"text/plain": string;
|
|
429
|
+
};
|
|
430
|
+
};
|
|
431
|
+
};
|
|
432
|
+
/** Body for creating environment */
|
|
433
|
+
requestBody: {
|
|
434
|
+
content: {
|
|
435
|
+
"application/json": {
|
|
436
|
+
/** @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. */
|
|
437
|
+
name: string;
|
|
438
|
+
/** @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). */
|
|
439
|
+
description?: string;
|
|
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;
|
|
171
445
|
};
|
|
172
|
-
|
|
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": {
|
|
173
465
|
page?: number;
|
|
174
466
|
page_size?: number;
|
|
175
467
|
total_count?: number;
|
|
176
468
|
/** @description Environments associated with this resource. */
|
|
177
469
|
environments?: {
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
470
|
+
/**
|
|
471
|
+
* Format: uuid
|
|
472
|
+
* @description ID
|
|
473
|
+
*/
|
|
474
|
+
id: string;
|
|
475
|
+
/**
|
|
476
|
+
* @description Specifies the version of the schema to which the environment conforms.
|
|
477
|
+
* @default environments.meshery.io/v1beta1
|
|
478
|
+
* @example [
|
|
479
|
+
* "v1",
|
|
480
|
+
* "v1alpha1",
|
|
481
|
+
* "v2beta3",
|
|
482
|
+
* "v1.custom-suffix",
|
|
483
|
+
* "models.meshery.io/v1beta1",
|
|
484
|
+
* "capability.meshery.io/v1alpha1"
|
|
485
|
+
* ]
|
|
486
|
+
*/
|
|
487
|
+
schemaVersion: string;
|
|
488
|
+
/** @description Environment name */
|
|
489
|
+
name: string;
|
|
490
|
+
/** @description Environment description */
|
|
491
|
+
description: string;
|
|
492
|
+
/**
|
|
493
|
+
* Format: uuid
|
|
494
|
+
* @description Environment organization ID
|
|
495
|
+
*/
|
|
496
|
+
organization_id: string;
|
|
497
|
+
/**
|
|
498
|
+
* Format: uuid
|
|
499
|
+
* @description Environment owner
|
|
500
|
+
*/
|
|
501
|
+
owner?: string;
|
|
502
|
+
/**
|
|
503
|
+
* Format: date-time
|
|
504
|
+
* @description Timestamp when the resource was created.
|
|
505
|
+
*/
|
|
506
|
+
created_at?: string;
|
|
507
|
+
/** @description Additional metadata associated with the environment. */
|
|
508
|
+
metadata?: { [key: string]: unknown };
|
|
509
|
+
/**
|
|
510
|
+
* Format: date-time
|
|
511
|
+
* @description Timestamp when the resource was updated.
|
|
512
|
+
*/
|
|
513
|
+
updated_at?: string;
|
|
514
|
+
/**
|
|
515
|
+
* Format: date-time
|
|
516
|
+
* @description Timestamp when the environment was soft deleted. Null while the environment remains active.
|
|
517
|
+
*/
|
|
518
|
+
deleted_at?: string | null;
|
|
227
519
|
}[];
|
|
520
|
+
};
|
|
228
521
|
};
|
|
229
|
-
|
|
230
|
-
|
|
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
|
+
};
|
|
534
|
+
};
|
|
535
|
+
/** Result not found */
|
|
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": {
|
|
231
561
|
page?: number;
|
|
232
|
-
/** @description Number of items per page. */
|
|
233
562
|
page_size?: number;
|
|
234
|
-
/** @description Total number of items available. */
|
|
235
563
|
total_count?: number;
|
|
236
|
-
/** @description
|
|
237
|
-
|
|
238
|
-
|
|
564
|
+
/** @description Environments associated with this resource. */
|
|
565
|
+
environments?: {
|
|
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;
|
|
239
615
|
}[];
|
|
616
|
+
};
|
|
240
617
|
};
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
[name: string]: unknown;
|
|
247
|
-
};
|
|
248
|
-
content: {
|
|
249
|
-
"text/plain": string;
|
|
250
|
-
};
|
|
618
|
+
};
|
|
619
|
+
/** Invalid request body or request param */
|
|
620
|
+
400: {
|
|
621
|
+
content: {
|
|
622
|
+
"text/plain": string;
|
|
251
623
|
};
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
content: {
|
|
258
|
-
"text/plain": string;
|
|
259
|
-
};
|
|
624
|
+
};
|
|
625
|
+
/** Expired JWT token used or insufficient privilege */
|
|
626
|
+
401: {
|
|
627
|
+
content: {
|
|
628
|
+
"text/plain": string;
|
|
260
629
|
};
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
content: {
|
|
267
|
-
"text/plain": string;
|
|
268
|
-
};
|
|
630
|
+
};
|
|
631
|
+
/** Result not found */
|
|
632
|
+
404: {
|
|
633
|
+
content: {
|
|
634
|
+
"text/plain": string;
|
|
269
635
|
};
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
content: {
|
|
276
|
-
"text/plain": string;
|
|
277
|
-
};
|
|
636
|
+
};
|
|
637
|
+
/** Internal server error */
|
|
638
|
+
500: {
|
|
639
|
+
content: {
|
|
640
|
+
"text/plain": string;
|
|
278
641
|
};
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
642
|
+
};
|
|
643
|
+
};
|
|
644
|
+
/** Body for creating environment */
|
|
645
|
+
requestBody: {
|
|
646
|
+
content: {
|
|
647
|
+
"application/json": {
|
|
648
|
+
/** @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. */
|
|
649
|
+
name: string;
|
|
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;
|
|
287
657
|
};
|
|
658
|
+
};
|
|
288
659
|
};
|
|
660
|
+
};
|
|
661
|
+
deleteEnvironment: {
|
|
289
662
|
parameters: {
|
|
290
|
-
|
|
663
|
+
path: {
|
|
664
|
+
/** Environment ID */
|
|
291
665
|
environmentId: string;
|
|
292
|
-
|
|
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;
|
|
666
|
+
};
|
|
302
667
|
};
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
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
|
-
};
|
|
668
|
+
responses: {
|
|
669
|
+
/** Environment deleted */
|
|
670
|
+
204: never;
|
|
671
|
+
/** Invalid request body or request param */
|
|
672
|
+
400: {
|
|
673
|
+
content: {
|
|
674
|
+
"text/plain": string;
|
|
429
675
|
};
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
path?: never;
|
|
436
|
-
cookie?: never;
|
|
676
|
+
};
|
|
677
|
+
/** Expired JWT token used or insufficient privilege */
|
|
678
|
+
401: {
|
|
679
|
+
content: {
|
|
680
|
+
"text/plain": string;
|
|
437
681
|
};
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
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
|
-
};
|
|
682
|
+
};
|
|
683
|
+
/** Result not found */
|
|
684
|
+
404: {
|
|
685
|
+
content: {
|
|
686
|
+
"text/plain": string;
|
|
453
687
|
};
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
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
|
-
};
|
|
688
|
+
};
|
|
689
|
+
/** Internal server error */
|
|
690
|
+
500: {
|
|
691
|
+
content: {
|
|
692
|
+
"text/plain": string;
|
|
541
693
|
};
|
|
694
|
+
};
|
|
542
695
|
};
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
responses
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
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
|
-
};
|
|
696
|
+
};
|
|
697
|
+
getEnvironmentConnections: {
|
|
698
|
+
parameters: {
|
|
699
|
+
path: {
|
|
700
|
+
/** Environment ID */
|
|
701
|
+
environmentId: string;
|
|
702
|
+
};
|
|
703
|
+
query: {
|
|
704
|
+
/** Get responses that match search param value */
|
|
705
|
+
search?: string;
|
|
706
|
+
/** Get ordered responses */
|
|
707
|
+
order?: string;
|
|
708
|
+
/** Get responses by page */
|
|
709
|
+
page?: string;
|
|
710
|
+
/** Get responses by pagesize */
|
|
711
|
+
pagesize?: string;
|
|
712
|
+
filter?: string;
|
|
713
|
+
};
|
|
660
714
|
};
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
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
|
-
};
|
|
715
|
+
responses: {
|
|
716
|
+
/** Environment connections */
|
|
717
|
+
200: {
|
|
718
|
+
content: {
|
|
719
|
+
"application/json": {
|
|
720
|
+
/** @description Current page number of the result set. */
|
|
721
|
+
page?: number;
|
|
722
|
+
/** @description Number of items per page. */
|
|
723
|
+
page_size?: number;
|
|
724
|
+
/** @description Total number of items available. */
|
|
725
|
+
total_count?: number;
|
|
726
|
+
/** @description The connections of the environmentconnectionspage. */
|
|
727
|
+
connections?: { [key: string]: unknown }[];
|
|
728
|
+
};
|
|
789
729
|
};
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
path: {
|
|
796
|
-
/** @description Environment ID */
|
|
797
|
-
environmentId: string;
|
|
798
|
-
};
|
|
799
|
-
cookie?: never;
|
|
730
|
+
};
|
|
731
|
+
/** Invalid request body or request param */
|
|
732
|
+
400: {
|
|
733
|
+
content: {
|
|
734
|
+
"text/plain": string;
|
|
800
735
|
};
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
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
|
-
};
|
|
736
|
+
};
|
|
737
|
+
/** Expired JWT token used or insufficient privilege */
|
|
738
|
+
401: {
|
|
739
|
+
content: {
|
|
740
|
+
"text/plain": string;
|
|
846
741
|
};
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
|
|
850
|
-
|
|
851
|
-
|
|
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;
|
|
742
|
+
};
|
|
743
|
+
/** Result not found */
|
|
744
|
+
404: {
|
|
745
|
+
content: {
|
|
746
|
+
"text/plain": string;
|
|
867
747
|
};
|
|
868
|
-
|
|
869
|
-
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
|
|
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
|
-
};
|
|
748
|
+
};
|
|
749
|
+
/** Internal server error */
|
|
750
|
+
500: {
|
|
751
|
+
content: {
|
|
752
|
+
"text/plain": string;
|
|
926
753
|
};
|
|
754
|
+
};
|
|
927
755
|
};
|
|
756
|
+
};
|
|
928
757
|
}
|
|
758
|
+
|
|
759
|
+
export interface external {}
|