@meshery/schemas 0.8.128 → 0.8.129

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.
Files changed (137) hide show
  1. package/dist/{Core-vaTzd8cz.d.mts → Core-BiYtFM4v.d.mts} +1 -1
  2. package/dist/{Core-vaTzd8cz.d.ts → Core-BiYtFM4v.d.ts} +1 -1
  3. package/dist/cloudApi.d.mts +13676 -3825
  4. package/dist/cloudApi.d.ts +13676 -3825
  5. package/dist/cloudApi.js +1 -1
  6. package/dist/cloudApi.mjs +1 -1
  7. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.mts +1 -159
  8. package/dist/constructs/v1alpha1/capability/CapabilitySchema.d.ts +1 -159
  9. package/dist/constructs/v1alpha1/core/Core.d.mts +1 -1
  10. package/dist/constructs/v1alpha1/core/Core.d.ts +1 -1
  11. package/dist/constructs/v1alpha1/core/CoreSchema.d.mts +1 -1652
  12. package/dist/constructs/v1alpha1/core/CoreSchema.d.ts +1 -1652
  13. package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
  14. package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
  15. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.mts +1 -84
  16. package/dist/constructs/v1alpha2/catalog/CatalogSchema.d.ts +1 -84
  17. package/dist/constructs/v1alpha3/relationship/Relationship.d.mts +32 -128
  18. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +32 -128
  19. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.mts +1 -6983
  20. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.d.ts +1 -6983
  21. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.js +15 -15
  22. package/dist/constructs/v1alpha3/relationship/RelationshipSchema.mjs +15 -15
  23. package/dist/constructs/v1beta1/academy/Academy.d.mts +749 -319
  24. package/dist/constructs/v1beta1/academy/Academy.d.ts +749 -319
  25. package/dist/constructs/v1beta1/academy/AcademySchema.d.mts +1 -11842
  26. package/dist/constructs/v1beta1/academy/AcademySchema.d.ts +1 -11842
  27. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  28. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  29. package/dist/constructs/v1beta1/badge/BadgeSchema.d.mts +1 -522
  30. package/dist/constructs/v1beta1/badge/BadgeSchema.d.ts +1 -522
  31. package/dist/constructs/v1beta1/category/CategorySchema.d.mts +1 -64
  32. package/dist/constructs/v1beta1/category/CategorySchema.d.ts +1 -64
  33. package/dist/constructs/v1beta1/component/Component.d.mts +6 -12
  34. package/dist/constructs/v1beta1/component/Component.d.ts +6 -12
  35. package/dist/constructs/v1beta1/component/ComponentSchema.d.mts +1 -1781
  36. package/dist/constructs/v1beta1/component/ComponentSchema.d.ts +1 -1781
  37. package/dist/constructs/v1beta1/component/ComponentSchema.js +3 -3
  38. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +3 -3
  39. package/dist/constructs/v1beta1/connection/Connection.d.mts +12 -12
  40. package/dist/constructs/v1beta1/connection/Connection.d.ts +12 -12
  41. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.mts +1 -2978
  42. package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +1 -2978
  43. package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
  44. package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
  45. package/dist/constructs/v1beta1/credential/Credential.d.mts +517 -0
  46. package/dist/constructs/v1beta1/credential/Credential.d.ts +517 -0
  47. package/dist/constructs/v1beta1/credential/Credential.js +1 -0
  48. package/dist/constructs/v1beta1/credential/Credential.mjs +0 -0
  49. package/dist/constructs/v1beta1/credential/CredentialSchema.d.mts +7 -0
  50. package/dist/constructs/v1beta1/credential/CredentialSchema.d.ts +7 -0
  51. package/dist/constructs/v1beta1/credential/CredentialSchema.js +9 -0
  52. package/dist/constructs/v1beta1/credential/CredentialSchema.mjs +9 -0
  53. package/dist/constructs/v1beta1/environment/Environment.d.mts +4 -4
  54. package/dist/constructs/v1beta1/environment/Environment.d.ts +4 -4
  55. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.mts +1 -958
  56. package/dist/constructs/v1beta1/environment/EnvironmentSchema.d.ts +1 -958
  57. package/dist/constructs/v1beta1/environment/EnvironmentSchema.js +1 -1
  58. package/dist/constructs/v1beta1/environment/EnvironmentSchema.mjs +1 -1
  59. package/dist/constructs/v1beta1/evaluation/Evaluation.d.mts +68 -212
  60. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +68 -212
  61. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.mts +1 -16516
  62. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.d.ts +1 -16516
  63. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +25 -25
  64. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +25 -25
  65. package/dist/constructs/v1beta1/event/EventSchema.d.mts +1 -364
  66. package/dist/constructs/v1beta1/event/EventSchema.d.ts +1 -364
  67. package/dist/constructs/v1beta1/feature/FeatureSchema.d.mts +1 -776
  68. package/dist/constructs/v1beta1/feature/FeatureSchema.d.ts +1 -776
  69. package/dist/constructs/v1beta1/feature/FeatureSchema.js +1 -1
  70. package/dist/constructs/v1beta1/feature/FeatureSchema.mjs +1 -1
  71. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.mts +1 -1655
  72. package/dist/constructs/v1beta1/invitation/InvitationSchema.d.ts +1 -1655
  73. package/dist/constructs/v1beta1/key/KeySchema.d.mts +1 -1229
  74. package/dist/constructs/v1beta1/key/KeySchema.d.ts +1 -1229
  75. package/dist/constructs/v1beta1/key/KeySchema.js +1 -1
  76. package/dist/constructs/v1beta1/key/KeySchema.mjs +1 -1
  77. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.mts +1 -1553
  78. package/dist/constructs/v1beta1/keychain/KeychainSchema.d.ts +1 -1553
  79. package/dist/constructs/v1beta1/keychain/KeychainSchema.js +1 -1
  80. package/dist/constructs/v1beta1/keychain/KeychainSchema.mjs +1 -1
  81. package/dist/constructs/v1beta1/model/Model.d.mts +7 -13
  82. package/dist/constructs/v1beta1/model/Model.d.ts +7 -13
  83. package/dist/constructs/v1beta1/model/ModelSchema.d.mts +1 -1311
  84. package/dist/constructs/v1beta1/model/ModelSchema.d.ts +1 -1311
  85. package/dist/constructs/v1beta1/model/ModelSchema.js +2 -2
  86. package/dist/constructs/v1beta1/model/ModelSchema.mjs +2 -2
  87. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.mts +1 -1498
  88. package/dist/constructs/v1beta1/organization/OrganizationSchema.d.ts +1 -1498
  89. package/dist/constructs/v1beta1/pattern/Pattern.d.mts +7481 -212
  90. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +7481 -212
  91. package/dist/constructs/v1beta1/pattern/PatternSchema.d.mts +1 -16713
  92. package/dist/constructs/v1beta1/pattern/PatternSchema.d.ts +1 -16713
  93. package/dist/constructs/v1beta1/pattern/PatternSchema.js +265 -25
  94. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +265 -25
  95. package/dist/constructs/v1beta1/plan/PlanSchema.d.mts +1 -326
  96. package/dist/constructs/v1beta1/plan/PlanSchema.d.ts +1 -326
  97. package/dist/constructs/v1beta1/role/Role.d.mts +614 -0
  98. package/dist/constructs/v1beta1/role/Role.d.ts +614 -0
  99. package/dist/constructs/v1beta1/role/Role.js +1 -0
  100. package/dist/constructs/v1beta1/role/Role.mjs +0 -0
  101. package/dist/constructs/v1beta1/role/RoleSchema.d.mts +7 -0
  102. package/dist/constructs/v1beta1/role/RoleSchema.d.ts +7 -0
  103. package/dist/constructs/v1beta1/role/RoleSchema.js +2 -0
  104. package/dist/constructs/v1beta1/role/RoleSchema.mjs +2 -0
  105. package/dist/constructs/v1beta1/schedule/Schedule.d.mts +371 -0
  106. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +371 -0
  107. package/dist/constructs/v1beta1/schedule/Schedule.js +1 -0
  108. package/dist/constructs/v1beta1/schedule/Schedule.mjs +0 -0
  109. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.mts +7 -0
  110. package/dist/constructs/v1beta1/schedule/ScheduleSchema.d.ts +7 -0
  111. package/dist/constructs/v1beta1/schedule/ScheduleSchema.js +13 -0
  112. package/dist/constructs/v1beta1/schedule/ScheduleSchema.mjs +13 -0
  113. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.mts +1 -37
  114. package/dist/constructs/v1beta1/subcategory/SubcategorySchema.d.ts +1 -37
  115. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.mts +1 -1645
  116. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.d.ts +1 -1645
  117. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.js +1 -1
  118. package/dist/constructs/v1beta1/subscription/SubscriptionSchema.mjs +1 -1
  119. package/dist/constructs/v1beta1/team/Team.d.mts +46 -16
  120. package/dist/constructs/v1beta1/team/Team.d.ts +46 -16
  121. package/dist/constructs/v1beta1/team/TeamSchema.d.mts +1 -2022
  122. package/dist/constructs/v1beta1/team/TeamSchema.d.ts +1 -2022
  123. package/dist/constructs/v1beta1/team/TeamSchema.js +1 -1
  124. package/dist/constructs/v1beta1/team/TeamSchema.mjs +1 -1
  125. package/dist/constructs/v1beta1/user/UserSchema.d.mts +1 -1116
  126. package/dist/constructs/v1beta1/user/UserSchema.d.ts +1 -1116
  127. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.mts +1 -964
  128. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.d.ts +1 -964
  129. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +1 -1
  130. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +1 -1
  131. package/dist/index.d.mts +1 -1
  132. package/dist/index.d.ts +1 -1
  133. package/dist/index.js +283 -43
  134. package/dist/index.mjs +283 -43
  135. package/dist/mesheryApi.d.mts +268 -244
  136. package/dist/mesheryApi.d.ts +268 -244
  137. package/package.json +1 -1
@@ -2,963 +2,6 @@
2
2
  * This file was automatically generated from OpenAPI schema.
3
3
  * Do not manually modify this file.
4
4
  */
5
- declare const EnvironmentSchema: {
6
- readonly openapi: "3.0.0";
7
- readonly info: {
8
- readonly title: "Environment";
9
- readonly description: "OpenAPI schema for environment management in Meshery Cloud.";
10
- readonly version: "v1beta1";
11
- readonly contact: {
12
- readonly name: "Meshery Maintainers";
13
- readonly email: "maintainers@meshery.io";
14
- readonly url: "https://meshery.io";
15
- };
16
- readonly license: {
17
- readonly name: "Apache 2.0";
18
- readonly url: "https://www.apache.org/licenses/LICENSE-2.0.html";
19
- };
20
- };
21
- readonly servers: readonly [{
22
- readonly url: "http://localhost:9081";
23
- readonly description: "Meshery Server development server URL (controlled via PORT environment variable)";
24
- }];
25
- readonly security: readonly [{
26
- readonly jwt: readonly [];
27
- }];
28
- readonly tags: readonly [{
29
- readonly name: "environments";
30
- readonly description: "APIs for environments";
31
- }];
32
- readonly components: {
33
- readonly responses: {
34
- readonly "200": {
35
- readonly description: "ok";
36
- readonly content: {
37
- readonly "text/plain": {
38
- readonly schema: {
39
- readonly type: "string";
40
- };
41
- };
42
- };
43
- };
44
- readonly "400": {
45
- readonly description: "Invalid request body or request param";
46
- readonly content: {
47
- readonly "text/plain": {
48
- readonly schema: {
49
- readonly type: "string";
50
- };
51
- };
52
- };
53
- };
54
- readonly "401": {
55
- readonly description: "Expired JWT token used or insufficient privilege";
56
- readonly content: {
57
- readonly "text/plain": {
58
- readonly schema: {
59
- readonly type: "string";
60
- };
61
- };
62
- };
63
- };
64
- readonly "500": {
65
- readonly description: "Internal server error";
66
- readonly content: {
67
- readonly "text/plain": {
68
- readonly schema: {
69
- readonly type: "string";
70
- };
71
- };
72
- };
73
- };
74
- };
75
- readonly parameters: {
76
- readonly environmentId: {
77
- readonly name: "environmentId";
78
- readonly in: "path";
79
- readonly description: "Environment ID";
80
- readonly schema: {
81
- readonly type: "string";
82
- readonly format: "uuid";
83
- readonly "x-go-type": "uuid.UUID";
84
- readonly "x-go-type-import": {
85
- readonly path: "github.com/gofrs/uuid";
86
- };
87
- readonly "x-go-type-skip-optional-pointer": true;
88
- };
89
- readonly required: true;
90
- };
91
- readonly search: {
92
- readonly name: "search";
93
- readonly in: "query";
94
- readonly description: "Get responses that match search param value";
95
- readonly schema: {
96
- readonly type: "string";
97
- };
98
- };
99
- readonly order: {
100
- readonly name: "order";
101
- readonly in: "query";
102
- readonly description: "Get ordered responses";
103
- readonly schema: {
104
- readonly type: "string";
105
- };
106
- };
107
- readonly page: {
108
- readonly name: "page";
109
- readonly in: "query";
110
- readonly description: "Get responses by page";
111
- readonly schema: {
112
- readonly type: "string";
113
- };
114
- };
115
- readonly pagesize: {
116
- readonly name: "pagesize";
117
- readonly in: "query";
118
- readonly description: "Get responses by pagesize";
119
- readonly schema: {
120
- readonly type: "string";
121
- };
122
- };
123
- readonly orgIDQuery: {
124
- readonly name: "orgID";
125
- readonly in: "query";
126
- readonly description: "User's organization ID";
127
- readonly schema: {
128
- readonly type: "string";
129
- };
130
- readonly required: true;
131
- };
132
- };
133
- readonly securitySchemes: {
134
- readonly jwt: {
135
- readonly type: "http";
136
- readonly scheme: "Bearer";
137
- readonly bearerFormat: "JWT";
138
- };
139
- };
140
- readonly schemas: {
141
- readonly environment: {
142
- readonly $id: "https://schemas.meshery.io/environment.yaml";
143
- readonly $schema: "http://json-schema.org/draft-07/schema#";
144
- readonly description: "Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments";
145
- readonly additionalProperties: false;
146
- readonly type: "object";
147
- readonly required: readonly ["id", "schemaVersion", "name", "description", "organization_id"];
148
- readonly properties: {
149
- readonly id: {
150
- readonly description: "ID";
151
- readonly "x-order": 1;
152
- readonly "x-go-name": "ID";
153
- readonly "x-oapi-codegen-extra-tags": {
154
- readonly db: "id";
155
- readonly yaml: "id";
156
- };
157
- readonly type: "string";
158
- readonly format: "uuid";
159
- readonly "x-go-type": "uuid.UUID";
160
- readonly "x-go-type-import": {
161
- readonly path: "github.com/gofrs/uuid";
162
- };
163
- };
164
- readonly schemaVersion: {
165
- readonly description: "Specifies the version of the schema to which the environment conforms.";
166
- readonly "x-order": 2;
167
- readonly "x-oapi-codegen-extra-tags": {
168
- readonly yaml: "schemaVersion";
169
- readonly db: "-";
170
- readonly gorm: "-";
171
- };
172
- readonly default: "environments.meshery.io/v1beta1";
173
- readonly type: "string";
174
- readonly minLength: 2;
175
- readonly maxLength: 100;
176
- readonly pattern: "^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$";
177
- readonly example: readonly ["v1", "v1alpha1", "v2beta3", "v1.custom-suffix", "models.meshery.io/v1beta1", "capability.meshery.io/v1alpha1"];
178
- };
179
- readonly name: {
180
- readonly "x-oapi-codegen-extra-tags": {
181
- readonly db: "name";
182
- readonly yaml: "name";
183
- };
184
- readonly "x-order": 3;
185
- readonly type: "string";
186
- readonly description: "Environment name";
187
- };
188
- readonly description: {
189
- readonly "x-oapi-codegen-extra-tags": {
190
- readonly db: "description";
191
- readonly yaml: "description";
192
- };
193
- readonly "x-order": 4;
194
- readonly type: "string";
195
- readonly description: "Environment description";
196
- };
197
- readonly organization_id: {
198
- readonly "x-go-name": "OrganizationID";
199
- readonly "x-oapi-codegen-extra-tags": {
200
- readonly db: "organization_id";
201
- readonly yaml: "organization_id";
202
- };
203
- readonly "x-order": 5;
204
- readonly description: "Environment organization ID";
205
- readonly type: "string";
206
- readonly format: "uuid";
207
- readonly "x-go-type": "uuid.UUID";
208
- readonly "x-go-type-import": {
209
- readonly path: "github.com/gofrs/uuid";
210
- };
211
- };
212
- readonly owner: {
213
- readonly "x-oapi-codegen-extra-tags": {
214
- readonly db: "owner";
215
- readonly yaml: "owner";
216
- };
217
- readonly "x-order": 6;
218
- readonly description: "Environment owner";
219
- readonly type: "string";
220
- readonly format: "uuid";
221
- readonly "x-go-type": "uuid.UUID";
222
- readonly "x-go-type-import": {
223
- readonly path: "github.com/gofrs/uuid";
224
- };
225
- };
226
- readonly created_at: {
227
- readonly "x-oapi-codegen-extra-tags": {
228
- readonly db: "created_at";
229
- readonly yaml: "created_at";
230
- };
231
- readonly "x-order": 7;
232
- readonly type: "string";
233
- readonly format: "date-time";
234
- readonly "x-go-type-skip-optional-pointer": true;
235
- };
236
- readonly metadata: {
237
- readonly "x-oapi-codegen-extra-tags": {
238
- readonly db: "metadata";
239
- readonly yaml: "metadata";
240
- };
241
- readonly "x-order": 8;
242
- readonly "x-go-type": "core.Map";
243
- readonly "x-go-type-skip-optional-pointer": true;
244
- readonly type: "object";
245
- };
246
- readonly updated_at: {
247
- readonly "x-oapi-codegen-extra-tags": {
248
- readonly db: "updated_at";
249
- readonly yaml: "updated_at";
250
- };
251
- readonly "x-order": 9;
252
- readonly type: "string";
253
- readonly format: "date-time";
254
- readonly "x-go-type-skip-optional-pointer": true;
255
- };
256
- readonly deleted_at: {
257
- readonly "x-oapi-codegen-extra-tags": {
258
- readonly db: "deleted_at";
259
- readonly yaml: "deleted_at";
260
- };
261
- readonly "x-go-type": "core.NullTime";
262
- readonly "x-go-import": "database/sql";
263
- readonly "x-order": 10;
264
- readonly type: "string";
265
- readonly format: "date-time";
266
- readonly "x-go-type-skip-optional-pointer": true;
267
- };
268
- };
269
- };
270
- readonly environmentConnectionMapping: {
271
- readonly properties: {
272
- readonly ID: {
273
- readonly type: "string";
274
- readonly format: "uuid";
275
- readonly "x-go-type": "uuid.UUID";
276
- readonly "x-go-type-import": {
277
- readonly path: "github.com/gofrs/uuid";
278
- };
279
- readonly "x-oapi-codegen-extra-tags": {
280
- readonly db: "id";
281
- readonly json: "id";
282
- };
283
- readonly "x-go-type-name": "GeneralId";
284
- readonly "x-go-type-skip-optional-pointer": true;
285
- };
286
- readonly environment_id: {
287
- readonly type: "string";
288
- readonly format: "uuid";
289
- readonly "x-go-type": "uuid.UUID";
290
- readonly "x-go-type-import": {
291
- readonly path: "github.com/gofrs/uuid";
292
- };
293
- readonly "x-oapi-codegen-extra-tags": {
294
- readonly db: "environment_id";
295
- readonly json: "environment_id";
296
- };
297
- readonly "x-go-type-skip-optional-pointer": true;
298
- };
299
- readonly connection_id: {
300
- readonly type: "string";
301
- readonly format: "uuid";
302
- readonly "x-go-type": "uuid.UUID";
303
- readonly "x-go-type-import": {
304
- readonly path: "github.com/gofrs/uuid";
305
- };
306
- readonly "x-oapi-codegen-extra-tags": {
307
- readonly db: "connection_id";
308
- readonly json: "connection_id";
309
- };
310
- readonly "x-go-type-skip-optional-pointer": true;
311
- };
312
- readonly created_at: {
313
- readonly type: "string";
314
- readonly format: "date-time";
315
- readonly "x-go-type-skip-optional-pointer": true;
316
- };
317
- readonly updated_at: {
318
- readonly type: "string";
319
- readonly format: "date-time";
320
- readonly "x-go-type-skip-optional-pointer": true;
321
- };
322
- readonly deleted_at: {
323
- readonly description: "SQL null Timestamp to handle null values of time.";
324
- readonly "x-go-type": "sql.NullTime";
325
- readonly type: "string";
326
- readonly "x-go-type-skip-optional-pointer": true;
327
- };
328
- };
329
- };
330
- readonly environmentPayload: {
331
- readonly properties: {
332
- readonly name: {
333
- readonly 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.";
334
- readonly type: "string";
335
- readonly "x-go-type-skip-optional-pointer": true;
336
- };
337
- readonly description: {
338
- readonly 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).";
339
- readonly type: "string";
340
- readonly "x-go-type-skip-optional-pointer": true;
341
- };
342
- readonly OrganizationID: {
343
- readonly type: "string";
344
- readonly description: "Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.";
345
- readonly "x-go-type-skip-optional-pointer": true;
346
- readonly "x-go-name": "OrgId";
347
- readonly "x-oapi-codegen-extra-tags": {
348
- readonly json: "organization_id";
349
- };
350
- };
351
- };
352
- readonly required: readonly ["name", "organizationID"];
353
- };
354
- readonly environmentPage: {
355
- readonly properties: {
356
- readonly page: {
357
- readonly type: "integer";
358
- readonly "x-go-type-skip-optional-pointer": true;
359
- };
360
- readonly page_size: {
361
- readonly type: "integer";
362
- readonly "x-go-type-skip-optional-pointer": true;
363
- };
364
- readonly total_count: {
365
- readonly type: "integer";
366
- readonly "x-go-type-skip-optional-pointer": true;
367
- };
368
- readonly environments: {
369
- readonly type: "array";
370
- readonly "x-go-type-skip-optional-pointer": true;
371
- readonly items: {
372
- readonly "x-go-type": "Environment";
373
- readonly $id: "https://schemas.meshery.io/environment.yaml";
374
- readonly $schema: "http://json-schema.org/draft-07/schema#";
375
- readonly description: "Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments";
376
- readonly additionalProperties: false;
377
- readonly type: "object";
378
- readonly required: readonly ["id", "schemaVersion", "name", "description", "organization_id"];
379
- readonly properties: {
380
- readonly id: {
381
- readonly description: "ID";
382
- readonly "x-order": 1;
383
- readonly "x-go-name": "ID";
384
- readonly "x-oapi-codegen-extra-tags": {
385
- readonly db: "id";
386
- readonly yaml: "id";
387
- };
388
- readonly type: "string";
389
- readonly format: "uuid";
390
- readonly "x-go-type": "uuid.UUID";
391
- readonly "x-go-type-import": {
392
- readonly path: "github.com/gofrs/uuid";
393
- };
394
- };
395
- readonly schemaVersion: {
396
- readonly description: "Specifies the version of the schema to which the environment conforms.";
397
- readonly "x-order": 2;
398
- readonly "x-oapi-codegen-extra-tags": {
399
- readonly yaml: "schemaVersion";
400
- readonly db: "-";
401
- readonly gorm: "-";
402
- };
403
- readonly default: "environments.meshery.io/v1beta1";
404
- readonly type: "string";
405
- readonly minLength: 2;
406
- readonly maxLength: 100;
407
- readonly pattern: "^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$";
408
- readonly example: readonly ["v1", "v1alpha1", "v2beta3", "v1.custom-suffix", "models.meshery.io/v1beta1", "capability.meshery.io/v1alpha1"];
409
- };
410
- readonly name: {
411
- readonly "x-oapi-codegen-extra-tags": {
412
- readonly db: "name";
413
- readonly yaml: "name";
414
- };
415
- readonly "x-order": 3;
416
- readonly type: "string";
417
- readonly description: "Environment name";
418
- };
419
- readonly description: {
420
- readonly "x-oapi-codegen-extra-tags": {
421
- readonly db: "description";
422
- readonly yaml: "description";
423
- };
424
- readonly "x-order": 4;
425
- readonly type: "string";
426
- readonly description: "Environment description";
427
- };
428
- readonly organization_id: {
429
- readonly "x-go-name": "OrganizationID";
430
- readonly "x-oapi-codegen-extra-tags": {
431
- readonly db: "organization_id";
432
- readonly yaml: "organization_id";
433
- };
434
- readonly "x-order": 5;
435
- readonly description: "Environment organization ID";
436
- readonly type: "string";
437
- readonly format: "uuid";
438
- readonly "x-go-type": "uuid.UUID";
439
- readonly "x-go-type-import": {
440
- readonly path: "github.com/gofrs/uuid";
441
- };
442
- };
443
- readonly owner: {
444
- readonly "x-oapi-codegen-extra-tags": {
445
- readonly db: "owner";
446
- readonly yaml: "owner";
447
- };
448
- readonly "x-order": 6;
449
- readonly description: "Environment owner";
450
- readonly type: "string";
451
- readonly format: "uuid";
452
- readonly "x-go-type": "uuid.UUID";
453
- readonly "x-go-type-import": {
454
- readonly path: "github.com/gofrs/uuid";
455
- };
456
- };
457
- readonly created_at: {
458
- readonly "x-oapi-codegen-extra-tags": {
459
- readonly db: "created_at";
460
- readonly yaml: "created_at";
461
- };
462
- readonly "x-order": 7;
463
- readonly type: "string";
464
- readonly format: "date-time";
465
- readonly "x-go-type-skip-optional-pointer": true;
466
- };
467
- readonly metadata: {
468
- readonly "x-oapi-codegen-extra-tags": {
469
- readonly db: "metadata";
470
- readonly yaml: "metadata";
471
- };
472
- readonly "x-order": 8;
473
- readonly "x-go-type": "core.Map";
474
- readonly "x-go-type-skip-optional-pointer": true;
475
- readonly type: "object";
476
- };
477
- readonly updated_at: {
478
- readonly "x-oapi-codegen-extra-tags": {
479
- readonly db: "updated_at";
480
- readonly yaml: "updated_at";
481
- };
482
- readonly "x-order": 9;
483
- readonly type: "string";
484
- readonly format: "date-time";
485
- readonly "x-go-type-skip-optional-pointer": true;
486
- };
487
- readonly deleted_at: {
488
- readonly "x-oapi-codegen-extra-tags": {
489
- readonly db: "deleted_at";
490
- readonly yaml: "deleted_at";
491
- };
492
- readonly "x-go-type": "core.NullTime";
493
- readonly "x-go-import": "database/sql";
494
- readonly "x-order": 10;
495
- readonly type: "string";
496
- readonly format: "date-time";
497
- readonly "x-go-type-skip-optional-pointer": true;
498
- };
499
- };
500
- };
501
- };
502
- };
503
- };
504
- };
505
- readonly requestBodies: {
506
- readonly environmentPayload: {
507
- readonly description: "Body for creating environment";
508
- readonly required: true;
509
- readonly content: {
510
- readonly "application/json": {
511
- readonly schema: {
512
- readonly properties: {
513
- readonly name: {
514
- readonly 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.";
515
- readonly type: "string";
516
- readonly "x-go-type-skip-optional-pointer": true;
517
- };
518
- readonly description: {
519
- readonly 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).";
520
- readonly type: "string";
521
- readonly "x-go-type-skip-optional-pointer": true;
522
- };
523
- readonly OrganizationID: {
524
- readonly type: "string";
525
- readonly description: "Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.";
526
- readonly "x-go-type-skip-optional-pointer": true;
527
- readonly "x-go-name": "OrgId";
528
- readonly "x-oapi-codegen-extra-tags": {
529
- readonly json: "organization_id";
530
- };
531
- };
532
- };
533
- readonly required: readonly ["name", "organizationID"];
534
- };
535
- };
536
- };
537
- };
538
- };
539
- };
540
- readonly paths: {
541
- readonly "/api/environments": {
542
- readonly post: {
543
- readonly tags: readonly ["environments"];
544
- readonly operationId: "CreateEnvironment";
545
- readonly summary: "Create an environment";
546
- readonly description: "Creates a new environment";
547
- readonly requestBody: {
548
- readonly description: "Body for creating environment";
549
- readonly required: true;
550
- readonly content: {
551
- readonly "application/json": {
552
- readonly schema: {
553
- readonly properties: {
554
- readonly name: {
555
- readonly 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.";
556
- readonly type: "string";
557
- readonly "x-go-type-skip-optional-pointer": true;
558
- };
559
- readonly description: {
560
- readonly 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).";
561
- readonly type: "string";
562
- readonly "x-go-type-skip-optional-pointer": true;
563
- };
564
- readonly OrganizationID: {
565
- readonly type: "string";
566
- readonly description: "Select an organization in which you want to create this new environment. Keep in mind that the organization cannot be changed after creation.";
567
- readonly "x-go-type-skip-optional-pointer": true;
568
- readonly "x-go-name": "OrgId";
569
- readonly "x-oapi-codegen-extra-tags": {
570
- readonly json: "organization_id";
571
- };
572
- };
573
- };
574
- readonly required: readonly ["name", "organizationID"];
575
- };
576
- };
577
- };
578
- };
579
- readonly responses: {
580
- readonly "201": {
581
- readonly description: "Created environment";
582
- readonly content: {
583
- readonly "application/json": {
584
- readonly schema: {
585
- readonly $id: "https://schemas.meshery.io/environment.yaml";
586
- readonly $schema: "http://json-schema.org/draft-07/schema#";
587
- readonly description: "Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments";
588
- readonly additionalProperties: false;
589
- readonly type: "object";
590
- readonly required: readonly ["id", "schemaVersion", "name", "description", "organization_id"];
591
- readonly properties: {
592
- readonly id: {
593
- readonly description: "ID";
594
- readonly "x-order": 1;
595
- readonly "x-go-name": "ID";
596
- readonly "x-oapi-codegen-extra-tags": {
597
- readonly db: "id";
598
- readonly yaml: "id";
599
- };
600
- readonly type: "string";
601
- readonly format: "uuid";
602
- readonly "x-go-type": "uuid.UUID";
603
- readonly "x-go-type-import": {
604
- readonly path: "github.com/gofrs/uuid";
605
- };
606
- };
607
- readonly schemaVersion: {
608
- readonly description: "Specifies the version of the schema to which the environment conforms.";
609
- readonly "x-order": 2;
610
- readonly "x-oapi-codegen-extra-tags": {
611
- readonly yaml: "schemaVersion";
612
- readonly db: "-";
613
- readonly gorm: "-";
614
- };
615
- readonly default: "environments.meshery.io/v1beta1";
616
- readonly type: "string";
617
- readonly minLength: 2;
618
- readonly maxLength: 100;
619
- readonly pattern: "^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$";
620
- readonly example: readonly ["v1", "v1alpha1", "v2beta3", "v1.custom-suffix", "models.meshery.io/v1beta1", "capability.meshery.io/v1alpha1"];
621
- };
622
- readonly name: {
623
- readonly "x-oapi-codegen-extra-tags": {
624
- readonly db: "name";
625
- readonly yaml: "name";
626
- };
627
- readonly "x-order": 3;
628
- readonly type: "string";
629
- readonly description: "Environment name";
630
- };
631
- readonly description: {
632
- readonly "x-oapi-codegen-extra-tags": {
633
- readonly db: "description";
634
- readonly yaml: "description";
635
- };
636
- readonly "x-order": 4;
637
- readonly type: "string";
638
- readonly description: "Environment description";
639
- };
640
- readonly organization_id: {
641
- readonly "x-go-name": "OrganizationID";
642
- readonly "x-oapi-codegen-extra-tags": {
643
- readonly db: "organization_id";
644
- readonly yaml: "organization_id";
645
- };
646
- readonly "x-order": 5;
647
- readonly description: "Environment organization ID";
648
- readonly type: "string";
649
- readonly format: "uuid";
650
- readonly "x-go-type": "uuid.UUID";
651
- readonly "x-go-type-import": {
652
- readonly path: "github.com/gofrs/uuid";
653
- };
654
- };
655
- readonly owner: {
656
- readonly "x-oapi-codegen-extra-tags": {
657
- readonly db: "owner";
658
- readonly yaml: "owner";
659
- };
660
- readonly "x-order": 6;
661
- readonly description: "Environment owner";
662
- readonly type: "string";
663
- readonly format: "uuid";
664
- readonly "x-go-type": "uuid.UUID";
665
- readonly "x-go-type-import": {
666
- readonly path: "github.com/gofrs/uuid";
667
- };
668
- };
669
- readonly created_at: {
670
- readonly "x-oapi-codegen-extra-tags": {
671
- readonly db: "created_at";
672
- readonly yaml: "created_at";
673
- };
674
- readonly "x-order": 7;
675
- readonly type: "string";
676
- readonly format: "date-time";
677
- readonly "x-go-type-skip-optional-pointer": true;
678
- };
679
- readonly metadata: {
680
- readonly "x-oapi-codegen-extra-tags": {
681
- readonly db: "metadata";
682
- readonly yaml: "metadata";
683
- };
684
- readonly "x-order": 8;
685
- readonly "x-go-type": "core.Map";
686
- readonly "x-go-type-skip-optional-pointer": true;
687
- readonly type: "object";
688
- };
689
- readonly updated_at: {
690
- readonly "x-oapi-codegen-extra-tags": {
691
- readonly db: "updated_at";
692
- readonly yaml: "updated_at";
693
- };
694
- readonly "x-order": 9;
695
- readonly type: "string";
696
- readonly format: "date-time";
697
- readonly "x-go-type-skip-optional-pointer": true;
698
- };
699
- readonly deleted_at: {
700
- readonly "x-oapi-codegen-extra-tags": {
701
- readonly db: "deleted_at";
702
- readonly yaml: "deleted_at";
703
- };
704
- readonly "x-go-type": "core.NullTime";
705
- readonly "x-go-import": "database/sql";
706
- readonly "x-order": 10;
707
- readonly type: "string";
708
- readonly format: "date-time";
709
- readonly "x-go-type-skip-optional-pointer": true;
710
- };
711
- };
712
- };
713
- };
714
- };
715
- };
716
- readonly "400": {
717
- readonly description: "Invalid request body or request param";
718
- readonly content: {
719
- readonly "text/plain": {
720
- readonly schema: {
721
- readonly type: "string";
722
- };
723
- };
724
- };
725
- };
726
- readonly "500": {
727
- readonly description: "Internal server error";
728
- readonly content: {
729
- readonly "text/plain": {
730
- readonly schema: {
731
- readonly type: "string";
732
- };
733
- };
734
- };
735
- };
736
- };
737
- };
738
- readonly get: {
739
- readonly tags: readonly ["environments"];
740
- readonly operationId: "GetEnvironments";
741
- readonly summary: "Get all environments";
742
- readonly description: "Gets all environments";
743
- readonly parameters: readonly [{
744
- readonly name: "search";
745
- readonly in: "query";
746
- readonly description: "Get responses that match search param value";
747
- readonly schema: {
748
- readonly type: "string";
749
- };
750
- }, {
751
- readonly name: "order";
752
- readonly in: "query";
753
- readonly description: "Get ordered responses";
754
- readonly schema: {
755
- readonly type: "string";
756
- };
757
- }, {
758
- readonly name: "page";
759
- readonly in: "query";
760
- readonly description: "Get responses by page";
761
- readonly schema: {
762
- readonly type: "string";
763
- };
764
- }, {
765
- readonly name: "pagesize";
766
- readonly in: "query";
767
- readonly description: "Get responses by pagesize";
768
- readonly schema: {
769
- readonly type: "string";
770
- };
771
- }, {
772
- readonly name: "orgID";
773
- readonly in: "query";
774
- readonly description: "User's organization ID";
775
- readonly schema: {
776
- readonly type: "string";
777
- };
778
- readonly required: true;
779
- }];
780
- readonly responses: {
781
- readonly "200": {
782
- readonly description: "Environments";
783
- readonly content: {
784
- readonly "application/json": {
785
- readonly schema: {
786
- readonly properties: {
787
- readonly page: {
788
- readonly type: "integer";
789
- readonly "x-go-type-skip-optional-pointer": true;
790
- };
791
- readonly page_size: {
792
- readonly type: "integer";
793
- readonly "x-go-type-skip-optional-pointer": true;
794
- };
795
- readonly total_count: {
796
- readonly type: "integer";
797
- readonly "x-go-type-skip-optional-pointer": true;
798
- };
799
- readonly environments: {
800
- readonly type: "array";
801
- readonly "x-go-type-skip-optional-pointer": true;
802
- readonly items: {
803
- readonly "x-go-type": "Environment";
804
- readonly $id: "https://schemas.meshery.io/environment.yaml";
805
- readonly $schema: "http://json-schema.org/draft-07/schema#";
806
- readonly description: "Meshery Environments allow you to logically group related Connections and their associated Credentials.. Learn more at https://docs.meshery.io/concepts/logical/environments";
807
- readonly additionalProperties: false;
808
- readonly type: "object";
809
- readonly required: readonly ["id", "schemaVersion", "name", "description", "organization_id"];
810
- readonly properties: {
811
- readonly id: {
812
- readonly description: "ID";
813
- readonly "x-order": 1;
814
- readonly "x-go-name": "ID";
815
- readonly "x-oapi-codegen-extra-tags": {
816
- readonly db: "id";
817
- readonly yaml: "id";
818
- };
819
- readonly type: "string";
820
- readonly format: "uuid";
821
- readonly "x-go-type": "uuid.UUID";
822
- readonly "x-go-type-import": {
823
- readonly path: "github.com/gofrs/uuid";
824
- };
825
- };
826
- readonly schemaVersion: {
827
- readonly description: "Specifies the version of the schema to which the environment conforms.";
828
- readonly "x-order": 2;
829
- readonly "x-oapi-codegen-extra-tags": {
830
- readonly yaml: "schemaVersion";
831
- readonly db: "-";
832
- readonly gorm: "-";
833
- };
834
- readonly default: "environments.meshery.io/v1beta1";
835
- readonly type: "string";
836
- readonly minLength: 2;
837
- readonly maxLength: 100;
838
- readonly pattern: "^([a-z][a-z0-9.-]*\\/)?v(alpha|beta|[0-9]+)([.-][a-z0-9]+)*$";
839
- readonly example: readonly ["v1", "v1alpha1", "v2beta3", "v1.custom-suffix", "models.meshery.io/v1beta1", "capability.meshery.io/v1alpha1"];
840
- };
841
- readonly name: {
842
- readonly "x-oapi-codegen-extra-tags": {
843
- readonly db: "name";
844
- readonly yaml: "name";
845
- };
846
- readonly "x-order": 3;
847
- readonly type: "string";
848
- readonly description: "Environment name";
849
- };
850
- readonly description: {
851
- readonly "x-oapi-codegen-extra-tags": {
852
- readonly db: "description";
853
- readonly yaml: "description";
854
- };
855
- readonly "x-order": 4;
856
- readonly type: "string";
857
- readonly description: "Environment description";
858
- };
859
- readonly organization_id: {
860
- readonly "x-go-name": "OrganizationID";
861
- readonly "x-oapi-codegen-extra-tags": {
862
- readonly db: "organization_id";
863
- readonly yaml: "organization_id";
864
- };
865
- readonly "x-order": 5;
866
- readonly description: "Environment organization ID";
867
- readonly type: "string";
868
- readonly format: "uuid";
869
- readonly "x-go-type": "uuid.UUID";
870
- readonly "x-go-type-import": {
871
- readonly path: "github.com/gofrs/uuid";
872
- };
873
- };
874
- readonly owner: {
875
- readonly "x-oapi-codegen-extra-tags": {
876
- readonly db: "owner";
877
- readonly yaml: "owner";
878
- };
879
- readonly "x-order": 6;
880
- readonly description: "Environment owner";
881
- readonly type: "string";
882
- readonly format: "uuid";
883
- readonly "x-go-type": "uuid.UUID";
884
- readonly "x-go-type-import": {
885
- readonly path: "github.com/gofrs/uuid";
886
- };
887
- };
888
- readonly created_at: {
889
- readonly "x-oapi-codegen-extra-tags": {
890
- readonly db: "created_at";
891
- readonly yaml: "created_at";
892
- };
893
- readonly "x-order": 7;
894
- readonly type: "string";
895
- readonly format: "date-time";
896
- readonly "x-go-type-skip-optional-pointer": true;
897
- };
898
- readonly metadata: {
899
- readonly "x-oapi-codegen-extra-tags": {
900
- readonly db: "metadata";
901
- readonly yaml: "metadata";
902
- };
903
- readonly "x-order": 8;
904
- readonly "x-go-type": "core.Map";
905
- readonly "x-go-type-skip-optional-pointer": true;
906
- readonly type: "object";
907
- };
908
- readonly updated_at: {
909
- readonly "x-oapi-codegen-extra-tags": {
910
- readonly db: "updated_at";
911
- readonly yaml: "updated_at";
912
- };
913
- readonly "x-order": 9;
914
- readonly type: "string";
915
- readonly format: "date-time";
916
- readonly "x-go-type-skip-optional-pointer": true;
917
- };
918
- readonly deleted_at: {
919
- readonly "x-oapi-codegen-extra-tags": {
920
- readonly db: "deleted_at";
921
- readonly yaml: "deleted_at";
922
- };
923
- readonly "x-go-type": "core.NullTime";
924
- readonly "x-go-import": "database/sql";
925
- readonly "x-order": 10;
926
- readonly type: "string";
927
- readonly format: "date-time";
928
- readonly "x-go-type-skip-optional-pointer": true;
929
- };
930
- };
931
- };
932
- };
933
- };
934
- };
935
- };
936
- };
937
- };
938
- readonly "401": {
939
- readonly description: "Expired JWT token used or insufficient privilege";
940
- readonly content: {
941
- readonly "text/plain": {
942
- readonly schema: {
943
- readonly type: "string";
944
- };
945
- };
946
- };
947
- };
948
- readonly "500": {
949
- readonly description: "Internal server error";
950
- readonly content: {
951
- readonly "text/plain": {
952
- readonly schema: {
953
- readonly type: "string";
954
- };
955
- };
956
- };
957
- };
958
- };
959
- };
960
- };
961
- };
962
- };
5
+ declare const EnvironmentSchema: Record<string, unknown>;
963
6
 
964
7
  export { EnvironmentSchema as default };