@meshery/schemas 1.2.22 → 1.2.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +1719 -1518
- package/dist/cloudApi.d.ts +1719 -1518
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
- package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
- package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
- package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
- package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
- package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
- package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
- package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
- package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
- package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
- package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
- package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
- package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
- package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
- package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
- package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
- package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
- package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
- package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
- package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
- package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
- package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
- package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
- package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
- package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
- package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
- package/dist/constructs/v1beta1/system/System.d.ts +434 -0
- package/dist/constructs/v1beta1/system/System.js +1 -0
- package/dist/constructs/v1beta1/system/System.mjs +0 -0
- package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
- package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
- package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
- package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
- package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta1/view/View.d.ts +833 -664
- package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
- package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
- package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
- package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
- package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
- package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
- package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
- package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
- package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
- package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
- package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
- package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
- package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
- package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
- package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
- package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
- package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
- package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
- package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
- package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
- package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
- package/dist/constructs/v1beta2/view/View.d.ts +838 -669
- package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
- package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
- package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
- package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
- package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
- package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
- package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
- package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
- package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
- package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
- package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
- package/dist/index.d.mts +5480 -5022
- package/dist/index.d.ts +5480 -5022
- package/dist/mesheryApi.d.mts +1314 -522
- package/dist/mesheryApi.d.ts +1314 -522
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -2
|
@@ -4,418 +4,102 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
/**
|
|
15
|
-
* Shares a view with a list of email addresses. When `share` is true, the
|
|
16
|
-
* view's visibility is flipped to public and an invitation email is sent
|
|
17
|
-
* to each recipient. When `share` is false, visibility is reverted to
|
|
18
|
-
* private. Only the owner of the view (or a provider admin) may change
|
|
19
|
-
* its sharing mode.
|
|
20
|
-
*/
|
|
21
|
-
post: operations["shareView"];
|
|
22
|
-
};
|
|
23
|
-
"/api/content/views/{viewId}": {
|
|
24
|
-
/** Returns a single view by its unique identifier. */
|
|
25
|
-
get: operations["getViewById"];
|
|
26
|
-
/** Updates an existing view with new filters, metadata, or visibility. */
|
|
27
|
-
put: operations["updateView"];
|
|
28
|
-
/** Soft-deletes a view by its unique identifier. */
|
|
29
|
-
delete: operations["deleteView"];
|
|
30
|
-
};
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
export interface components {
|
|
34
|
-
schemas: {
|
|
35
|
-
/**
|
|
36
|
-
* MesheryView
|
|
37
|
-
* @description A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views
|
|
38
|
-
* @example {
|
|
39
|
-
* "id": "00000000-0000-0000-0000-000000000000",
|
|
40
|
-
* "name": "My Kubernetes View",
|
|
41
|
-
* "visibility": "private",
|
|
42
|
-
* "filters": {},
|
|
43
|
-
* "metadata": {},
|
|
44
|
-
* "user_id": "00000000-0000-0000-0000-000000000000",
|
|
45
|
-
* "created_at": "0001-01-01T00:00:00Z",
|
|
46
|
-
* "updated_at": "0001-01-01T00:00:00Z",
|
|
47
|
-
* "deleted_at": null
|
|
48
|
-
* }
|
|
49
|
-
*/
|
|
50
|
-
MesheryView: {
|
|
51
|
-
/**
|
|
52
|
-
* Format: uuid
|
|
53
|
-
* @description Unique identifier for the view.
|
|
54
|
-
*/
|
|
55
|
-
id: string;
|
|
56
|
-
/** @description Display name of the view. */
|
|
57
|
-
name: string;
|
|
58
|
-
/** @description Visibility level of the view. */
|
|
59
|
-
visibility: string;
|
|
60
|
-
/** @description Filter configuration that defines which resources this view displays. */
|
|
61
|
-
filters?: { [key: string]: unknown };
|
|
62
|
-
/** @description Additional metadata associated with the view. */
|
|
63
|
-
metadata?: { [key: string]: unknown };
|
|
64
|
-
/**
|
|
65
|
-
* Format: uuid
|
|
66
|
-
* @description ID of the user who created the view.
|
|
67
|
-
*/
|
|
68
|
-
user_id: string;
|
|
69
|
-
/**
|
|
70
|
-
* Format: date-time
|
|
71
|
-
* @description Timestamp when the view was created.
|
|
72
|
-
*/
|
|
73
|
-
created_at: string;
|
|
74
|
-
/**
|
|
75
|
-
* Format: date-time
|
|
76
|
-
* @description Timestamp when the view was last updated.
|
|
77
|
-
*/
|
|
78
|
-
updated_at: string;
|
|
79
|
-
/**
|
|
80
|
-
* Format: date-time
|
|
81
|
-
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
82
|
-
*/
|
|
83
|
-
deleted_at?: string | null;
|
|
84
|
-
};
|
|
85
|
-
/** @description A view enriched with the workspace and organization it belongs to. */
|
|
86
|
-
MesheryViewWithLocation: {
|
|
87
|
-
/** Format: uuid */
|
|
88
|
-
id?: string;
|
|
89
|
-
/** @description Display name of the view. */
|
|
90
|
-
name?: string;
|
|
91
|
-
/** @description Visibility level of the view. */
|
|
92
|
-
visibility?: string;
|
|
93
|
-
/** @description Filter configuration for this view. */
|
|
94
|
-
filters?: { [key: string]: unknown };
|
|
95
|
-
/** @description Metadata associated with the view. */
|
|
96
|
-
metadata?: { [key: string]: unknown };
|
|
97
|
-
/**
|
|
98
|
-
* Format: uuid
|
|
99
|
-
* @description ID of the user who created the view.
|
|
100
|
-
*/
|
|
101
|
-
user_id?: string;
|
|
102
|
-
/** @description Name of the workspace this view belongs to. */
|
|
103
|
-
workspace_name?: string;
|
|
104
|
-
/**
|
|
105
|
-
* Format: uuid
|
|
106
|
-
* @description ID of the workspace this view belongs to.
|
|
107
|
-
*/
|
|
108
|
-
workspace_id: string;
|
|
109
|
-
/**
|
|
110
|
-
* Format: uuid
|
|
111
|
-
* @description ID of the organization this view belongs to.
|
|
112
|
-
*/
|
|
113
|
-
organization_id: string;
|
|
114
|
-
/** @description Name of the organization this view belongs to. */
|
|
115
|
-
organization_name?: string;
|
|
116
|
-
/**
|
|
117
|
-
* Format: date-time
|
|
118
|
-
* @description Timestamp when the resource was created.
|
|
119
|
-
*/
|
|
120
|
-
created_at?: string;
|
|
121
|
-
/**
|
|
122
|
-
* Format: date-time
|
|
123
|
-
* @description Timestamp when the resource was updated.
|
|
124
|
-
*/
|
|
125
|
-
updated_at?: string;
|
|
126
|
-
/**
|
|
127
|
-
* Format: date-time
|
|
128
|
-
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
129
|
-
*/
|
|
130
|
-
deleted_at?: string;
|
|
131
|
-
};
|
|
132
|
-
/** @description Payload for creating or updating a view. */
|
|
133
|
-
ViewPayload: {
|
|
134
|
-
/** @description Display name of the view. */
|
|
135
|
-
name: string;
|
|
136
|
-
/** @description Filter configuration for this view. */
|
|
137
|
-
filters?: { [key: string]: unknown };
|
|
138
|
-
/** @description Visibility level of the view. */
|
|
139
|
-
visibility?: string;
|
|
140
|
-
/** @description Metadata associated with the view. */
|
|
141
|
-
metadata?: { [key: string]: unknown };
|
|
142
|
-
};
|
|
143
|
-
/**
|
|
144
|
-
* @description Payload for sharing a view with one or more recipients by email. The
|
|
145
|
-
* wire format matches the canonical design share payload
|
|
146
|
-
* (`design.ContentSharePayload` in `v1beta2/design`), restricted to the
|
|
147
|
-
* `view` content type since that is all this endpoint accepts.
|
|
148
|
-
*/
|
|
149
|
-
ContentSharePayload: {
|
|
150
|
-
/**
|
|
151
|
-
* Format: uuid
|
|
152
|
-
* @description Identifier of the view being shared.
|
|
153
|
-
*/
|
|
154
|
-
content_id: string;
|
|
155
|
-
/**
|
|
156
|
-
* @description The kind of content being shared. Only `view` is accepted on this
|
|
157
|
-
* endpoint.
|
|
158
|
-
*
|
|
159
|
-
* @enum {string}
|
|
160
|
-
*/
|
|
161
|
-
content_type: "view";
|
|
162
|
-
/** @description Email addresses of the recipients to share this view with. */
|
|
163
|
-
emails: string[];
|
|
164
|
-
/**
|
|
165
|
-
* @description When true, flip the view's visibility to public and send invitation
|
|
166
|
-
* emails to the recipients. When false, revert visibility to private.
|
|
167
|
-
*/
|
|
168
|
-
share: boolean;
|
|
169
|
-
};
|
|
170
|
-
/** @description Paginated list of views with location enrichment. */
|
|
171
|
-
MesheryViewPage: {
|
|
172
|
-
page?: number;
|
|
173
|
-
page_size?: number;
|
|
174
|
-
total_count?: number;
|
|
175
|
-
/** @description Views in this page, enriched with workspace and organization context. */
|
|
176
|
-
views?: {
|
|
177
|
-
/** Format: uuid */
|
|
178
|
-
id?: string;
|
|
179
|
-
/** @description Display name of the view. */
|
|
180
|
-
name?: string;
|
|
181
|
-
/** @description Visibility level of the view. */
|
|
182
|
-
visibility?: string;
|
|
183
|
-
/** @description Filter configuration for this view. */
|
|
184
|
-
filters?: { [key: string]: unknown };
|
|
185
|
-
/** @description Metadata associated with the view. */
|
|
186
|
-
metadata?: { [key: string]: unknown };
|
|
7
|
+
"/api/content/views": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
187
14
|
/**
|
|
188
|
-
*
|
|
189
|
-
* @description
|
|
15
|
+
* Get views
|
|
16
|
+
* @description Returns a paginated list of views accessible to the user.
|
|
190
17
|
*/
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
workspace_name?: string;
|
|
18
|
+
get: operations["getViews"];
|
|
19
|
+
put?: never;
|
|
194
20
|
/**
|
|
195
|
-
*
|
|
196
|
-
* @description
|
|
21
|
+
* Create a view
|
|
22
|
+
* @description Creates a new view with the given filters and metadata.
|
|
197
23
|
*/
|
|
198
|
-
|
|
24
|
+
post: operations["createView"];
|
|
25
|
+
delete?: never;
|
|
26
|
+
options?: never;
|
|
27
|
+
head?: never;
|
|
28
|
+
patch?: never;
|
|
29
|
+
trace?: never;
|
|
30
|
+
};
|
|
31
|
+
"/api/content/view/share": {
|
|
32
|
+
parameters: {
|
|
33
|
+
query?: never;
|
|
34
|
+
header?: never;
|
|
35
|
+
path?: never;
|
|
36
|
+
cookie?: never;
|
|
37
|
+
};
|
|
38
|
+
get?: never;
|
|
39
|
+
put?: never;
|
|
199
40
|
/**
|
|
200
|
-
*
|
|
201
|
-
* @description
|
|
41
|
+
* Share a view by email
|
|
42
|
+
* @description Shares a view with a list of email addresses. When `share` is true, the
|
|
43
|
+
* view's visibility is flipped to public and an invitation email is sent
|
|
44
|
+
* to each recipient. When `share` is false, visibility is reverted to
|
|
45
|
+
* private. Only the owner of the view (or a provider admin) may change
|
|
46
|
+
* its sharing mode.
|
|
202
47
|
*/
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
48
|
+
post: operations["shareView"];
|
|
49
|
+
delete?: never;
|
|
50
|
+
options?: never;
|
|
51
|
+
head?: never;
|
|
52
|
+
patch?: never;
|
|
53
|
+
trace?: never;
|
|
54
|
+
};
|
|
55
|
+
"/api/content/views/{viewId}": {
|
|
56
|
+
parameters: {
|
|
57
|
+
query?: never;
|
|
58
|
+
header?: never;
|
|
59
|
+
path?: never;
|
|
60
|
+
cookie?: never;
|
|
61
|
+
};
|
|
206
62
|
/**
|
|
207
|
-
*
|
|
208
|
-
* @description
|
|
63
|
+
* Get a view by ID
|
|
64
|
+
* @description Returns a single view by its unique identifier.
|
|
209
65
|
*/
|
|
210
|
-
|
|
66
|
+
get: operations["getViewById"];
|
|
211
67
|
/**
|
|
212
|
-
*
|
|
213
|
-
* @description
|
|
68
|
+
* Update a view
|
|
69
|
+
* @description Updates an existing view with new filters, metadata, or visibility.
|
|
214
70
|
*/
|
|
215
|
-
|
|
71
|
+
put: operations["updateView"];
|
|
72
|
+
post?: never;
|
|
216
73
|
/**
|
|
217
|
-
*
|
|
218
|
-
* @description
|
|
74
|
+
* Delete a view
|
|
75
|
+
* @description Soft-deletes a view by its unique identifier.
|
|
219
76
|
*/
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
/** ok */
|
|
226
|
-
200: {
|
|
227
|
-
content: {
|
|
228
|
-
"text/plain": string;
|
|
229
|
-
};
|
|
230
|
-
};
|
|
231
|
-
/** Invalid request body or request param */
|
|
232
|
-
400: {
|
|
233
|
-
content: {
|
|
234
|
-
"text/plain": string;
|
|
235
|
-
};
|
|
236
|
-
};
|
|
237
|
-
/** Expired JWT token used or insufficient privilege */
|
|
238
|
-
401: {
|
|
239
|
-
content: {
|
|
240
|
-
"text/plain": string;
|
|
241
|
-
};
|
|
242
|
-
};
|
|
243
|
-
/** Result not found */
|
|
244
|
-
404: {
|
|
245
|
-
content: {
|
|
246
|
-
"text/plain": string;
|
|
247
|
-
};
|
|
248
|
-
};
|
|
249
|
-
/** Internal server error */
|
|
250
|
-
500: {
|
|
251
|
-
content: {
|
|
252
|
-
"text/plain": string;
|
|
253
|
-
};
|
|
254
|
-
};
|
|
255
|
-
};
|
|
256
|
-
parameters: {
|
|
257
|
-
/** @description View ID */
|
|
258
|
-
viewId: string;
|
|
259
|
-
/** @description Get responses that match search param value */
|
|
260
|
-
search: string;
|
|
261
|
-
/** @description Get ordered responses */
|
|
262
|
-
order: string;
|
|
263
|
-
/** @description Get responses by page */
|
|
264
|
-
page: string;
|
|
265
|
-
/** @description Get responses by pagesize */
|
|
266
|
-
pagesize: string;
|
|
267
|
-
/** @description Organization ID to scope the request. */
|
|
268
|
-
orgIdQuery: string;
|
|
269
|
-
};
|
|
270
|
-
requestBodies: {
|
|
271
|
-
/** Body for creating or updating a view */
|
|
272
|
-
viewPayload: {
|
|
273
|
-
content: {
|
|
274
|
-
"application/json": {
|
|
275
|
-
/** @description Display name of the view. */
|
|
276
|
-
name: string;
|
|
277
|
-
/** @description Filter configuration for this view. */
|
|
278
|
-
filters?: { [key: string]: unknown };
|
|
279
|
-
/** @description Visibility level of the view. */
|
|
280
|
-
visibility?: string;
|
|
281
|
-
/** @description Metadata associated with the view. */
|
|
282
|
-
metadata?: { [key: string]: unknown };
|
|
283
|
-
};
|
|
284
|
-
};
|
|
77
|
+
delete: operations["deleteView"];
|
|
78
|
+
options?: never;
|
|
79
|
+
head?: never;
|
|
80
|
+
patch?: never;
|
|
81
|
+
trace?: never;
|
|
285
82
|
};
|
|
286
|
-
/** Body for sharing a view with recipients by email. */
|
|
287
|
-
contentSharePayload: {
|
|
288
|
-
content: {
|
|
289
|
-
"application/json": {
|
|
290
|
-
/**
|
|
291
|
-
* Format: uuid
|
|
292
|
-
* @description Identifier of the view being shared.
|
|
293
|
-
*/
|
|
294
|
-
content_id: string;
|
|
295
|
-
/**
|
|
296
|
-
* @description The kind of content being shared. Only `view` is accepted on this
|
|
297
|
-
* endpoint.
|
|
298
|
-
*
|
|
299
|
-
* @enum {string}
|
|
300
|
-
*/
|
|
301
|
-
content_type: "view";
|
|
302
|
-
/** @description Email addresses of the recipients to share this view with. */
|
|
303
|
-
emails: string[];
|
|
304
|
-
/**
|
|
305
|
-
* @description When true, flip the view's visibility to public and send invitation
|
|
306
|
-
* emails to the recipients. When false, revert visibility to private.
|
|
307
|
-
*/
|
|
308
|
-
share: boolean;
|
|
309
|
-
};
|
|
310
|
-
};
|
|
311
|
-
};
|
|
312
|
-
};
|
|
313
83
|
}
|
|
314
|
-
|
|
315
|
-
export interface
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
visibility?: string;
|
|
334
|
-
/** Organization ID to scope the request. */
|
|
335
|
-
orgId?: string;
|
|
336
|
-
/** UUID of the user whose views to retrieve. */
|
|
337
|
-
userId?: string;
|
|
338
|
-
};
|
|
339
|
-
};
|
|
340
|
-
responses: {
|
|
341
|
-
/** Views page */
|
|
342
|
-
200: {
|
|
343
|
-
content: {
|
|
344
|
-
"application/json": {
|
|
345
|
-
page?: number;
|
|
346
|
-
page_size?: number;
|
|
347
|
-
total_count?: number;
|
|
348
|
-
/** @description Views in this page, enriched with workspace and organization context. */
|
|
349
|
-
views?: {
|
|
350
|
-
/** Format: uuid */
|
|
351
|
-
id?: string;
|
|
352
|
-
/** @description Display name of the view. */
|
|
353
|
-
name?: string;
|
|
354
|
-
/** @description Visibility level of the view. */
|
|
355
|
-
visibility?: string;
|
|
356
|
-
/** @description Filter configuration for this view. */
|
|
357
|
-
filters?: { [key: string]: unknown };
|
|
358
|
-
/** @description Metadata associated with the view. */
|
|
359
|
-
metadata?: { [key: string]: unknown };
|
|
360
|
-
/**
|
|
361
|
-
* Format: uuid
|
|
362
|
-
* @description ID of the user who created the view.
|
|
363
|
-
*/
|
|
364
|
-
user_id?: string;
|
|
365
|
-
/** @description Name of the workspace this view belongs to. */
|
|
366
|
-
workspace_name?: string;
|
|
367
|
-
/**
|
|
368
|
-
* Format: uuid
|
|
369
|
-
* @description ID of the workspace this view belongs to.
|
|
370
|
-
*/
|
|
371
|
-
workspace_id: string;
|
|
372
|
-
/**
|
|
373
|
-
* Format: uuid
|
|
374
|
-
* @description ID of the organization this view belongs to.
|
|
375
|
-
*/
|
|
376
|
-
organization_id: string;
|
|
377
|
-
/** @description Name of the organization this view belongs to. */
|
|
378
|
-
organization_name?: string;
|
|
379
|
-
/**
|
|
380
|
-
* Format: date-time
|
|
381
|
-
* @description Timestamp when the resource was created.
|
|
382
|
-
*/
|
|
383
|
-
created_at?: string;
|
|
384
|
-
/**
|
|
385
|
-
* Format: date-time
|
|
386
|
-
* @description Timestamp when the resource was updated.
|
|
387
|
-
*/
|
|
388
|
-
updated_at?: string;
|
|
389
|
-
/**
|
|
390
|
-
* Format: date-time
|
|
391
|
-
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
392
|
-
*/
|
|
393
|
-
deleted_at?: string;
|
|
394
|
-
}[];
|
|
395
|
-
};
|
|
396
|
-
};
|
|
397
|
-
};
|
|
398
|
-
/** Expired JWT token used or insufficient privilege */
|
|
399
|
-
401: {
|
|
400
|
-
content: {
|
|
401
|
-
"text/plain": string;
|
|
402
|
-
};
|
|
403
|
-
};
|
|
404
|
-
/** Internal server error */
|
|
405
|
-
500: {
|
|
406
|
-
content: {
|
|
407
|
-
"text/plain": string;
|
|
408
|
-
};
|
|
409
|
-
};
|
|
410
|
-
};
|
|
411
|
-
};
|
|
412
|
-
/** Creates a new view with the given filters and metadata. */
|
|
413
|
-
createView: {
|
|
414
|
-
responses: {
|
|
415
|
-
/** Created view */
|
|
416
|
-
201: {
|
|
417
|
-
content: {
|
|
418
|
-
"application/json": {
|
|
84
|
+
export type webhooks = Record<string, never>;
|
|
85
|
+
export interface components {
|
|
86
|
+
schemas: {
|
|
87
|
+
/**
|
|
88
|
+
* MesheryView
|
|
89
|
+
* @description A saved view with filters and metadata that defines a customized perspective of Meshery resources. Learn more at https://docs.meshery.io/concepts/logical/views
|
|
90
|
+
* @example {
|
|
91
|
+
* "id": "00000000-0000-0000-0000-000000000000",
|
|
92
|
+
* "name": "My Kubernetes View",
|
|
93
|
+
* "visibility": "private",
|
|
94
|
+
* "filters": {},
|
|
95
|
+
* "metadata": {},
|
|
96
|
+
* "user_id": "00000000-0000-0000-0000-000000000000",
|
|
97
|
+
* "created_at": "0001-01-01T00:00:00Z",
|
|
98
|
+
* "updated_at": "0001-01-01T00:00:00Z",
|
|
99
|
+
* "deleted_at": null
|
|
100
|
+
* }
|
|
101
|
+
*/
|
|
102
|
+
MesheryView: {
|
|
419
103
|
/**
|
|
420
104
|
* Format: uuid
|
|
421
105
|
* @description Unique identifier for the view.
|
|
@@ -426,9 +110,9 @@ export interface operations {
|
|
|
426
110
|
/** @description Visibility level of the view. */
|
|
427
111
|
visibility: string;
|
|
428
112
|
/** @description Filter configuration that defines which resources this view displays. */
|
|
429
|
-
filters?:
|
|
113
|
+
filters?: Record<string, never>;
|
|
430
114
|
/** @description Additional metadata associated with the view. */
|
|
431
|
-
metadata?:
|
|
115
|
+
metadata?: Record<string, never>;
|
|
432
116
|
/**
|
|
433
117
|
* Format: uuid
|
|
434
118
|
* @description ID of the user who created the view.
|
|
@@ -449,311 +133,796 @@ export interface operations {
|
|
|
449
133
|
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
450
134
|
*/
|
|
451
135
|
deleted_at?: string | null;
|
|
452
|
-
};
|
|
453
|
-
};
|
|
454
|
-
};
|
|
455
|
-
/** Invalid request body or request param */
|
|
456
|
-
400: {
|
|
457
|
-
content: {
|
|
458
|
-
"text/plain": string;
|
|
459
|
-
};
|
|
460
|
-
};
|
|
461
|
-
/** Expired JWT token used or insufficient privilege */
|
|
462
|
-
401: {
|
|
463
|
-
content: {
|
|
464
|
-
"text/plain": string;
|
|
465
|
-
};
|
|
466
|
-
};
|
|
467
|
-
/** Internal server error */
|
|
468
|
-
500: {
|
|
469
|
-
content: {
|
|
470
|
-
"text/plain": string;
|
|
471
|
-
};
|
|
472
|
-
};
|
|
473
|
-
};
|
|
474
|
-
/** Body for creating or updating a view */
|
|
475
|
-
requestBody: {
|
|
476
|
-
content: {
|
|
477
|
-
"application/json": {
|
|
478
|
-
/** @description Display name of the view. */
|
|
479
|
-
name: string;
|
|
480
|
-
/** @description Filter configuration for this view. */
|
|
481
|
-
filters?: { [key: string]: unknown };
|
|
482
|
-
/** @description Visibility level of the view. */
|
|
483
|
-
visibility?: string;
|
|
484
|
-
/** @description Metadata associated with the view. */
|
|
485
|
-
metadata?: { [key: string]: unknown };
|
|
486
|
-
};
|
|
487
|
-
};
|
|
488
|
-
};
|
|
489
|
-
};
|
|
490
|
-
/**
|
|
491
|
-
* Shares a view with a list of email addresses. When `share` is true, the
|
|
492
|
-
* view's visibility is flipped to public and an invitation email is sent
|
|
493
|
-
* to each recipient. When `share` is false, visibility is reverted to
|
|
494
|
-
* private. Only the owner of the view (or a provider admin) may change
|
|
495
|
-
* its sharing mode.
|
|
496
|
-
*/
|
|
497
|
-
shareView: {
|
|
498
|
-
responses: {
|
|
499
|
-
/** View shared. */
|
|
500
|
-
200: unknown;
|
|
501
|
-
/** Invalid request body or request param */
|
|
502
|
-
400: {
|
|
503
|
-
content: {
|
|
504
|
-
"text/plain": string;
|
|
505
|
-
};
|
|
506
|
-
};
|
|
507
|
-
/** Expired JWT token used or insufficient privilege */
|
|
508
|
-
401: {
|
|
509
|
-
content: {
|
|
510
|
-
"text/plain": string;
|
|
511
|
-
};
|
|
512
|
-
};
|
|
513
|
-
/** Caller is not the owner of the view. */
|
|
514
|
-
403: unknown;
|
|
515
|
-
/** Result not found */
|
|
516
|
-
404: {
|
|
517
|
-
content: {
|
|
518
|
-
"text/plain": string;
|
|
519
|
-
};
|
|
520
|
-
};
|
|
521
|
-
/** Internal server error */
|
|
522
|
-
500: {
|
|
523
|
-
content: {
|
|
524
|
-
"text/plain": string;
|
|
525
136
|
};
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
content: {
|
|
531
|
-
"application/json": {
|
|
532
|
-
/**
|
|
533
|
-
* Format: uuid
|
|
534
|
-
* @description Identifier of the view being shared.
|
|
535
|
-
*/
|
|
536
|
-
content_id: string;
|
|
537
|
-
/**
|
|
538
|
-
* @description The kind of content being shared. Only `view` is accepted on this
|
|
539
|
-
* endpoint.
|
|
540
|
-
*
|
|
541
|
-
* @enum {string}
|
|
542
|
-
*/
|
|
543
|
-
content_type: "view";
|
|
544
|
-
/** @description Email addresses of the recipients to share this view with. */
|
|
545
|
-
emails: string[];
|
|
546
|
-
/**
|
|
547
|
-
* @description When true, flip the view's visibility to public and send invitation
|
|
548
|
-
* emails to the recipients. When false, revert visibility to private.
|
|
549
|
-
*/
|
|
550
|
-
share: boolean;
|
|
551
|
-
};
|
|
552
|
-
};
|
|
553
|
-
};
|
|
554
|
-
};
|
|
555
|
-
/** Returns a single view by its unique identifier. */
|
|
556
|
-
getViewById: {
|
|
557
|
-
parameters: {
|
|
558
|
-
path: {
|
|
559
|
-
/** View ID */
|
|
560
|
-
viewId: string;
|
|
561
|
-
};
|
|
562
|
-
};
|
|
563
|
-
responses: {
|
|
564
|
-
/** View */
|
|
565
|
-
200: {
|
|
566
|
-
content: {
|
|
567
|
-
"application/json": {
|
|
568
|
-
/**
|
|
569
|
-
* Format: uuid
|
|
570
|
-
* @description Unique identifier for the view.
|
|
571
|
-
*/
|
|
572
|
-
id: string;
|
|
137
|
+
/** @description A view enriched with the workspace and organization it belongs to. */
|
|
138
|
+
MesheryViewWithLocation: {
|
|
139
|
+
/** Format: uuid */
|
|
140
|
+
id?: string;
|
|
573
141
|
/** @description Display name of the view. */
|
|
574
|
-
name
|
|
142
|
+
name?: string;
|
|
575
143
|
/** @description Visibility level of the view. */
|
|
576
|
-
visibility
|
|
577
|
-
/** @description Filter configuration
|
|
578
|
-
filters?:
|
|
579
|
-
/** @description
|
|
580
|
-
metadata?:
|
|
144
|
+
visibility?: string;
|
|
145
|
+
/** @description Filter configuration for this view. */
|
|
146
|
+
filters?: Record<string, never>;
|
|
147
|
+
/** @description Metadata associated with the view. */
|
|
148
|
+
metadata?: Record<string, never>;
|
|
581
149
|
/**
|
|
582
150
|
* Format: uuid
|
|
583
151
|
* @description ID of the user who created the view.
|
|
584
152
|
*/
|
|
585
|
-
user_id
|
|
153
|
+
user_id?: string;
|
|
154
|
+
/** @description Name of the workspace this view belongs to. */
|
|
155
|
+
workspace_name?: string;
|
|
156
|
+
/**
|
|
157
|
+
* Format: uuid
|
|
158
|
+
* @description ID of the workspace this view belongs to.
|
|
159
|
+
*/
|
|
160
|
+
workspace_id: string;
|
|
161
|
+
/**
|
|
162
|
+
* Format: uuid
|
|
163
|
+
* @description ID of the organization this view belongs to.
|
|
164
|
+
*/
|
|
165
|
+
organization_id: string;
|
|
166
|
+
/** @description Name of the organization this view belongs to. */
|
|
167
|
+
organization_name?: string;
|
|
586
168
|
/**
|
|
587
169
|
* Format: date-time
|
|
588
|
-
* @description Timestamp when the
|
|
170
|
+
* @description Timestamp when the resource was created.
|
|
589
171
|
*/
|
|
590
|
-
created_at
|
|
172
|
+
created_at?: string;
|
|
591
173
|
/**
|
|
592
174
|
* Format: date-time
|
|
593
|
-
* @description Timestamp when the
|
|
175
|
+
* @description Timestamp when the resource was updated.
|
|
594
176
|
*/
|
|
595
|
-
updated_at
|
|
177
|
+
updated_at?: string;
|
|
596
178
|
/**
|
|
597
179
|
* Format: date-time
|
|
598
180
|
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
599
181
|
*/
|
|
600
|
-
deleted_at?: string
|
|
601
|
-
};
|
|
602
|
-
};
|
|
603
|
-
};
|
|
604
|
-
/** Invalid request body or request param */
|
|
605
|
-
400: {
|
|
606
|
-
content: {
|
|
607
|
-
"text/plain": string;
|
|
608
|
-
};
|
|
609
|
-
};
|
|
610
|
-
/** Expired JWT token used or insufficient privilege */
|
|
611
|
-
401: {
|
|
612
|
-
content: {
|
|
613
|
-
"text/plain": string;
|
|
614
|
-
};
|
|
615
|
-
};
|
|
616
|
-
/** Result not found */
|
|
617
|
-
404: {
|
|
618
|
-
content: {
|
|
619
|
-
"text/plain": string;
|
|
182
|
+
deleted_at?: string;
|
|
620
183
|
};
|
|
621
|
-
|
|
622
|
-
|
|
623
|
-
500: {
|
|
624
|
-
content: {
|
|
625
|
-
"text/plain": string;
|
|
626
|
-
};
|
|
627
|
-
};
|
|
628
|
-
};
|
|
629
|
-
};
|
|
630
|
-
/** Updates an existing view with new filters, metadata, or visibility. */
|
|
631
|
-
updateView: {
|
|
632
|
-
parameters: {
|
|
633
|
-
path: {
|
|
634
|
-
/** View ID */
|
|
635
|
-
viewId: string;
|
|
636
|
-
};
|
|
637
|
-
};
|
|
638
|
-
responses: {
|
|
639
|
-
/** Updated view */
|
|
640
|
-
200: {
|
|
641
|
-
content: {
|
|
642
|
-
"application/json": {
|
|
643
|
-
/**
|
|
644
|
-
* Format: uuid
|
|
645
|
-
* @description Unique identifier for the view.
|
|
646
|
-
*/
|
|
647
|
-
id: string;
|
|
184
|
+
/** @description Payload for creating or updating a view. */
|
|
185
|
+
ViewPayload: {
|
|
648
186
|
/** @description Display name of the view. */
|
|
649
187
|
name: string;
|
|
188
|
+
/** @description Filter configuration for this view. */
|
|
189
|
+
filters?: Record<string, never>;
|
|
650
190
|
/** @description Visibility level of the view. */
|
|
651
|
-
visibility
|
|
652
|
-
/** @description
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
191
|
+
visibility?: string;
|
|
192
|
+
/** @description Metadata associated with the view. */
|
|
193
|
+
metadata?: Record<string, never>;
|
|
194
|
+
};
|
|
195
|
+
/**
|
|
196
|
+
* @description Payload for sharing a view with one or more recipients by email. The
|
|
197
|
+
* wire format matches the canonical design share payload
|
|
198
|
+
* (`design.ContentSharePayload` in `v1beta2/design`), restricted to the
|
|
199
|
+
* `view` content type since that is all this endpoint accepts.
|
|
200
|
+
*/
|
|
201
|
+
ContentSharePayload: {
|
|
656
202
|
/**
|
|
657
203
|
* Format: uuid
|
|
658
|
-
* @description
|
|
204
|
+
* @description Identifier of the view being shared.
|
|
659
205
|
*/
|
|
660
|
-
|
|
206
|
+
content_id: string;
|
|
661
207
|
/**
|
|
662
|
-
*
|
|
663
|
-
*
|
|
208
|
+
* @description The kind of content being shared. Only `view` is accepted on this
|
|
209
|
+
* endpoint.
|
|
210
|
+
* @enum {string}
|
|
664
211
|
*/
|
|
665
|
-
|
|
666
|
-
/**
|
|
667
|
-
|
|
668
|
-
* @description Timestamp when the view was last updated.
|
|
669
|
-
*/
|
|
670
|
-
updated_at: string;
|
|
212
|
+
content_type: "view";
|
|
213
|
+
/** @description Email addresses of the recipients to share this view with. */
|
|
214
|
+
emails: string[];
|
|
671
215
|
/**
|
|
672
|
-
*
|
|
673
|
-
*
|
|
216
|
+
* @description When true, flip the view's visibility to public and send invitation
|
|
217
|
+
* emails to the recipients. When false, revert visibility to private.
|
|
674
218
|
*/
|
|
675
|
-
|
|
676
|
-
|
|
219
|
+
share: boolean;
|
|
220
|
+
};
|
|
221
|
+
/** @description Paginated list of views with location enrichment. */
|
|
222
|
+
MesheryViewPage: {
|
|
223
|
+
page?: number;
|
|
224
|
+
page_size?: number;
|
|
225
|
+
total_count?: number;
|
|
226
|
+
/** @description Views in this page, enriched with workspace and organization context. */
|
|
227
|
+
views?: {
|
|
228
|
+
/** Format: uuid */
|
|
229
|
+
id?: string;
|
|
230
|
+
/** @description Display name of the view. */
|
|
231
|
+
name?: string;
|
|
232
|
+
/** @description Visibility level of the view. */
|
|
233
|
+
visibility?: string;
|
|
234
|
+
/** @description Filter configuration for this view. */
|
|
235
|
+
filters?: Record<string, never>;
|
|
236
|
+
/** @description Metadata associated with the view. */
|
|
237
|
+
metadata?: Record<string, never>;
|
|
238
|
+
/**
|
|
239
|
+
* Format: uuid
|
|
240
|
+
* @description ID of the user who created the view.
|
|
241
|
+
*/
|
|
242
|
+
user_id?: string;
|
|
243
|
+
/** @description Name of the workspace this view belongs to. */
|
|
244
|
+
workspace_name?: string;
|
|
245
|
+
/**
|
|
246
|
+
* Format: uuid
|
|
247
|
+
* @description ID of the workspace this view belongs to.
|
|
248
|
+
*/
|
|
249
|
+
workspace_id: string;
|
|
250
|
+
/**
|
|
251
|
+
* Format: uuid
|
|
252
|
+
* @description ID of the organization this view belongs to.
|
|
253
|
+
*/
|
|
254
|
+
organization_id: string;
|
|
255
|
+
/** @description Name of the organization this view belongs to. */
|
|
256
|
+
organization_name?: string;
|
|
257
|
+
/**
|
|
258
|
+
* Format: date-time
|
|
259
|
+
* @description Timestamp when the resource was created.
|
|
260
|
+
*/
|
|
261
|
+
created_at?: string;
|
|
262
|
+
/**
|
|
263
|
+
* Format: date-time
|
|
264
|
+
* @description Timestamp when the resource was updated.
|
|
265
|
+
*/
|
|
266
|
+
updated_at?: string;
|
|
267
|
+
/**
|
|
268
|
+
* Format: date-time
|
|
269
|
+
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
270
|
+
*/
|
|
271
|
+
deleted_at?: string;
|
|
272
|
+
}[];
|
|
677
273
|
};
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
274
|
+
};
|
|
275
|
+
responses: {
|
|
276
|
+
/** @description ok */
|
|
277
|
+
200: {
|
|
278
|
+
headers: {
|
|
279
|
+
[name: string]: unknown;
|
|
280
|
+
};
|
|
281
|
+
content: {
|
|
282
|
+
"text/plain": string;
|
|
283
|
+
};
|
|
683
284
|
};
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
285
|
+
/** @description Invalid request body or request param */
|
|
286
|
+
400: {
|
|
287
|
+
headers: {
|
|
288
|
+
[name: string]: unknown;
|
|
289
|
+
};
|
|
290
|
+
content: {
|
|
291
|
+
"text/plain": string;
|
|
292
|
+
};
|
|
689
293
|
};
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
294
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
295
|
+
401: {
|
|
296
|
+
headers: {
|
|
297
|
+
[name: string]: unknown;
|
|
298
|
+
};
|
|
299
|
+
content: {
|
|
300
|
+
"text/plain": string;
|
|
301
|
+
};
|
|
695
302
|
};
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
303
|
+
/** @description Result not found */
|
|
304
|
+
404: {
|
|
305
|
+
headers: {
|
|
306
|
+
[name: string]: unknown;
|
|
307
|
+
};
|
|
308
|
+
content: {
|
|
309
|
+
"text/plain": string;
|
|
310
|
+
};
|
|
701
311
|
};
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
|
|
708
|
-
|
|
709
|
-
|
|
710
|
-
/** @description Filter configuration for this view. */
|
|
711
|
-
filters?: { [key: string]: unknown };
|
|
712
|
-
/** @description Visibility level of the view. */
|
|
713
|
-
visibility?: string;
|
|
714
|
-
/** @description Metadata associated with the view. */
|
|
715
|
-
metadata?: { [key: string]: unknown };
|
|
312
|
+
/** @description Internal server error */
|
|
313
|
+
500: {
|
|
314
|
+
headers: {
|
|
315
|
+
[name: string]: unknown;
|
|
316
|
+
};
|
|
317
|
+
content: {
|
|
318
|
+
"text/plain": string;
|
|
319
|
+
};
|
|
716
320
|
};
|
|
717
|
-
};
|
|
718
321
|
};
|
|
719
|
-
};
|
|
720
|
-
/** Soft-deletes a view by its unique identifier. */
|
|
721
|
-
deleteView: {
|
|
722
322
|
parameters: {
|
|
723
|
-
|
|
724
|
-
/** View ID */
|
|
323
|
+
/** @description View ID */
|
|
725
324
|
viewId: string;
|
|
726
|
-
|
|
325
|
+
/** @description Get responses that match search param value */
|
|
326
|
+
search: string;
|
|
327
|
+
/** @description Get ordered responses */
|
|
328
|
+
order: string;
|
|
329
|
+
/** @description Get responses by page */
|
|
330
|
+
page: string;
|
|
331
|
+
/** @description Get responses by pagesize */
|
|
332
|
+
pagesize: string;
|
|
333
|
+
/** @description Organization ID to scope the request. */
|
|
334
|
+
orgIdQuery: string;
|
|
727
335
|
};
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
|
|
336
|
+
requestBodies: {
|
|
337
|
+
/** @description Body for creating or updating a view */
|
|
338
|
+
viewPayload: {
|
|
339
|
+
content: {
|
|
340
|
+
"application/json": {
|
|
341
|
+
/** @description Display name of the view. */
|
|
342
|
+
name: string;
|
|
343
|
+
/** @description Filter configuration for this view. */
|
|
344
|
+
filters?: Record<string, never>;
|
|
345
|
+
/** @description Visibility level of the view. */
|
|
346
|
+
visibility?: string;
|
|
347
|
+
/** @description Metadata associated with the view. */
|
|
348
|
+
metadata?: Record<string, never>;
|
|
349
|
+
};
|
|
350
|
+
};
|
|
351
|
+
};
|
|
352
|
+
/** @description Body for sharing a view with recipients by email. */
|
|
353
|
+
contentSharePayload: {
|
|
354
|
+
content: {
|
|
355
|
+
"application/json": {
|
|
356
|
+
/**
|
|
357
|
+
* Format: uuid
|
|
358
|
+
* @description Identifier of the view being shared.
|
|
359
|
+
*/
|
|
360
|
+
content_id: string;
|
|
361
|
+
/**
|
|
362
|
+
* @description The kind of content being shared. Only `view` is accepted on this
|
|
363
|
+
* endpoint.
|
|
364
|
+
* @enum {string}
|
|
365
|
+
*/
|
|
366
|
+
content_type: "view";
|
|
367
|
+
/** @description Email addresses of the recipients to share this view with. */
|
|
368
|
+
emails: string[];
|
|
369
|
+
/**
|
|
370
|
+
* @description When true, flip the view's visibility to public and send invitation
|
|
371
|
+
* emails to the recipients. When false, revert visibility to private.
|
|
372
|
+
*/
|
|
373
|
+
share: boolean;
|
|
374
|
+
};
|
|
375
|
+
};
|
|
376
|
+
};
|
|
377
|
+
};
|
|
378
|
+
headers: never;
|
|
379
|
+
pathItems: never;
|
|
380
|
+
}
|
|
381
|
+
export type $defs = Record<string, never>;
|
|
382
|
+
export interface operations {
|
|
383
|
+
getViews: {
|
|
384
|
+
parameters: {
|
|
385
|
+
query?: {
|
|
386
|
+
/** @description Get responses that match search param value */
|
|
387
|
+
search?: string;
|
|
388
|
+
/** @description Get ordered responses */
|
|
389
|
+
order?: string;
|
|
390
|
+
/** @description Get responses by page */
|
|
391
|
+
page?: string;
|
|
392
|
+
/** @description Get responses by pagesize */
|
|
393
|
+
pagesize?: string;
|
|
394
|
+
/** @description JSON-encoded filter string for assignment and soft-delete filters. */
|
|
395
|
+
filter?: string;
|
|
396
|
+
/** @description When true, include views shared with the user. */
|
|
397
|
+
shared?: boolean;
|
|
398
|
+
/** @description Filter by visibility level (public, private). */
|
|
399
|
+
visibility?: string;
|
|
400
|
+
/** @description Organization ID to scope the request. */
|
|
401
|
+
orgId?: string;
|
|
402
|
+
/** @description UUID of the user whose views to retrieve. */
|
|
403
|
+
userId?: string;
|
|
404
|
+
};
|
|
405
|
+
header?: never;
|
|
406
|
+
path?: never;
|
|
407
|
+
cookie?: never;
|
|
408
|
+
};
|
|
409
|
+
requestBody?: never;
|
|
410
|
+
responses: {
|
|
411
|
+
/** @description Views page */
|
|
412
|
+
200: {
|
|
413
|
+
headers: {
|
|
414
|
+
[name: string]: unknown;
|
|
415
|
+
};
|
|
416
|
+
content: {
|
|
417
|
+
"application/json": {
|
|
418
|
+
page?: number;
|
|
419
|
+
page_size?: number;
|
|
420
|
+
total_count?: number;
|
|
421
|
+
/** @description Views in this page, enriched with workspace and organization context. */
|
|
422
|
+
views?: {
|
|
423
|
+
/** Format: uuid */
|
|
424
|
+
id?: string;
|
|
425
|
+
/** @description Display name of the view. */
|
|
426
|
+
name?: string;
|
|
427
|
+
/** @description Visibility level of the view. */
|
|
428
|
+
visibility?: string;
|
|
429
|
+
/** @description Filter configuration for this view. */
|
|
430
|
+
filters?: Record<string, never>;
|
|
431
|
+
/** @description Metadata associated with the view. */
|
|
432
|
+
metadata?: Record<string, never>;
|
|
433
|
+
/**
|
|
434
|
+
* Format: uuid
|
|
435
|
+
* @description ID of the user who created the view.
|
|
436
|
+
*/
|
|
437
|
+
user_id?: string;
|
|
438
|
+
/** @description Name of the workspace this view belongs to. */
|
|
439
|
+
workspace_name?: string;
|
|
440
|
+
/**
|
|
441
|
+
* Format: uuid
|
|
442
|
+
* @description ID of the workspace this view belongs to.
|
|
443
|
+
*/
|
|
444
|
+
workspace_id: string;
|
|
445
|
+
/**
|
|
446
|
+
* Format: uuid
|
|
447
|
+
* @description ID of the organization this view belongs to.
|
|
448
|
+
*/
|
|
449
|
+
organization_id: string;
|
|
450
|
+
/** @description Name of the organization this view belongs to. */
|
|
451
|
+
organization_name?: string;
|
|
452
|
+
/**
|
|
453
|
+
* Format: date-time
|
|
454
|
+
* @description Timestamp when the resource was created.
|
|
455
|
+
*/
|
|
456
|
+
created_at?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Format: date-time
|
|
459
|
+
* @description Timestamp when the resource was updated.
|
|
460
|
+
*/
|
|
461
|
+
updated_at?: string;
|
|
462
|
+
/**
|
|
463
|
+
* Format: date-time
|
|
464
|
+
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
465
|
+
*/
|
|
466
|
+
deleted_at?: string;
|
|
467
|
+
}[];
|
|
468
|
+
};
|
|
469
|
+
};
|
|
470
|
+
};
|
|
471
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
472
|
+
401: {
|
|
473
|
+
headers: {
|
|
474
|
+
[name: string]: unknown;
|
|
475
|
+
};
|
|
476
|
+
content: {
|
|
477
|
+
"text/plain": string;
|
|
478
|
+
};
|
|
479
|
+
};
|
|
480
|
+
/** @description Internal server error */
|
|
481
|
+
500: {
|
|
482
|
+
headers: {
|
|
483
|
+
[name: string]: unknown;
|
|
484
|
+
};
|
|
485
|
+
content: {
|
|
486
|
+
"text/plain": string;
|
|
487
|
+
};
|
|
488
|
+
};
|
|
489
|
+
};
|
|
490
|
+
};
|
|
491
|
+
createView: {
|
|
492
|
+
parameters: {
|
|
493
|
+
query?: never;
|
|
494
|
+
header?: never;
|
|
495
|
+
path?: never;
|
|
496
|
+
cookie?: never;
|
|
497
|
+
};
|
|
498
|
+
/** @description Body for creating or updating a view */
|
|
499
|
+
requestBody: {
|
|
500
|
+
content: {
|
|
501
|
+
"application/json": {
|
|
502
|
+
/** @description Display name of the view. */
|
|
503
|
+
name: string;
|
|
504
|
+
/** @description Filter configuration for this view. */
|
|
505
|
+
filters?: Record<string, never>;
|
|
506
|
+
/** @description Visibility level of the view. */
|
|
507
|
+
visibility?: string;
|
|
508
|
+
/** @description Metadata associated with the view. */
|
|
509
|
+
metadata?: Record<string, never>;
|
|
510
|
+
};
|
|
511
|
+
};
|
|
512
|
+
};
|
|
513
|
+
responses: {
|
|
514
|
+
/** @description Created view */
|
|
515
|
+
201: {
|
|
516
|
+
headers: {
|
|
517
|
+
[name: string]: unknown;
|
|
518
|
+
};
|
|
519
|
+
content: {
|
|
520
|
+
"application/json": {
|
|
521
|
+
/**
|
|
522
|
+
* Format: uuid
|
|
523
|
+
* @description Unique identifier for the view.
|
|
524
|
+
*/
|
|
525
|
+
id: string;
|
|
526
|
+
/** @description Display name of the view. */
|
|
527
|
+
name: string;
|
|
528
|
+
/** @description Visibility level of the view. */
|
|
529
|
+
visibility: string;
|
|
530
|
+
/** @description Filter configuration that defines which resources this view displays. */
|
|
531
|
+
filters?: Record<string, never>;
|
|
532
|
+
/** @description Additional metadata associated with the view. */
|
|
533
|
+
metadata?: Record<string, never>;
|
|
534
|
+
/**
|
|
535
|
+
* Format: uuid
|
|
536
|
+
* @description ID of the user who created the view.
|
|
537
|
+
*/
|
|
538
|
+
user_id: string;
|
|
539
|
+
/**
|
|
540
|
+
* Format: date-time
|
|
541
|
+
* @description Timestamp when the view was created.
|
|
542
|
+
*/
|
|
543
|
+
created_at: string;
|
|
544
|
+
/**
|
|
545
|
+
* Format: date-time
|
|
546
|
+
* @description Timestamp when the view was last updated.
|
|
547
|
+
*/
|
|
548
|
+
updated_at: string;
|
|
549
|
+
/**
|
|
550
|
+
* Format: date-time
|
|
551
|
+
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
552
|
+
*/
|
|
553
|
+
deleted_at?: string | null;
|
|
554
|
+
};
|
|
555
|
+
};
|
|
556
|
+
};
|
|
557
|
+
/** @description Invalid request body or request param */
|
|
558
|
+
400: {
|
|
559
|
+
headers: {
|
|
560
|
+
[name: string]: unknown;
|
|
561
|
+
};
|
|
562
|
+
content: {
|
|
563
|
+
"text/plain": string;
|
|
564
|
+
};
|
|
565
|
+
};
|
|
566
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
567
|
+
401: {
|
|
568
|
+
headers: {
|
|
569
|
+
[name: string]: unknown;
|
|
570
|
+
};
|
|
571
|
+
content: {
|
|
572
|
+
"text/plain": string;
|
|
573
|
+
};
|
|
574
|
+
};
|
|
575
|
+
/** @description Internal server error */
|
|
576
|
+
500: {
|
|
577
|
+
headers: {
|
|
578
|
+
[name: string]: unknown;
|
|
579
|
+
};
|
|
580
|
+
content: {
|
|
581
|
+
"text/plain": string;
|
|
582
|
+
};
|
|
583
|
+
};
|
|
584
|
+
};
|
|
585
|
+
};
|
|
586
|
+
shareView: {
|
|
587
|
+
parameters: {
|
|
588
|
+
query?: never;
|
|
589
|
+
header?: never;
|
|
590
|
+
path?: never;
|
|
591
|
+
cookie?: never;
|
|
592
|
+
};
|
|
593
|
+
/** @description Body for sharing a view with recipients by email. */
|
|
594
|
+
requestBody: {
|
|
595
|
+
content: {
|
|
596
|
+
"application/json": {
|
|
597
|
+
/**
|
|
598
|
+
* Format: uuid
|
|
599
|
+
* @description Identifier of the view being shared.
|
|
600
|
+
*/
|
|
601
|
+
content_id: string;
|
|
602
|
+
/**
|
|
603
|
+
* @description The kind of content being shared. Only `view` is accepted on this
|
|
604
|
+
* endpoint.
|
|
605
|
+
* @enum {string}
|
|
606
|
+
*/
|
|
607
|
+
content_type: "view";
|
|
608
|
+
/** @description Email addresses of the recipients to share this view with. */
|
|
609
|
+
emails: string[];
|
|
610
|
+
/**
|
|
611
|
+
* @description When true, flip the view's visibility to public and send invitation
|
|
612
|
+
* emails to the recipients. When false, revert visibility to private.
|
|
613
|
+
*/
|
|
614
|
+
share: boolean;
|
|
615
|
+
};
|
|
616
|
+
};
|
|
735
617
|
};
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
739
|
-
|
|
740
|
-
|
|
618
|
+
responses: {
|
|
619
|
+
/** @description View shared. */
|
|
620
|
+
200: {
|
|
621
|
+
headers: {
|
|
622
|
+
[name: string]: unknown;
|
|
623
|
+
};
|
|
624
|
+
content?: never;
|
|
625
|
+
};
|
|
626
|
+
/** @description Invalid request body or request param */
|
|
627
|
+
400: {
|
|
628
|
+
headers: {
|
|
629
|
+
[name: string]: unknown;
|
|
630
|
+
};
|
|
631
|
+
content: {
|
|
632
|
+
"text/plain": string;
|
|
633
|
+
};
|
|
634
|
+
};
|
|
635
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
636
|
+
401: {
|
|
637
|
+
headers: {
|
|
638
|
+
[name: string]: unknown;
|
|
639
|
+
};
|
|
640
|
+
content: {
|
|
641
|
+
"text/plain": string;
|
|
642
|
+
};
|
|
643
|
+
};
|
|
644
|
+
/** @description Caller is not the owner of the view. */
|
|
645
|
+
403: {
|
|
646
|
+
headers: {
|
|
647
|
+
[name: string]: unknown;
|
|
648
|
+
};
|
|
649
|
+
content?: never;
|
|
650
|
+
};
|
|
651
|
+
/** @description Result not found */
|
|
652
|
+
404: {
|
|
653
|
+
headers: {
|
|
654
|
+
[name: string]: unknown;
|
|
655
|
+
};
|
|
656
|
+
content: {
|
|
657
|
+
"text/plain": string;
|
|
658
|
+
};
|
|
659
|
+
};
|
|
660
|
+
/** @description Internal server error */
|
|
661
|
+
500: {
|
|
662
|
+
headers: {
|
|
663
|
+
[name: string]: unknown;
|
|
664
|
+
};
|
|
665
|
+
content: {
|
|
666
|
+
"text/plain": string;
|
|
667
|
+
};
|
|
668
|
+
};
|
|
741
669
|
};
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
670
|
+
};
|
|
671
|
+
getViewById: {
|
|
672
|
+
parameters: {
|
|
673
|
+
query?: never;
|
|
674
|
+
header?: never;
|
|
675
|
+
path: {
|
|
676
|
+
/** @description View ID */
|
|
677
|
+
viewId: string;
|
|
678
|
+
};
|
|
679
|
+
cookie?: never;
|
|
680
|
+
};
|
|
681
|
+
requestBody?: never;
|
|
682
|
+
responses: {
|
|
683
|
+
/** @description View */
|
|
684
|
+
200: {
|
|
685
|
+
headers: {
|
|
686
|
+
[name: string]: unknown;
|
|
687
|
+
};
|
|
688
|
+
content: {
|
|
689
|
+
"application/json": {
|
|
690
|
+
/**
|
|
691
|
+
* Format: uuid
|
|
692
|
+
* @description Unique identifier for the view.
|
|
693
|
+
*/
|
|
694
|
+
id: string;
|
|
695
|
+
/** @description Display name of the view. */
|
|
696
|
+
name: string;
|
|
697
|
+
/** @description Visibility level of the view. */
|
|
698
|
+
visibility: string;
|
|
699
|
+
/** @description Filter configuration that defines which resources this view displays. */
|
|
700
|
+
filters?: Record<string, never>;
|
|
701
|
+
/** @description Additional metadata associated with the view. */
|
|
702
|
+
metadata?: Record<string, never>;
|
|
703
|
+
/**
|
|
704
|
+
* Format: uuid
|
|
705
|
+
* @description ID of the user who created the view.
|
|
706
|
+
*/
|
|
707
|
+
user_id: string;
|
|
708
|
+
/**
|
|
709
|
+
* Format: date-time
|
|
710
|
+
* @description Timestamp when the view was created.
|
|
711
|
+
*/
|
|
712
|
+
created_at: string;
|
|
713
|
+
/**
|
|
714
|
+
* Format: date-time
|
|
715
|
+
* @description Timestamp when the view was last updated.
|
|
716
|
+
*/
|
|
717
|
+
updated_at: string;
|
|
718
|
+
/**
|
|
719
|
+
* Format: date-time
|
|
720
|
+
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
721
|
+
*/
|
|
722
|
+
deleted_at?: string | null;
|
|
723
|
+
};
|
|
724
|
+
};
|
|
725
|
+
};
|
|
726
|
+
/** @description Invalid request body or request param */
|
|
727
|
+
400: {
|
|
728
|
+
headers: {
|
|
729
|
+
[name: string]: unknown;
|
|
730
|
+
};
|
|
731
|
+
content: {
|
|
732
|
+
"text/plain": string;
|
|
733
|
+
};
|
|
734
|
+
};
|
|
735
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
736
|
+
401: {
|
|
737
|
+
headers: {
|
|
738
|
+
[name: string]: unknown;
|
|
739
|
+
};
|
|
740
|
+
content: {
|
|
741
|
+
"text/plain": string;
|
|
742
|
+
};
|
|
743
|
+
};
|
|
744
|
+
/** @description Result not found */
|
|
745
|
+
404: {
|
|
746
|
+
headers: {
|
|
747
|
+
[name: string]: unknown;
|
|
748
|
+
};
|
|
749
|
+
content: {
|
|
750
|
+
"text/plain": string;
|
|
751
|
+
};
|
|
752
|
+
};
|
|
753
|
+
/** @description Internal server error */
|
|
754
|
+
500: {
|
|
755
|
+
headers: {
|
|
756
|
+
[name: string]: unknown;
|
|
757
|
+
};
|
|
758
|
+
content: {
|
|
759
|
+
"text/plain": string;
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
};
|
|
763
|
+
};
|
|
764
|
+
updateView: {
|
|
765
|
+
parameters: {
|
|
766
|
+
query?: never;
|
|
767
|
+
header?: never;
|
|
768
|
+
path: {
|
|
769
|
+
/** @description View ID */
|
|
770
|
+
viewId: string;
|
|
771
|
+
};
|
|
772
|
+
cookie?: never;
|
|
773
|
+
};
|
|
774
|
+
/** @description Body for creating or updating a view */
|
|
775
|
+
requestBody: {
|
|
776
|
+
content: {
|
|
777
|
+
"application/json": {
|
|
778
|
+
/** @description Display name of the view. */
|
|
779
|
+
name: string;
|
|
780
|
+
/** @description Filter configuration for this view. */
|
|
781
|
+
filters?: Record<string, never>;
|
|
782
|
+
/** @description Visibility level of the view. */
|
|
783
|
+
visibility?: string;
|
|
784
|
+
/** @description Metadata associated with the view. */
|
|
785
|
+
metadata?: Record<string, never>;
|
|
786
|
+
};
|
|
787
|
+
};
|
|
747
788
|
};
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
789
|
+
responses: {
|
|
790
|
+
/** @description Updated view */
|
|
791
|
+
200: {
|
|
792
|
+
headers: {
|
|
793
|
+
[name: string]: unknown;
|
|
794
|
+
};
|
|
795
|
+
content: {
|
|
796
|
+
"application/json": {
|
|
797
|
+
/**
|
|
798
|
+
* Format: uuid
|
|
799
|
+
* @description Unique identifier for the view.
|
|
800
|
+
*/
|
|
801
|
+
id: string;
|
|
802
|
+
/** @description Display name of the view. */
|
|
803
|
+
name: string;
|
|
804
|
+
/** @description Visibility level of the view. */
|
|
805
|
+
visibility: string;
|
|
806
|
+
/** @description Filter configuration that defines which resources this view displays. */
|
|
807
|
+
filters?: Record<string, never>;
|
|
808
|
+
/** @description Additional metadata associated with the view. */
|
|
809
|
+
metadata?: Record<string, never>;
|
|
810
|
+
/**
|
|
811
|
+
* Format: uuid
|
|
812
|
+
* @description ID of the user who created the view.
|
|
813
|
+
*/
|
|
814
|
+
user_id: string;
|
|
815
|
+
/**
|
|
816
|
+
* Format: date-time
|
|
817
|
+
* @description Timestamp when the view was created.
|
|
818
|
+
*/
|
|
819
|
+
created_at: string;
|
|
820
|
+
/**
|
|
821
|
+
* Format: date-time
|
|
822
|
+
* @description Timestamp when the view was last updated.
|
|
823
|
+
*/
|
|
824
|
+
updated_at: string;
|
|
825
|
+
/**
|
|
826
|
+
* Format: date-time
|
|
827
|
+
* @description Timestamp when the view was soft deleted. Null while the view remains active.
|
|
828
|
+
*/
|
|
829
|
+
deleted_at?: string | null;
|
|
830
|
+
};
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
/** @description Invalid request body or request param */
|
|
834
|
+
400: {
|
|
835
|
+
headers: {
|
|
836
|
+
[name: string]: unknown;
|
|
837
|
+
};
|
|
838
|
+
content: {
|
|
839
|
+
"text/plain": string;
|
|
840
|
+
};
|
|
841
|
+
};
|
|
842
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
843
|
+
401: {
|
|
844
|
+
headers: {
|
|
845
|
+
[name: string]: unknown;
|
|
846
|
+
};
|
|
847
|
+
content: {
|
|
848
|
+
"text/plain": string;
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
/** @description Result not found */
|
|
852
|
+
404: {
|
|
853
|
+
headers: {
|
|
854
|
+
[name: string]: unknown;
|
|
855
|
+
};
|
|
856
|
+
content: {
|
|
857
|
+
"text/plain": string;
|
|
858
|
+
};
|
|
859
|
+
};
|
|
860
|
+
/** @description Internal server error */
|
|
861
|
+
500: {
|
|
862
|
+
headers: {
|
|
863
|
+
[name: string]: unknown;
|
|
864
|
+
};
|
|
865
|
+
content: {
|
|
866
|
+
"text/plain": string;
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
};
|
|
871
|
+
deleteView: {
|
|
872
|
+
parameters: {
|
|
873
|
+
query?: never;
|
|
874
|
+
header?: never;
|
|
875
|
+
path: {
|
|
876
|
+
/** @description View ID */
|
|
877
|
+
viewId: string;
|
|
878
|
+
};
|
|
879
|
+
cookie?: never;
|
|
880
|
+
};
|
|
881
|
+
requestBody?: never;
|
|
882
|
+
responses: {
|
|
883
|
+
/** @description View deleted */
|
|
884
|
+
204: {
|
|
885
|
+
headers: {
|
|
886
|
+
[name: string]: unknown;
|
|
887
|
+
};
|
|
888
|
+
content?: never;
|
|
889
|
+
};
|
|
890
|
+
/** @description Invalid request body or request param */
|
|
891
|
+
400: {
|
|
892
|
+
headers: {
|
|
893
|
+
[name: string]: unknown;
|
|
894
|
+
};
|
|
895
|
+
content: {
|
|
896
|
+
"text/plain": string;
|
|
897
|
+
};
|
|
898
|
+
};
|
|
899
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
900
|
+
401: {
|
|
901
|
+
headers: {
|
|
902
|
+
[name: string]: unknown;
|
|
903
|
+
};
|
|
904
|
+
content: {
|
|
905
|
+
"text/plain": string;
|
|
906
|
+
};
|
|
907
|
+
};
|
|
908
|
+
/** @description Result not found */
|
|
909
|
+
404: {
|
|
910
|
+
headers: {
|
|
911
|
+
[name: string]: unknown;
|
|
912
|
+
};
|
|
913
|
+
content: {
|
|
914
|
+
"text/plain": string;
|
|
915
|
+
};
|
|
916
|
+
};
|
|
917
|
+
/** @description Internal server error */
|
|
918
|
+
500: {
|
|
919
|
+
headers: {
|
|
920
|
+
[name: string]: unknown;
|
|
921
|
+
};
|
|
922
|
+
content: {
|
|
923
|
+
"text/plain": string;
|
|
924
|
+
};
|
|
925
|
+
};
|
|
753
926
|
};
|
|
754
|
-
};
|
|
755
927
|
};
|
|
756
|
-
};
|
|
757
928
|
}
|
|
758
|
-
|
|
759
|
-
export interface external {}
|