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