@meshery/schemas 1.2.22 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cloudApi.d.mts +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,88 +4,129 @@
|
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
export interface paths {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
7
|
+
"/api/integrations/support": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
get?: never;
|
|
15
|
+
put?: never;
|
|
16
|
+
/** Submit a support request */
|
|
17
|
+
post: operations["submitSupportRequest"];
|
|
18
|
+
delete?: never;
|
|
19
|
+
options?: never;
|
|
20
|
+
head?: never;
|
|
21
|
+
patch?: never;
|
|
22
|
+
trace?: never;
|
|
23
|
+
};
|
|
10
24
|
}
|
|
11
|
-
|
|
25
|
+
export type webhooks = Record<string, never>;
|
|
12
26
|
export interface components {
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
27
|
+
schemas: {
|
|
28
|
+
/** @description Payload for submitting a help-and-support request. */
|
|
29
|
+
SupportRequest: {
|
|
30
|
+
/**
|
|
31
|
+
* Subject
|
|
32
|
+
* @description Concise and descriptive title for the support request.
|
|
33
|
+
*/
|
|
34
|
+
subject: string;
|
|
35
|
+
/**
|
|
36
|
+
* Description
|
|
37
|
+
* @description Detailed description of the issue or question.
|
|
38
|
+
*/
|
|
39
|
+
message: string;
|
|
40
|
+
/**
|
|
41
|
+
* Scope
|
|
42
|
+
* @description Category that best represents the nature of the inquiry.
|
|
43
|
+
* @enum {string}
|
|
44
|
+
*/
|
|
45
|
+
scope?: "Support" | "Community" | "Account" | "Commercial";
|
|
46
|
+
};
|
|
32
47
|
};
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
48
|
+
responses: {
|
|
49
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
50
|
+
401: {
|
|
51
|
+
headers: {
|
|
52
|
+
[name: string]: unknown;
|
|
53
|
+
};
|
|
54
|
+
content: {
|
|
55
|
+
"text/plain": string;
|
|
56
|
+
};
|
|
57
|
+
};
|
|
40
58
|
};
|
|
41
|
-
|
|
59
|
+
parameters: never;
|
|
60
|
+
requestBodies: never;
|
|
61
|
+
headers: never;
|
|
62
|
+
pathItems: never;
|
|
42
63
|
}
|
|
43
|
-
|
|
64
|
+
export type $defs = Record<string, never>;
|
|
44
65
|
export interface operations {
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
message?: string;
|
|
52
|
-
};
|
|
66
|
+
submitSupportRequest: {
|
|
67
|
+
parameters: {
|
|
68
|
+
query?: never;
|
|
69
|
+
header?: never;
|
|
70
|
+
path?: never;
|
|
71
|
+
cookie?: never;
|
|
53
72
|
};
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
73
|
+
requestBody: {
|
|
74
|
+
content: {
|
|
75
|
+
"application/json": {
|
|
76
|
+
/**
|
|
77
|
+
* Subject
|
|
78
|
+
* @description Concise and descriptive title for the support request.
|
|
79
|
+
*/
|
|
80
|
+
subject: string;
|
|
81
|
+
/**
|
|
82
|
+
* Description
|
|
83
|
+
* @description Detailed description of the issue or question.
|
|
84
|
+
*/
|
|
85
|
+
message: string;
|
|
86
|
+
/**
|
|
87
|
+
* Scope
|
|
88
|
+
* @description Category that best represents the nature of the inquiry.
|
|
89
|
+
* @enum {string}
|
|
90
|
+
*/
|
|
91
|
+
scope?: "Support" | "Community" | "Account" | "Commercial";
|
|
92
|
+
};
|
|
93
|
+
};
|
|
61
94
|
};
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
95
|
+
responses: {
|
|
96
|
+
/** @description Support request submitted */
|
|
97
|
+
201: {
|
|
98
|
+
headers: {
|
|
99
|
+
[name: string]: unknown;
|
|
100
|
+
};
|
|
101
|
+
content: {
|
|
102
|
+
"application/json": {
|
|
103
|
+
message?: string;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
/** @description Invalid request format */
|
|
108
|
+
400: {
|
|
109
|
+
headers: {
|
|
110
|
+
[name: string]: unknown;
|
|
111
|
+
};
|
|
112
|
+
content?: never;
|
|
113
|
+
};
|
|
114
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
115
|
+
401: {
|
|
116
|
+
headers: {
|
|
117
|
+
[name: string]: unknown;
|
|
118
|
+
};
|
|
119
|
+
content: {
|
|
120
|
+
"text/plain": string;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
/** @description Internal server error */
|
|
124
|
+
500: {
|
|
125
|
+
headers: {
|
|
126
|
+
[name: string]: unknown;
|
|
127
|
+
};
|
|
128
|
+
content?: never;
|
|
129
|
+
};
|
|
85
130
|
};
|
|
86
|
-
};
|
|
87
131
|
};
|
|
88
|
-
};
|
|
89
132
|
}
|
|
90
|
-
|
|
91
|
-
export interface external {}
|
|
@@ -0,0 +1,434 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
export interface paths {
|
|
7
|
+
"/api/system/database": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Get a summary of the Meshery server's database
|
|
16
|
+
* @description Returns a paginated summary of Meshery database tables and row counts.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["getSystemDatabase"];
|
|
19
|
+
put?: never;
|
|
20
|
+
post?: never;
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
26
|
+
};
|
|
27
|
+
"/api/system/database/reset": {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: never;
|
|
30
|
+
header?: never;
|
|
31
|
+
path?: never;
|
|
32
|
+
cookie?: never;
|
|
33
|
+
};
|
|
34
|
+
get?: never;
|
|
35
|
+
put?: never;
|
|
36
|
+
post?: never;
|
|
37
|
+
/**
|
|
38
|
+
* Reset the Meshery server's database
|
|
39
|
+
* @description Resets the Meshery server database. This is a destructive operation.
|
|
40
|
+
*/
|
|
41
|
+
delete: operations["resetSystemDatabase"];
|
|
42
|
+
options?: never;
|
|
43
|
+
head?: never;
|
|
44
|
+
patch?: never;
|
|
45
|
+
trace?: never;
|
|
46
|
+
};
|
|
47
|
+
"/api/system/version": {
|
|
48
|
+
parameters: {
|
|
49
|
+
query?: never;
|
|
50
|
+
header?: never;
|
|
51
|
+
path?: never;
|
|
52
|
+
cookie?: never;
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* Get the running Meshery server's version metadata
|
|
56
|
+
* @description Returns version metadata for the running Meshery service.
|
|
57
|
+
*/
|
|
58
|
+
get: operations["getSystemVersion"];
|
|
59
|
+
put?: never;
|
|
60
|
+
post?: never;
|
|
61
|
+
delete?: never;
|
|
62
|
+
options?: never;
|
|
63
|
+
head?: never;
|
|
64
|
+
patch?: never;
|
|
65
|
+
trace?: never;
|
|
66
|
+
};
|
|
67
|
+
"/api/system/sync": {
|
|
68
|
+
parameters: {
|
|
69
|
+
query?: never;
|
|
70
|
+
header?: never;
|
|
71
|
+
path?: never;
|
|
72
|
+
cookie?: never;
|
|
73
|
+
};
|
|
74
|
+
/**
|
|
75
|
+
* Get initial session bootstrap data
|
|
76
|
+
* @description Returns session bootstrap data for the authenticated user.
|
|
77
|
+
*/
|
|
78
|
+
get: operations["getSystemSync"];
|
|
79
|
+
put?: never;
|
|
80
|
+
post?: never;
|
|
81
|
+
delete?: never;
|
|
82
|
+
options?: never;
|
|
83
|
+
head?: never;
|
|
84
|
+
patch?: never;
|
|
85
|
+
trace?: never;
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
export type webhooks = Record<string, never>;
|
|
89
|
+
export interface components {
|
|
90
|
+
schemas: {
|
|
91
|
+
/** @description Status message response. */
|
|
92
|
+
SystemMessageResponse: {
|
|
93
|
+
/** @description Human-readable status message. */
|
|
94
|
+
message: string;
|
|
95
|
+
};
|
|
96
|
+
/** @description Database table summary. */
|
|
97
|
+
SystemDatabaseTable: {
|
|
98
|
+
/** @description Name of the table. */
|
|
99
|
+
name: string;
|
|
100
|
+
/** @description SQLite object type (e.g. `table`). */
|
|
101
|
+
type: string;
|
|
102
|
+
/**
|
|
103
|
+
* Format: int64
|
|
104
|
+
* @description Number of rows currently in the table.
|
|
105
|
+
*/
|
|
106
|
+
count: number;
|
|
107
|
+
};
|
|
108
|
+
/** @description Paginated summary of the Meshery server's embedded database. */
|
|
109
|
+
SystemDatabaseSummary: {
|
|
110
|
+
/** @description Zero-based page index of the returned table slice. */
|
|
111
|
+
page: number;
|
|
112
|
+
/** @description Number of tables included in this page. */
|
|
113
|
+
pageSize: number;
|
|
114
|
+
/** @description Total number of tables in the database matching the search filter. */
|
|
115
|
+
totalTables: number;
|
|
116
|
+
/** @description Aggregate row count across the tables returned in this page. */
|
|
117
|
+
recordCount: number;
|
|
118
|
+
/** @description Tables included in this page, with per-table row counts. */
|
|
119
|
+
tables: {
|
|
120
|
+
/** @description Name of the table. */
|
|
121
|
+
name: string;
|
|
122
|
+
/** @description SQLite object type (e.g. `table`). */
|
|
123
|
+
type: string;
|
|
124
|
+
/**
|
|
125
|
+
* Format: int64
|
|
126
|
+
* @description Number of rows currently in the table.
|
|
127
|
+
*/
|
|
128
|
+
count: number;
|
|
129
|
+
}[];
|
|
130
|
+
};
|
|
131
|
+
/** @description Version metadata for a running Meshery service. */
|
|
132
|
+
SystemVersion: {
|
|
133
|
+
/** @description Meshery Cloud deployment version. */
|
|
134
|
+
version?: string;
|
|
135
|
+
/** @description Build identifier (typically the git tag of the running binary). */
|
|
136
|
+
build?: string;
|
|
137
|
+
/** @description Latest available Meshery release tag fetched from GitHub. */
|
|
138
|
+
latest?: string;
|
|
139
|
+
/** @description True when the running build is older than the latest available release. */
|
|
140
|
+
outdated?: boolean;
|
|
141
|
+
/** @description Git commit SHA of the running service. The wire field is `commitsha`. */
|
|
142
|
+
commitsha?: string;
|
|
143
|
+
/** @description Release channel of the running binary (e.g. `stable`, `edge`). */
|
|
144
|
+
releaseChannel?: string;
|
|
145
|
+
};
|
|
146
|
+
/** @description Kubernetes context tracked by Meshery. */
|
|
147
|
+
SystemSessionSyncK8sContext: {
|
|
148
|
+
/** @description Stable identifier for the Kubernetes context. */
|
|
149
|
+
id?: string;
|
|
150
|
+
/** @description Human-readable name of the Kubernetes context. */
|
|
151
|
+
name?: string;
|
|
152
|
+
/** @description True when Meshery has a usable kubeconfig for this context. */
|
|
153
|
+
clusterConfigured?: boolean;
|
|
154
|
+
/** @description API server URL for the Kubernetes context. */
|
|
155
|
+
server?: string;
|
|
156
|
+
/**
|
|
157
|
+
* Format: uuid
|
|
158
|
+
* @description Kubernetes server ID associated with this context.
|
|
159
|
+
*/
|
|
160
|
+
clusterId?: string;
|
|
161
|
+
/**
|
|
162
|
+
* Format: date-time
|
|
163
|
+
* @description When the context was first registered with Meshery.
|
|
164
|
+
*/
|
|
165
|
+
createdAt?: string;
|
|
166
|
+
/**
|
|
167
|
+
* Format: date-time
|
|
168
|
+
* @description When the context was last updated.
|
|
169
|
+
*/
|
|
170
|
+
updatedAt?: string;
|
|
171
|
+
};
|
|
172
|
+
/** @description Session bootstrap payload for the authenticated user. */
|
|
173
|
+
SystemSessionSync: {
|
|
174
|
+
/** @description Kubernetes contexts currently tracked by the Meshery server. */
|
|
175
|
+
k8sConfig?: {
|
|
176
|
+
/** @description Stable identifier for the Kubernetes context. */
|
|
177
|
+
id?: string;
|
|
178
|
+
/** @description Human-readable name of the Kubernetes context. */
|
|
179
|
+
name?: string;
|
|
180
|
+
/** @description True when Meshery has a usable kubeconfig for this context. */
|
|
181
|
+
clusterConfigured?: boolean;
|
|
182
|
+
/** @description API server URL for the Kubernetes context. */
|
|
183
|
+
server?: string;
|
|
184
|
+
/**
|
|
185
|
+
* Format: uuid
|
|
186
|
+
* @description Kubernetes server ID associated with this context.
|
|
187
|
+
*/
|
|
188
|
+
clusterId?: string;
|
|
189
|
+
/**
|
|
190
|
+
* Format: date-time
|
|
191
|
+
* @description When the context was first registered with Meshery.
|
|
192
|
+
*/
|
|
193
|
+
createdAt?: string;
|
|
194
|
+
/**
|
|
195
|
+
* Format: date-time
|
|
196
|
+
* @description When the context was last updated.
|
|
197
|
+
*/
|
|
198
|
+
updatedAt?: string;
|
|
199
|
+
}[];
|
|
200
|
+
} & {
|
|
201
|
+
[key: string]: unknown;
|
|
202
|
+
};
|
|
203
|
+
};
|
|
204
|
+
responses: {
|
|
205
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
206
|
+
401: {
|
|
207
|
+
headers: {
|
|
208
|
+
[name: string]: unknown;
|
|
209
|
+
};
|
|
210
|
+
content: {
|
|
211
|
+
"text/plain": string;
|
|
212
|
+
};
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
parameters: never;
|
|
216
|
+
requestBodies: never;
|
|
217
|
+
headers: never;
|
|
218
|
+
pathItems: never;
|
|
219
|
+
}
|
|
220
|
+
export type $defs = Record<string, never>;
|
|
221
|
+
export interface operations {
|
|
222
|
+
getSystemDatabase: {
|
|
223
|
+
parameters: {
|
|
224
|
+
query?: {
|
|
225
|
+
/** @description Zero-based page index for the table list. */
|
|
226
|
+
page?: number;
|
|
227
|
+
/** @description Number of tables to include per page. */
|
|
228
|
+
pageSize?: number;
|
|
229
|
+
/** @description Substring filter applied to table names. */
|
|
230
|
+
search?: string;
|
|
231
|
+
/** @description Column to order the table list by. */
|
|
232
|
+
sort?: "name";
|
|
233
|
+
/** @description Sort direction for the `sort` column. */
|
|
234
|
+
order?: "asc" | "desc";
|
|
235
|
+
};
|
|
236
|
+
header?: never;
|
|
237
|
+
path?: never;
|
|
238
|
+
cookie?: never;
|
|
239
|
+
};
|
|
240
|
+
requestBody?: never;
|
|
241
|
+
responses: {
|
|
242
|
+
/** @description Database summary */
|
|
243
|
+
200: {
|
|
244
|
+
headers: {
|
|
245
|
+
[name: string]: unknown;
|
|
246
|
+
};
|
|
247
|
+
content: {
|
|
248
|
+
"application/json": {
|
|
249
|
+
/** @description Zero-based page index of the returned table slice. */
|
|
250
|
+
page: number;
|
|
251
|
+
/** @description Number of tables included in this page. */
|
|
252
|
+
pageSize: number;
|
|
253
|
+
/** @description Total number of tables in the database matching the search filter. */
|
|
254
|
+
totalTables: number;
|
|
255
|
+
/** @description Aggregate row count across the tables returned in this page. */
|
|
256
|
+
recordCount: number;
|
|
257
|
+
/** @description Tables included in this page, with per-table row counts. */
|
|
258
|
+
tables: {
|
|
259
|
+
/** @description Name of the table. */
|
|
260
|
+
name: string;
|
|
261
|
+
/** @description SQLite object type (e.g. `table`). */
|
|
262
|
+
type: string;
|
|
263
|
+
/**
|
|
264
|
+
* Format: int64
|
|
265
|
+
* @description Number of rows currently in the table.
|
|
266
|
+
*/
|
|
267
|
+
count: number;
|
|
268
|
+
}[];
|
|
269
|
+
};
|
|
270
|
+
};
|
|
271
|
+
};
|
|
272
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
273
|
+
401: {
|
|
274
|
+
headers: {
|
|
275
|
+
[name: string]: unknown;
|
|
276
|
+
};
|
|
277
|
+
content: {
|
|
278
|
+
"text/plain": string;
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
/** @description Internal server error */
|
|
282
|
+
500: {
|
|
283
|
+
headers: {
|
|
284
|
+
[name: string]: unknown;
|
|
285
|
+
};
|
|
286
|
+
content?: never;
|
|
287
|
+
};
|
|
288
|
+
};
|
|
289
|
+
};
|
|
290
|
+
resetSystemDatabase: {
|
|
291
|
+
parameters: {
|
|
292
|
+
query?: never;
|
|
293
|
+
header?: never;
|
|
294
|
+
path?: never;
|
|
295
|
+
cookie?: never;
|
|
296
|
+
};
|
|
297
|
+
requestBody?: never;
|
|
298
|
+
responses: {
|
|
299
|
+
/** @description Database reset */
|
|
300
|
+
200: {
|
|
301
|
+
headers: {
|
|
302
|
+
[name: string]: unknown;
|
|
303
|
+
};
|
|
304
|
+
content: {
|
|
305
|
+
"application/json": {
|
|
306
|
+
/** @description Human-readable status message. */
|
|
307
|
+
message: string;
|
|
308
|
+
};
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
312
|
+
401: {
|
|
313
|
+
headers: {
|
|
314
|
+
[name: string]: unknown;
|
|
315
|
+
};
|
|
316
|
+
content: {
|
|
317
|
+
"text/plain": string;
|
|
318
|
+
};
|
|
319
|
+
};
|
|
320
|
+
/** @description Internal server error during reset (archive, drop, migrate, or reseed). */
|
|
321
|
+
500: {
|
|
322
|
+
headers: {
|
|
323
|
+
[name: string]: unknown;
|
|
324
|
+
};
|
|
325
|
+
content?: never;
|
|
326
|
+
};
|
|
327
|
+
};
|
|
328
|
+
};
|
|
329
|
+
getSystemVersion: {
|
|
330
|
+
parameters: {
|
|
331
|
+
query?: never;
|
|
332
|
+
header?: never;
|
|
333
|
+
path?: never;
|
|
334
|
+
cookie?: never;
|
|
335
|
+
};
|
|
336
|
+
requestBody?: never;
|
|
337
|
+
responses: {
|
|
338
|
+
/** @description Server version metadata */
|
|
339
|
+
200: {
|
|
340
|
+
headers: {
|
|
341
|
+
[name: string]: unknown;
|
|
342
|
+
};
|
|
343
|
+
content: {
|
|
344
|
+
"application/json": {
|
|
345
|
+
/** @description Meshery Cloud deployment version. */
|
|
346
|
+
version?: string;
|
|
347
|
+
/** @description Build identifier (typically the git tag of the running binary). */
|
|
348
|
+
build?: string;
|
|
349
|
+
/** @description Latest available Meshery release tag fetched from GitHub. */
|
|
350
|
+
latest?: string;
|
|
351
|
+
/** @description True when the running build is older than the latest available release. */
|
|
352
|
+
outdated?: boolean;
|
|
353
|
+
/** @description Git commit SHA of the running service. The wire field is `commitsha`. */
|
|
354
|
+
commitsha?: string;
|
|
355
|
+
/** @description Release channel of the running binary (e.g. `stable`, `edge`). */
|
|
356
|
+
releaseChannel?: string;
|
|
357
|
+
};
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
/** @description Encoding error while serializing the version payload. */
|
|
361
|
+
500: {
|
|
362
|
+
headers: {
|
|
363
|
+
[name: string]: unknown;
|
|
364
|
+
};
|
|
365
|
+
content?: never;
|
|
366
|
+
};
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
getSystemSync: {
|
|
370
|
+
parameters: {
|
|
371
|
+
query?: never;
|
|
372
|
+
header?: never;
|
|
373
|
+
path?: never;
|
|
374
|
+
cookie?: never;
|
|
375
|
+
};
|
|
376
|
+
requestBody?: never;
|
|
377
|
+
responses: {
|
|
378
|
+
/** @description Session sync payload */
|
|
379
|
+
200: {
|
|
380
|
+
headers: {
|
|
381
|
+
[name: string]: unknown;
|
|
382
|
+
};
|
|
383
|
+
content: {
|
|
384
|
+
"application/json": {
|
|
385
|
+
/** @description Kubernetes contexts currently tracked by the Meshery server. */
|
|
386
|
+
k8sConfig?: {
|
|
387
|
+
/** @description Stable identifier for the Kubernetes context. */
|
|
388
|
+
id?: string;
|
|
389
|
+
/** @description Human-readable name of the Kubernetes context. */
|
|
390
|
+
name?: string;
|
|
391
|
+
/** @description True when Meshery has a usable kubeconfig for this context. */
|
|
392
|
+
clusterConfigured?: boolean;
|
|
393
|
+
/** @description API server URL for the Kubernetes context. */
|
|
394
|
+
server?: string;
|
|
395
|
+
/**
|
|
396
|
+
* Format: uuid
|
|
397
|
+
* @description Kubernetes server ID associated with this context.
|
|
398
|
+
*/
|
|
399
|
+
clusterId?: string;
|
|
400
|
+
/**
|
|
401
|
+
* Format: date-time
|
|
402
|
+
* @description When the context was first registered with Meshery.
|
|
403
|
+
*/
|
|
404
|
+
createdAt?: string;
|
|
405
|
+
/**
|
|
406
|
+
* Format: date-time
|
|
407
|
+
* @description When the context was last updated.
|
|
408
|
+
*/
|
|
409
|
+
updatedAt?: string;
|
|
410
|
+
}[];
|
|
411
|
+
} & {
|
|
412
|
+
[key: string]: unknown;
|
|
413
|
+
};
|
|
414
|
+
};
|
|
415
|
+
};
|
|
416
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
417
|
+
401: {
|
|
418
|
+
headers: {
|
|
419
|
+
[name: string]: unknown;
|
|
420
|
+
};
|
|
421
|
+
content: {
|
|
422
|
+
"text/plain": string;
|
|
423
|
+
};
|
|
424
|
+
};
|
|
425
|
+
/** @description Marshal error while serializing the session sync payload. */
|
|
426
|
+
500: {
|
|
427
|
+
headers: {
|
|
428
|
+
[name: string]: unknown;
|
|
429
|
+
};
|
|
430
|
+
content?: never;
|
|
431
|
+
};
|
|
432
|
+
};
|
|
433
|
+
};
|
|
434
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
'use strict';
|
|
File without changes
|
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
'use strict';var e={openapi:"3.0.0",info:{title:"System API",description:"OpenAPI schema for Meshery server operational endpoints.",version:"v1beta1",contact:{name:"Meshery Maintainers",email:"maintainers@meshery.io",url:"https://meshery.io"},license:{name:"Apache 2.0",url:"https://www.apache.org/licenses/LICENSE-2.0.html"}},security:[{jwt:[]}],tags:[{name:"System",description:"Operational endpoints for Meshery Server."}],paths:{"/api/system/database":{get:{"x-internal":["meshery"],tags:["System"],summary:"Get a summary of the Meshery server's database",description:"Returns a paginated summary of Meshery database tables and row counts.",operationId:"getSystemDatabase",parameters:[{name:"page",in:"query",description:"Zero-based page index for the table list.",required:false,schema:{type:"integer",minimum:0}},{name:"pageSize",in:"query",description:"Number of tables to include per page.",required:false,schema:{type:"integer",minimum:1}},{name:"search",in:"query",description:"Substring filter applied to table names.",required:false,schema:{type:"string",maxLength:255}},{name:"sort",in:"query",description:"Column to order the table list by.",required:false,schema:{type:"string",enum:["name"]}},{name:"order",in:"query",description:"Sort direction for the `sort` column.",required:false,schema:{type:"string",enum:["asc","desc"]}}],responses:{200:{description:"Database summary",content:{"application/json":{schema:{type:"object",description:"Paginated summary of the Meshery server's embedded database.",additionalProperties:false,required:["page","pageSize","totalTables","recordCount","tables"],properties:{page:{type:"integer",description:"Zero-based page index of the returned table slice.",minimum:0},pageSize:{type:"integer",description:"Number of tables included in this page.",minimum:1},totalTables:{type:"integer",description:"Total number of tables in the database matching the search filter.",minimum:0},recordCount:{type:"integer",description:"Aggregate row count across the tables returned in this page.",minimum:0},tables:{type:"array",description:"Tables included in this page, with per-table row counts.",items:{type:"object",description:"Database table summary.",additionalProperties:false,required:["name","type","count"],properties:{name:{type:"string",description:"Name of the table.",maxLength:255},type:{type:"string",description:"SQLite object type (e.g. `table`).",maxLength:64},count:{type:"integer",description:"Number of rows currently in the table.",format:"int64",minimum:0}}}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error"}}}},"/api/system/database/reset":{delete:{"x-internal":["meshery"],tags:["System"],summary:"Reset the Meshery server's database",description:"Resets the Meshery server database. This is a destructive operation.",operationId:"resetSystemDatabase",responses:{200:{description:"Database reset",content:{"application/json":{schema:{type:"object",description:"Status message response.",additionalProperties:false,required:["message"],properties:{message:{type:"string",description:"Human-readable status message.",minLength:1,maxLength:1024}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Internal server error during reset (archive, drop, migrate, or reseed)."}}}},"/api/system/version":{get:{"x-internal":["cloud","meshery"],tags:["System"],summary:"Get the running Meshery server's version metadata",description:"Returns version metadata for the running Meshery service.",operationId:"getSystemVersion",security:[],responses:{200:{description:"Server version metadata",content:{"application/json":{schema:{type:"object",description:"Version metadata for a running Meshery service.",additionalProperties:false,properties:{version:{type:"string",description:"Meshery Cloud deployment version.",maxLength:128},build:{type:"string",description:"Build identifier (typically the git tag of the running binary).",maxLength:128},latest:{type:"string",description:"Latest available Meshery release tag fetched from GitHub.",maxLength:128},outdated:{type:"boolean",description:"True when the running build is older than the latest available release."},commitsha:{type:"string",description:"Git commit SHA of the running service. The wire field is `commitsha`.",maxLength:64},releaseChannel:{type:"string",description:"Release channel of the running binary (e.g. `stable`, `edge`).",maxLength:64}}}}}},500:{description:"Encoding error while serializing the version payload."}}}},"/api/system/sync":{get:{"x-internal":["meshery"],tags:["System"],summary:"Get initial session bootstrap data",description:"Returns session bootstrap data for the authenticated user.",operationId:"getSystemSync",responses:{200:{description:"Session sync payload",content:{"application/json":{schema:{type:"object",description:"Session bootstrap payload for the authenticated user.",additionalProperties:true,properties:{k8sConfig:{type:"array",description:"Kubernetes contexts currently tracked by the Meshery server.",items:{type:"object",description:"Kubernetes context tracked by Meshery.",additionalProperties:false,properties:{id:{type:"string",description:"Stable identifier for the Kubernetes context.","x-id-format":"external",minLength:32,maxLength:32,pattern:"^[0-9a-f]{32}$"},name:{type:"string",description:"Human-readable name of the Kubernetes context.",maxLength:255},clusterConfigured:{type:"boolean",description:"True when Meshery has a usable kubeconfig for this context."},server:{type:"string",description:"API server URL for the Kubernetes context.",maxLength:2048},clusterId:{description:"Kubernetes server ID associated with this context.",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"When the context was first registered with Meshery.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updatedAt:{description:"When the context was last updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}}}}},401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}},500:{description:"Marshal error while serializing the session sync payload."}}}}},components:{responses:{401:{description:"Expired JWT token used or insufficient privilege",content:{"text/plain":{schema:{type:"string"}}}}},securitySchemes:{jwt:{type:"http",scheme:"bearer",bearerFormat:"JWT"}},schemas:{SystemMessageResponse:{type:"object",description:"Status message response.",additionalProperties:false,required:["message"],properties:{message:{type:"string",description:"Human-readable status message.",minLength:1,maxLength:1024}}},SystemDatabaseTable:{type:"object",description:"Database table summary.",additionalProperties:false,required:["name","type","count"],properties:{name:{type:"string",description:"Name of the table.",maxLength:255},type:{type:"string",description:"SQLite object type (e.g. `table`).",maxLength:64},count:{type:"integer",description:"Number of rows currently in the table.",format:"int64",minimum:0}}},SystemDatabaseSummary:{type:"object",description:"Paginated summary of the Meshery server's embedded database.",additionalProperties:false,required:["page","pageSize","totalTables","recordCount","tables"],properties:{page:{type:"integer",description:"Zero-based page index of the returned table slice.",minimum:0},pageSize:{type:"integer",description:"Number of tables included in this page.",minimum:1},totalTables:{type:"integer",description:"Total number of tables in the database matching the search filter.",minimum:0},recordCount:{type:"integer",description:"Aggregate row count across the tables returned in this page.",minimum:0},tables:{type:"array",description:"Tables included in this page, with per-table row counts.",items:{type:"object",description:"Database table summary.",additionalProperties:false,required:["name","type","count"],properties:{name:{type:"string",description:"Name of the table.",maxLength:255},type:{type:"string",description:"SQLite object type (e.g. `table`).",maxLength:64},count:{type:"integer",description:"Number of rows currently in the table.",format:"int64",minimum:0}}}}}},SystemVersion:{type:"object",description:"Version metadata for a running Meshery service.",additionalProperties:false,properties:{version:{type:"string",description:"Meshery Cloud deployment version.",maxLength:128},build:{type:"string",description:"Build identifier (typically the git tag of the running binary).",maxLength:128},latest:{type:"string",description:"Latest available Meshery release tag fetched from GitHub.",maxLength:128},outdated:{type:"boolean",description:"True when the running build is older than the latest available release."},commitsha:{type:"string",description:"Git commit SHA of the running service. The wire field is `commitsha`.",maxLength:64},releaseChannel:{type:"string",description:"Release channel of the running binary (e.g. `stable`, `edge`).",maxLength:64}}},SystemSessionSyncK8sContext:{type:"object",description:"Kubernetes context tracked by Meshery.",additionalProperties:false,properties:{id:{type:"string",description:"Stable identifier for the Kubernetes context.","x-id-format":"external",minLength:32,maxLength:32,pattern:"^[0-9a-f]{32}$"},name:{type:"string",description:"Human-readable name of the Kubernetes context.",maxLength:255},clusterConfigured:{type:"boolean",description:"True when Meshery has a usable kubeconfig for this context."},server:{type:"string",description:"API server URL for the Kubernetes context.",maxLength:2048},clusterId:{description:"Kubernetes server ID associated with this context.",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"When the context was first registered with Meshery.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updatedAt:{description:"When the context was last updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}},SystemSessionSync:{type:"object",description:"Session bootstrap payload for the authenticated user.",additionalProperties:true,properties:{k8sConfig:{type:"array",description:"Kubernetes contexts currently tracked by the Meshery server.",items:{type:"object",description:"Kubernetes context tracked by Meshery.",additionalProperties:false,properties:{id:{type:"string",description:"Stable identifier for the Kubernetes context.","x-id-format":"external",minLength:32,maxLength:32,pattern:"^[0-9a-f]{32}$"},name:{type:"string",description:"Human-readable name of the Kubernetes context.",maxLength:255},clusterConfigured:{type:"boolean",description:"True when Meshery has a usable kubeconfig for this context."},server:{type:"string",description:"API server URL for the Kubernetes context.",maxLength:2048},clusterId:{description:"Kubernetes server ID associated with this context.",type:"string",format:"uuid","x-go-type":"uuid.UUID","x-go-type-import":{path:"github.com/gofrs/uuid"}},createdAt:{description:"When the context was first registered with Meshery.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"CreatedAt","x-oapi-codegen-extra-tags":{db:"created_at",yaml:"created_at"},"x-go-type-skip-optional-pointer":true},updatedAt:{description:"When the context was last updated.","x-go-type":"time.Time",type:"string",format:"date-time","x-go-name":"UpdatedAt","x-oapi-codegen-extra-tags":{db:"updated_at",yaml:"updated_at"},"x-go-type-skip-optional-pointer":true}}}}}}}}},t=e;
|
|
2
|
+
module.exports=t;
|