@meshery/schemas 1.3.65 → 1.3.66
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 +7337 -4312
- package/dist/cloudApi.d.ts +7337 -4312
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1alpha1/core/Core.d.ts +16 -0
- package/dist/constructs/v1alpha1/core/CoreSchema.js +1 -1
- package/dist/constructs/v1alpha1/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta2/core/Core.d.ts +154 -0
- package/dist/constructs/v1beta2/core/CoreSchema.js +1 -1
- package/dist/constructs/v1beta2/core/CoreSchema.mjs +1 -1
- package/dist/constructs/v1beta3/connection/Connection.d.ts +71 -2
- package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +163 -23
- package/dist/constructs/v1beta3/design/DesignSchema.js +7 -7
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +7 -7
- package/dist/constructs/v1beta3/event/Event.d.ts +50 -2
- package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
- package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
- package/dist/constructs/v1beta3/github/Github.d.ts +1203 -0
- package/dist/constructs/v1beta3/github/Github.js +1 -0
- package/dist/constructs/v1beta3/github/Github.mjs +0 -0
- package/dist/constructs/v1beta3/github/GithubSchema.d.ts +2 -0
- package/dist/constructs/v1beta3/github/GithubSchema.js +12 -0
- package/dist/constructs/v1beta3/github/GithubSchema.mjs +12 -0
- package/dist/constructs/v1beta3/invitation/Invitation.d.ts +197 -7
- package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
- package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
- package/dist/constructs/v1beta3/token/Token.d.ts +300 -4
- package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
- package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
- package/dist/index.d.mts +16 -0
- package/dist/index.d.ts +16 -0
- package/package.json +1 -1
|
@@ -0,0 +1,1203 @@
|
|
|
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/integrations/github/status": {
|
|
8
|
+
parameters: {
|
|
9
|
+
query?: never;
|
|
10
|
+
header?: never;
|
|
11
|
+
path?: never;
|
|
12
|
+
cookie?: never;
|
|
13
|
+
};
|
|
14
|
+
/**
|
|
15
|
+
* Whether the caller's GitHub connection is usable
|
|
16
|
+
* @description Checks the caller's GitHub App connection. A connection is usable only when its installations were verified against the caller's own GitHub account and GitHub confirms the installation it opens on still exists. `403` (code `meshery_cloud-3381`) means the connection must be re-authorized (`startGithubAuthorization` with `flow=authorize`). When GitHub reports the installation the connection opens on removed, that installation is dropped and the connection re-points at its next verified installation, which is checked in turn: `200` when one remains. `404` means the caller has no GitHub connection, or no verified installation remains - in which case the connection is deleted. `502` means GitHub could not confirm either way; the connection is kept.
|
|
17
|
+
*/
|
|
18
|
+
get: operations["getGithubAppStatus"];
|
|
19
|
+
put?: never;
|
|
20
|
+
post?: never;
|
|
21
|
+
delete?: never;
|
|
22
|
+
options?: never;
|
|
23
|
+
head?: never;
|
|
24
|
+
patch?: never;
|
|
25
|
+
trace?: never;
|
|
26
|
+
};
|
|
27
|
+
"/api/integrations/github": {
|
|
28
|
+
parameters: {
|
|
29
|
+
query?: never;
|
|
30
|
+
header?: never;
|
|
31
|
+
path?: never;
|
|
32
|
+
cookie?: never;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* List the repositories one of the caller's installations can access
|
|
36
|
+
* @description Returns one page of the repositories a GitHub App installation can access. `id` must name one of the caller's verified GitHub App installations; any other id - another account's, or one that does not exist - is the same `403`, so the route does not reveal which installations exist. `502` means GitHub could not be reached or rejected the request.
|
|
37
|
+
*/
|
|
38
|
+
get: operations["getGithubInstallationRepositories"];
|
|
39
|
+
put?: never;
|
|
40
|
+
post?: never;
|
|
41
|
+
delete?: never;
|
|
42
|
+
options?: never;
|
|
43
|
+
head?: never;
|
|
44
|
+
patch?: never;
|
|
45
|
+
trace?: never;
|
|
46
|
+
};
|
|
47
|
+
"/api/integrations/github/scan": {
|
|
48
|
+
parameters: {
|
|
49
|
+
query?: never;
|
|
50
|
+
header?: never;
|
|
51
|
+
path?: never;
|
|
52
|
+
cookie?: never;
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* One page of a repository's file tree
|
|
56
|
+
* @description Returns one page of a repository's file tree, as nested tree items. The repository must be reachable through one of the caller's verified GitHub App installations; otherwise the request is refused with the same uniform `403` as `importGithubRepository`, which does not reveal where the App is installed. `206` answers a page of a tree that has further pages.
|
|
57
|
+
*/
|
|
58
|
+
get: operations["scanGithubRepository"];
|
|
59
|
+
put?: never;
|
|
60
|
+
post?: never;
|
|
61
|
+
delete?: never;
|
|
62
|
+
options?: never;
|
|
63
|
+
head?: never;
|
|
64
|
+
patch?: never;
|
|
65
|
+
trace?: never;
|
|
66
|
+
};
|
|
67
|
+
"/api/integrations/github/verify/{owner}/{repo}": {
|
|
68
|
+
parameters: {
|
|
69
|
+
query?: never;
|
|
70
|
+
header?: never;
|
|
71
|
+
path?: never;
|
|
72
|
+
cookie?: never;
|
|
73
|
+
};
|
|
74
|
+
get?: never;
|
|
75
|
+
put?: never;
|
|
76
|
+
/**
|
|
77
|
+
* Whether the Kanvas workflow is already present in a repository
|
|
78
|
+
* @description Reports whether the Kanvas workflow is already committed to a repository. The repository's installation is resolved and authorized by the server; the `id` query parameter is accepted for compatibility and is not consulted. A repository the caller cannot reach through one of their verified GitHub App installations is refused with the same uniform `403` as `importGithubRepository`. No request body.
|
|
79
|
+
*/
|
|
80
|
+
post: operations["verifyGithubRepositoryWorkflow"];
|
|
81
|
+
delete?: never;
|
|
82
|
+
options?: never;
|
|
83
|
+
head?: never;
|
|
84
|
+
patch?: never;
|
|
85
|
+
trace?: never;
|
|
86
|
+
};
|
|
87
|
+
"/api/integrations/github/install": {
|
|
88
|
+
parameters: {
|
|
89
|
+
query?: never;
|
|
90
|
+
header?: never;
|
|
91
|
+
path?: never;
|
|
92
|
+
cookie?: never;
|
|
93
|
+
};
|
|
94
|
+
get?: never;
|
|
95
|
+
put?: never;
|
|
96
|
+
/**
|
|
97
|
+
* Commit the Kanvas workflow into repositories
|
|
98
|
+
* @description Commits the Kanvas workflow into each requested repository. Every well-formed repository is authorized before anything is written: one repository the caller cannot reach through their verified GitHub App installations refuses the whole request with the uniform `403`, and nothing is committed anywhere. A malformed repository identifier is reported per repository (`code: 400`) and never reaches GitHub. The `id` query parameter is accepted for compatibility and is not consulted.
|
|
99
|
+
*/
|
|
100
|
+
post: operations["installGithubWorkflow"];
|
|
101
|
+
delete?: never;
|
|
102
|
+
options?: never;
|
|
103
|
+
head?: never;
|
|
104
|
+
patch?: never;
|
|
105
|
+
trace?: never;
|
|
106
|
+
};
|
|
107
|
+
"/api/integrations/github/authorize": {
|
|
108
|
+
parameters: {
|
|
109
|
+
query?: never;
|
|
110
|
+
header?: never;
|
|
111
|
+
path?: never;
|
|
112
|
+
cookie?: never;
|
|
113
|
+
};
|
|
114
|
+
/**
|
|
115
|
+
* Start a trip to GitHub (browser navigation)
|
|
116
|
+
* @description Browser navigation, not a data call. Issues a single-use state bound to the signed-in user (consumed once, five-minute lifetime) and redirects to GitHub carrying it: `flow=install` to the GitHub App's installation page (derived from the App's own `html_url`), `flow=authorize` to GitHub's user-authorization page for the App. The UI never links to GitHub directly. Failures redirect to `/connect/github/new/<userId>?githubError=<reason>`, as the callback does.
|
|
117
|
+
*/
|
|
118
|
+
get: operations["startGithubAuthorization"];
|
|
119
|
+
put?: never;
|
|
120
|
+
post?: never;
|
|
121
|
+
delete?: never;
|
|
122
|
+
options?: never;
|
|
123
|
+
head?: never;
|
|
124
|
+
patch?: never;
|
|
125
|
+
trace?: never;
|
|
126
|
+
};
|
|
127
|
+
"/api/integrations/github/callback": {
|
|
128
|
+
parameters: {
|
|
129
|
+
query?: never;
|
|
130
|
+
header?: never;
|
|
131
|
+
path?: never;
|
|
132
|
+
cookie?: never;
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* The GitHub App's callback (browser navigation)
|
|
136
|
+
* @description Browser navigation, not a data call. GitHub returns the browser here with the `state` issued by `startGithubAuthorization` and a one-time `code`. A missing, expired, reused or foreign `state` is refused before the code is exchanged or any connection is touched (`githubError=authorization-stale`). The server then exchanges the code for a user-to-server token, lists the installations of the App the authorizing GitHub account can access (GitHub's `GET /user/installations`) and stores exactly that set on the caller's GitHub connection - creating it, or updating it in place. An `installation_id` not in that set is never stored, and a result of zero installations never deletes or replaces an existing connection. Always answers a `302`: to `/connect/github/verify?githubLogin=true&id=<installation>[&setup_action=update]` on success, else to `/connect/github/new/<userId>?githubError=<reason>`, `reason` one of `authorization-failed`, `authorization-stale`, `authorization-unavailable`, `connection-failed`, `installation-not-verified`, `no-installations`. The `installation_id` and `setup_action` query parameter names are GitHub's and are kept as GitHub sends them.
|
|
137
|
+
*/
|
|
138
|
+
get: operations["githubAppCallback"];
|
|
139
|
+
put?: never;
|
|
140
|
+
post?: never;
|
|
141
|
+
delete?: never;
|
|
142
|
+
options?: never;
|
|
143
|
+
head?: never;
|
|
144
|
+
patch?: never;
|
|
145
|
+
trace?: never;
|
|
146
|
+
};
|
|
147
|
+
}
|
|
148
|
+
export type webhooks = Record<string, never>;
|
|
149
|
+
export interface components {
|
|
150
|
+
schemas: {
|
|
151
|
+
/** @description One page of GitHub's `GET /installation/repositories` answer, passed through as GitHub returns it (`total_count`, `repositories`). */
|
|
152
|
+
GithubInstallationRepositoryPage: {
|
|
153
|
+
[key: string]: unknown;
|
|
154
|
+
};
|
|
155
|
+
/** @description One page of a repository's file tree. */
|
|
156
|
+
GithubRepositoryTree: {
|
|
157
|
+
/**
|
|
158
|
+
* Format: uuid
|
|
159
|
+
* @description Identifier of the tree item, for the UI's tree view.
|
|
160
|
+
*/
|
|
161
|
+
id?: string;
|
|
162
|
+
/** @description Display name of the file or directory. */
|
|
163
|
+
label?: string;
|
|
164
|
+
/** @description Kind of the tree item, such as a file or a directory. */
|
|
165
|
+
type?: string;
|
|
166
|
+
/** @description GitHub's tree entry for the item, passed through as GitHub returns it. */
|
|
167
|
+
entry?: {
|
|
168
|
+
[key: string]: unknown;
|
|
169
|
+
};
|
|
170
|
+
/** @description The items under a directory, each shaped as a `GithubRepositoryTreeItem`. */
|
|
171
|
+
children?: {
|
|
172
|
+
[key: string]: unknown;
|
|
173
|
+
}[];
|
|
174
|
+
}[];
|
|
175
|
+
/** @description One file or directory of a repository's file tree, with its children. */
|
|
176
|
+
GithubRepositoryTreeItem: {
|
|
177
|
+
/**
|
|
178
|
+
* Format: uuid
|
|
179
|
+
* @description Identifier of the tree item, for the UI's tree view.
|
|
180
|
+
*/
|
|
181
|
+
id?: string;
|
|
182
|
+
/** @description Display name of the file or directory. */
|
|
183
|
+
label?: string;
|
|
184
|
+
/** @description Kind of the tree item, such as a file or a directory. */
|
|
185
|
+
type?: string;
|
|
186
|
+
/** @description GitHub's tree entry for the item, passed through as GitHub returns it. */
|
|
187
|
+
entry?: {
|
|
188
|
+
[key: string]: unknown;
|
|
189
|
+
};
|
|
190
|
+
/** @description The items under a directory, each shaped as a `GithubRepositoryTreeItem`. */
|
|
191
|
+
children?: {
|
|
192
|
+
[key: string]: unknown;
|
|
193
|
+
}[];
|
|
194
|
+
};
|
|
195
|
+
/** @description Whether the Kanvas workflow is already present in a repository. */
|
|
196
|
+
GithubWorkflowVerification: {
|
|
197
|
+
/**
|
|
198
|
+
* @description `ok` when no workflow is present; `error` when one is (`fileUrl` names it) or the check failed (`error` says why).
|
|
199
|
+
* @enum {string}
|
|
200
|
+
*/
|
|
201
|
+
status: "ok" | "error";
|
|
202
|
+
/**
|
|
203
|
+
* Format: uri
|
|
204
|
+
* @description URL of the workflow file already present.
|
|
205
|
+
*/
|
|
206
|
+
fileUrl?: string;
|
|
207
|
+
/** @description Why the repository cannot take the workflow. */
|
|
208
|
+
error?: string;
|
|
209
|
+
};
|
|
210
|
+
/** @description The repositories to commit the Kanvas workflow into. */
|
|
211
|
+
GithubWorkflowInstallPayload: {
|
|
212
|
+
/** @description Repositories as `<owner>/<repo>`. */
|
|
213
|
+
repositories: string[];
|
|
214
|
+
};
|
|
215
|
+
/** @description One single-key entry per requested repository, keyed by `<owner>/<repo>`. */
|
|
216
|
+
GithubWorkflowInstallResponse: {
|
|
217
|
+
[key: string]: {
|
|
218
|
+
/** @description HTTP-style status of the repository's outcome; `400` for a malformed repository identifier. */
|
|
219
|
+
code?: number;
|
|
220
|
+
/** @description The outcome, in words. */
|
|
221
|
+
description?: string;
|
|
222
|
+
};
|
|
223
|
+
}[];
|
|
224
|
+
/** @description The outcome of committing the workflow into one repository. */
|
|
225
|
+
GithubWorkflowInstallResult: {
|
|
226
|
+
/** @description HTTP-style status of the repository's outcome; `400` for a malformed repository identifier. */
|
|
227
|
+
code?: number;
|
|
228
|
+
/** @description The outcome, in words. */
|
|
229
|
+
description?: string;
|
|
230
|
+
};
|
|
231
|
+
/** @description Metadata of a `kind: github` connection, as Meshery Cloud writes it. `installations`, `installationId` and `installationsVerifiedAt` are server-written: a connection edit can neither set nor erase them (see `updateConnection`). */
|
|
232
|
+
GithubConnectionMetadata: {
|
|
233
|
+
/** @description The installation the connection wizard opens on; always one of `installations`. */
|
|
234
|
+
installationId?: string;
|
|
235
|
+
/** @description The verified installations - those GitHub listed for the owner's GitHub account at the last authorization. Absent on a connection that predates verification (which must be re-authorized); an empty set is never stored. */
|
|
236
|
+
installations?: {
|
|
237
|
+
/** @description GitHub App installation id. */
|
|
238
|
+
id: string;
|
|
239
|
+
/** @description Login of the account the App is installed on. */
|
|
240
|
+
account?: string;
|
|
241
|
+
/**
|
|
242
|
+
* @description Type of the account the App is installed on, as GitHub names it.
|
|
243
|
+
* @enum {string}
|
|
244
|
+
*/
|
|
245
|
+
accountType?: "User" | "Organization";
|
|
246
|
+
}[];
|
|
247
|
+
/**
|
|
248
|
+
* Format: date-time
|
|
249
|
+
* @description When `installations` was last verified with GitHub.
|
|
250
|
+
*/
|
|
251
|
+
installationsVerifiedAt?: string;
|
|
252
|
+
/** @description Per-repository snapshot path preferences. */
|
|
253
|
+
snapshotPaths?: {
|
|
254
|
+
[key: string]: string;
|
|
255
|
+
}[];
|
|
256
|
+
};
|
|
257
|
+
/** @description One verified GitHub App installation. */
|
|
258
|
+
GithubInstallation: {
|
|
259
|
+
/** @description GitHub App installation id. */
|
|
260
|
+
id: string;
|
|
261
|
+
/** @description Login of the account the App is installed on. */
|
|
262
|
+
account?: string;
|
|
263
|
+
/**
|
|
264
|
+
* @description Type of the account the App is installed on, as GitHub names it.
|
|
265
|
+
* @enum {string}
|
|
266
|
+
*/
|
|
267
|
+
accountType?: "User" | "Organization";
|
|
268
|
+
};
|
|
269
|
+
};
|
|
270
|
+
responses: {
|
|
271
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
272
|
+
401: {
|
|
273
|
+
headers: {
|
|
274
|
+
[name: string]: unknown;
|
|
275
|
+
};
|
|
276
|
+
content: {
|
|
277
|
+
"text/plain": string;
|
|
278
|
+
};
|
|
279
|
+
};
|
|
280
|
+
/** @description Invalid request body or request param */
|
|
281
|
+
MeshkitError400: {
|
|
282
|
+
headers: {
|
|
283
|
+
[name: string]: unknown;
|
|
284
|
+
};
|
|
285
|
+
content: {
|
|
286
|
+
"application/json": {
|
|
287
|
+
/** @description The sentence the caller is shown. */
|
|
288
|
+
error: string;
|
|
289
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
290
|
+
code?: string;
|
|
291
|
+
/**
|
|
292
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
293
|
+
* @enum {string}
|
|
294
|
+
*/
|
|
295
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
296
|
+
/** @description MeshKit's probable causes of the error. */
|
|
297
|
+
probableCause?: string[];
|
|
298
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
299
|
+
suggestedRemediation?: string[];
|
|
300
|
+
};
|
|
301
|
+
};
|
|
302
|
+
};
|
|
303
|
+
/** @description Forbidden */
|
|
304
|
+
MeshkitError403: {
|
|
305
|
+
headers: {
|
|
306
|
+
[name: string]: unknown;
|
|
307
|
+
};
|
|
308
|
+
content: {
|
|
309
|
+
"application/json": {
|
|
310
|
+
/** @description The sentence the caller is shown. */
|
|
311
|
+
error: string;
|
|
312
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
313
|
+
code?: string;
|
|
314
|
+
/**
|
|
315
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
316
|
+
* @enum {string}
|
|
317
|
+
*/
|
|
318
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
319
|
+
/** @description MeshKit's probable causes of the error. */
|
|
320
|
+
probableCause?: string[];
|
|
321
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
322
|
+
suggestedRemediation?: string[];
|
|
323
|
+
};
|
|
324
|
+
};
|
|
325
|
+
};
|
|
326
|
+
/** @description Result not found */
|
|
327
|
+
MeshkitError404: {
|
|
328
|
+
headers: {
|
|
329
|
+
[name: string]: unknown;
|
|
330
|
+
};
|
|
331
|
+
content: {
|
|
332
|
+
"application/json": {
|
|
333
|
+
/** @description The sentence the caller is shown. */
|
|
334
|
+
error: string;
|
|
335
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
336
|
+
code?: string;
|
|
337
|
+
/**
|
|
338
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
339
|
+
* @enum {string}
|
|
340
|
+
*/
|
|
341
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
342
|
+
/** @description MeshKit's probable causes of the error. */
|
|
343
|
+
probableCause?: string[];
|
|
344
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
345
|
+
suggestedRemediation?: string[];
|
|
346
|
+
};
|
|
347
|
+
};
|
|
348
|
+
};
|
|
349
|
+
/** @description Internal server error */
|
|
350
|
+
MeshkitError500: {
|
|
351
|
+
headers: {
|
|
352
|
+
[name: string]: unknown;
|
|
353
|
+
};
|
|
354
|
+
content: {
|
|
355
|
+
"application/json": {
|
|
356
|
+
/** @description The sentence the caller is shown. */
|
|
357
|
+
error: string;
|
|
358
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
359
|
+
code?: string;
|
|
360
|
+
/**
|
|
361
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
362
|
+
* @enum {string}
|
|
363
|
+
*/
|
|
364
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
365
|
+
/** @description MeshKit's probable causes of the error. */
|
|
366
|
+
probableCause?: string[];
|
|
367
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
368
|
+
suggestedRemediation?: string[];
|
|
369
|
+
};
|
|
370
|
+
};
|
|
371
|
+
};
|
|
372
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
373
|
+
MeshkitError502: {
|
|
374
|
+
headers: {
|
|
375
|
+
[name: string]: unknown;
|
|
376
|
+
};
|
|
377
|
+
content: {
|
|
378
|
+
"application/json": {
|
|
379
|
+
/** @description The sentence the caller is shown. */
|
|
380
|
+
error: string;
|
|
381
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
382
|
+
code?: string;
|
|
383
|
+
/**
|
|
384
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
385
|
+
* @enum {string}
|
|
386
|
+
*/
|
|
387
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
388
|
+
/** @description MeshKit's probable causes of the error. */
|
|
389
|
+
probableCause?: string[];
|
|
390
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
391
|
+
suggestedRemediation?: string[];
|
|
392
|
+
};
|
|
393
|
+
};
|
|
394
|
+
};
|
|
395
|
+
};
|
|
396
|
+
parameters: {
|
|
397
|
+
/** @description Get responses by page */
|
|
398
|
+
page: number;
|
|
399
|
+
/** @description Number of items per page. */
|
|
400
|
+
pageSize: number;
|
|
401
|
+
/** @description GitHub App installation id; must be one of the caller's verified installations. */
|
|
402
|
+
installationIdQuery: string;
|
|
403
|
+
/**
|
|
404
|
+
* @deprecated
|
|
405
|
+
* @description Ignored. Accepted for compatibility; the server resolves the installation itself.
|
|
406
|
+
*/
|
|
407
|
+
ignoredInstallationId: string;
|
|
408
|
+
/** @description Repository as `<owner>/<repo>`. */
|
|
409
|
+
repositoryName: string;
|
|
410
|
+
/** @description Login of the account that owns the repository. */
|
|
411
|
+
owner: string;
|
|
412
|
+
/** @description Repository name, without its owner. */
|
|
413
|
+
repo: string;
|
|
414
|
+
/** @description `install` sends the browser to the GitHub App's installation page; `authorize` sends it to GitHub's user-authorization page for the App. */
|
|
415
|
+
flow: "install" | "authorize";
|
|
416
|
+
/** @description The single-use state `startGithubAuthorization` issued. */
|
|
417
|
+
state: string;
|
|
418
|
+
/** @description GitHub's one-time authorization code. */
|
|
419
|
+
code: string;
|
|
420
|
+
/** @description The installation GitHub names on return (GitHub's parameter name). It is stored only when it is one of the installations GitHub lists for the authorizing account. */
|
|
421
|
+
githubInstallationId: string;
|
|
422
|
+
/** @description GitHub's setup action (GitHub's parameter name). */
|
|
423
|
+
githubSetupAction: "install" | "update" | "request";
|
|
424
|
+
};
|
|
425
|
+
requestBodies: never;
|
|
426
|
+
headers: never;
|
|
427
|
+
pathItems: never;
|
|
428
|
+
}
|
|
429
|
+
export type $defs = Record<string, never>;
|
|
430
|
+
export interface operations {
|
|
431
|
+
getGithubAppStatus: {
|
|
432
|
+
parameters: {
|
|
433
|
+
query?: never;
|
|
434
|
+
header?: never;
|
|
435
|
+
path?: never;
|
|
436
|
+
cookie?: never;
|
|
437
|
+
};
|
|
438
|
+
requestBody?: never;
|
|
439
|
+
responses: {
|
|
440
|
+
/** @description The connection is verified and its installation exists. No body. */
|
|
441
|
+
200: {
|
|
442
|
+
headers: {
|
|
443
|
+
[name: string]: unknown;
|
|
444
|
+
};
|
|
445
|
+
content?: never;
|
|
446
|
+
};
|
|
447
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
448
|
+
401: {
|
|
449
|
+
headers: {
|
|
450
|
+
[name: string]: unknown;
|
|
451
|
+
};
|
|
452
|
+
content: {
|
|
453
|
+
"text/plain": string;
|
|
454
|
+
};
|
|
455
|
+
};
|
|
456
|
+
/** @description Forbidden */
|
|
457
|
+
403: {
|
|
458
|
+
headers: {
|
|
459
|
+
[name: string]: unknown;
|
|
460
|
+
};
|
|
461
|
+
content: {
|
|
462
|
+
"application/json": {
|
|
463
|
+
/** @description The sentence the caller is shown. */
|
|
464
|
+
error: string;
|
|
465
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
466
|
+
code?: string;
|
|
467
|
+
/**
|
|
468
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
469
|
+
* @enum {string}
|
|
470
|
+
*/
|
|
471
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
472
|
+
/** @description MeshKit's probable causes of the error. */
|
|
473
|
+
probableCause?: string[];
|
|
474
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
475
|
+
suggestedRemediation?: string[];
|
|
476
|
+
};
|
|
477
|
+
};
|
|
478
|
+
};
|
|
479
|
+
/** @description Result not found */
|
|
480
|
+
404: {
|
|
481
|
+
headers: {
|
|
482
|
+
[name: string]: unknown;
|
|
483
|
+
};
|
|
484
|
+
content: {
|
|
485
|
+
"application/json": {
|
|
486
|
+
/** @description The sentence the caller is shown. */
|
|
487
|
+
error: string;
|
|
488
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
489
|
+
code?: string;
|
|
490
|
+
/**
|
|
491
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
492
|
+
* @enum {string}
|
|
493
|
+
*/
|
|
494
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
495
|
+
/** @description MeshKit's probable causes of the error. */
|
|
496
|
+
probableCause?: string[];
|
|
497
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
498
|
+
suggestedRemediation?: string[];
|
|
499
|
+
};
|
|
500
|
+
};
|
|
501
|
+
};
|
|
502
|
+
/** @description Internal server error */
|
|
503
|
+
500: {
|
|
504
|
+
headers: {
|
|
505
|
+
[name: string]: unknown;
|
|
506
|
+
};
|
|
507
|
+
content: {
|
|
508
|
+
"application/json": {
|
|
509
|
+
/** @description The sentence the caller is shown. */
|
|
510
|
+
error: string;
|
|
511
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
512
|
+
code?: string;
|
|
513
|
+
/**
|
|
514
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
515
|
+
* @enum {string}
|
|
516
|
+
*/
|
|
517
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
518
|
+
/** @description MeshKit's probable causes of the error. */
|
|
519
|
+
probableCause?: string[];
|
|
520
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
521
|
+
suggestedRemediation?: string[];
|
|
522
|
+
};
|
|
523
|
+
};
|
|
524
|
+
};
|
|
525
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
526
|
+
502: {
|
|
527
|
+
headers: {
|
|
528
|
+
[name: string]: unknown;
|
|
529
|
+
};
|
|
530
|
+
content: {
|
|
531
|
+
"application/json": {
|
|
532
|
+
/** @description The sentence the caller is shown. */
|
|
533
|
+
error: string;
|
|
534
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
535
|
+
code?: string;
|
|
536
|
+
/**
|
|
537
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
538
|
+
* @enum {string}
|
|
539
|
+
*/
|
|
540
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
541
|
+
/** @description MeshKit's probable causes of the error. */
|
|
542
|
+
probableCause?: string[];
|
|
543
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
544
|
+
suggestedRemediation?: string[];
|
|
545
|
+
};
|
|
546
|
+
};
|
|
547
|
+
};
|
|
548
|
+
};
|
|
549
|
+
};
|
|
550
|
+
getGithubInstallationRepositories: {
|
|
551
|
+
parameters: {
|
|
552
|
+
query: {
|
|
553
|
+
/** @description GitHub App installation id; must be one of the caller's verified installations. */
|
|
554
|
+
id: string;
|
|
555
|
+
/** @description Get responses by page */
|
|
556
|
+
page?: number;
|
|
557
|
+
};
|
|
558
|
+
header?: never;
|
|
559
|
+
path?: never;
|
|
560
|
+
cookie?: never;
|
|
561
|
+
};
|
|
562
|
+
requestBody?: never;
|
|
563
|
+
responses: {
|
|
564
|
+
/** @description One page of the installation's repositories. */
|
|
565
|
+
200: {
|
|
566
|
+
headers: {
|
|
567
|
+
[name: string]: unknown;
|
|
568
|
+
};
|
|
569
|
+
content: {
|
|
570
|
+
"application/json": {
|
|
571
|
+
[key: string]: unknown;
|
|
572
|
+
};
|
|
573
|
+
};
|
|
574
|
+
};
|
|
575
|
+
/** @description Invalid request body or request param */
|
|
576
|
+
400: {
|
|
577
|
+
headers: {
|
|
578
|
+
[name: string]: unknown;
|
|
579
|
+
};
|
|
580
|
+
content: {
|
|
581
|
+
"application/json": {
|
|
582
|
+
/** @description The sentence the caller is shown. */
|
|
583
|
+
error: string;
|
|
584
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
585
|
+
code?: string;
|
|
586
|
+
/**
|
|
587
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
588
|
+
* @enum {string}
|
|
589
|
+
*/
|
|
590
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
591
|
+
/** @description MeshKit's probable causes of the error. */
|
|
592
|
+
probableCause?: string[];
|
|
593
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
594
|
+
suggestedRemediation?: string[];
|
|
595
|
+
};
|
|
596
|
+
};
|
|
597
|
+
};
|
|
598
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
599
|
+
401: {
|
|
600
|
+
headers: {
|
|
601
|
+
[name: string]: unknown;
|
|
602
|
+
};
|
|
603
|
+
content: {
|
|
604
|
+
"text/plain": string;
|
|
605
|
+
};
|
|
606
|
+
};
|
|
607
|
+
/** @description Forbidden */
|
|
608
|
+
403: {
|
|
609
|
+
headers: {
|
|
610
|
+
[name: string]: unknown;
|
|
611
|
+
};
|
|
612
|
+
content: {
|
|
613
|
+
"application/json": {
|
|
614
|
+
/** @description The sentence the caller is shown. */
|
|
615
|
+
error: string;
|
|
616
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
617
|
+
code?: string;
|
|
618
|
+
/**
|
|
619
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
620
|
+
* @enum {string}
|
|
621
|
+
*/
|
|
622
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
623
|
+
/** @description MeshKit's probable causes of the error. */
|
|
624
|
+
probableCause?: string[];
|
|
625
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
626
|
+
suggestedRemediation?: string[];
|
|
627
|
+
};
|
|
628
|
+
};
|
|
629
|
+
};
|
|
630
|
+
/** @description Internal server error */
|
|
631
|
+
500: {
|
|
632
|
+
headers: {
|
|
633
|
+
[name: string]: unknown;
|
|
634
|
+
};
|
|
635
|
+
content: {
|
|
636
|
+
"application/json": {
|
|
637
|
+
/** @description The sentence the caller is shown. */
|
|
638
|
+
error: string;
|
|
639
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
640
|
+
code?: string;
|
|
641
|
+
/**
|
|
642
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
643
|
+
* @enum {string}
|
|
644
|
+
*/
|
|
645
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
646
|
+
/** @description MeshKit's probable causes of the error. */
|
|
647
|
+
probableCause?: string[];
|
|
648
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
649
|
+
suggestedRemediation?: string[];
|
|
650
|
+
};
|
|
651
|
+
};
|
|
652
|
+
};
|
|
653
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
654
|
+
502: {
|
|
655
|
+
headers: {
|
|
656
|
+
[name: string]: unknown;
|
|
657
|
+
};
|
|
658
|
+
content: {
|
|
659
|
+
"application/json": {
|
|
660
|
+
/** @description The sentence the caller is shown. */
|
|
661
|
+
error: string;
|
|
662
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
663
|
+
code?: string;
|
|
664
|
+
/**
|
|
665
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
666
|
+
* @enum {string}
|
|
667
|
+
*/
|
|
668
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
669
|
+
/** @description MeshKit's probable causes of the error. */
|
|
670
|
+
probableCause?: string[];
|
|
671
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
672
|
+
suggestedRemediation?: string[];
|
|
673
|
+
};
|
|
674
|
+
};
|
|
675
|
+
};
|
|
676
|
+
};
|
|
677
|
+
};
|
|
678
|
+
scanGithubRepository: {
|
|
679
|
+
parameters: {
|
|
680
|
+
query: {
|
|
681
|
+
/** @description Repository as `<owner>/<repo>`. */
|
|
682
|
+
name: string;
|
|
683
|
+
/** @description Get responses by page */
|
|
684
|
+
page?: number;
|
|
685
|
+
/** @description Number of items per page. */
|
|
686
|
+
pageSize?: number;
|
|
687
|
+
};
|
|
688
|
+
header?: never;
|
|
689
|
+
path?: never;
|
|
690
|
+
cookie?: never;
|
|
691
|
+
};
|
|
692
|
+
requestBody?: never;
|
|
693
|
+
responses: {
|
|
694
|
+
/** @description Tree page. */
|
|
695
|
+
200: {
|
|
696
|
+
headers: {
|
|
697
|
+
[name: string]: unknown;
|
|
698
|
+
};
|
|
699
|
+
content: {
|
|
700
|
+
"application/json": {
|
|
701
|
+
/**
|
|
702
|
+
* Format: uuid
|
|
703
|
+
* @description Identifier of the tree item, for the UI's tree view.
|
|
704
|
+
*/
|
|
705
|
+
id?: string;
|
|
706
|
+
/** @description Display name of the file or directory. */
|
|
707
|
+
label?: string;
|
|
708
|
+
/** @description Kind of the tree item, such as a file or a directory. */
|
|
709
|
+
type?: string;
|
|
710
|
+
/** @description GitHub's tree entry for the item, passed through as GitHub returns it. */
|
|
711
|
+
entry?: {
|
|
712
|
+
[key: string]: unknown;
|
|
713
|
+
};
|
|
714
|
+
/** @description The items under a directory, each shaped as a `GithubRepositoryTreeItem`. */
|
|
715
|
+
children?: {
|
|
716
|
+
[key: string]: unknown;
|
|
717
|
+
}[];
|
|
718
|
+
}[];
|
|
719
|
+
};
|
|
720
|
+
};
|
|
721
|
+
/** @description Tree page of a tree that has further pages. */
|
|
722
|
+
206: {
|
|
723
|
+
headers: {
|
|
724
|
+
[name: string]: unknown;
|
|
725
|
+
};
|
|
726
|
+
content: {
|
|
727
|
+
"application/json": {
|
|
728
|
+
/**
|
|
729
|
+
* Format: uuid
|
|
730
|
+
* @description Identifier of the tree item, for the UI's tree view.
|
|
731
|
+
*/
|
|
732
|
+
id?: string;
|
|
733
|
+
/** @description Display name of the file or directory. */
|
|
734
|
+
label?: string;
|
|
735
|
+
/** @description Kind of the tree item, such as a file or a directory. */
|
|
736
|
+
type?: string;
|
|
737
|
+
/** @description GitHub's tree entry for the item, passed through as GitHub returns it. */
|
|
738
|
+
entry?: {
|
|
739
|
+
[key: string]: unknown;
|
|
740
|
+
};
|
|
741
|
+
/** @description The items under a directory, each shaped as a `GithubRepositoryTreeItem`. */
|
|
742
|
+
children?: {
|
|
743
|
+
[key: string]: unknown;
|
|
744
|
+
}[];
|
|
745
|
+
}[];
|
|
746
|
+
};
|
|
747
|
+
};
|
|
748
|
+
/** @description Invalid request body or request param */
|
|
749
|
+
400: {
|
|
750
|
+
headers: {
|
|
751
|
+
[name: string]: unknown;
|
|
752
|
+
};
|
|
753
|
+
content: {
|
|
754
|
+
"application/json": {
|
|
755
|
+
/** @description The sentence the caller is shown. */
|
|
756
|
+
error: string;
|
|
757
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
758
|
+
code?: string;
|
|
759
|
+
/**
|
|
760
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
761
|
+
* @enum {string}
|
|
762
|
+
*/
|
|
763
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
764
|
+
/** @description MeshKit's probable causes of the error. */
|
|
765
|
+
probableCause?: string[];
|
|
766
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
767
|
+
suggestedRemediation?: string[];
|
|
768
|
+
};
|
|
769
|
+
};
|
|
770
|
+
};
|
|
771
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
772
|
+
401: {
|
|
773
|
+
headers: {
|
|
774
|
+
[name: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
content: {
|
|
777
|
+
"text/plain": string;
|
|
778
|
+
};
|
|
779
|
+
};
|
|
780
|
+
/** @description Forbidden */
|
|
781
|
+
403: {
|
|
782
|
+
headers: {
|
|
783
|
+
[name: string]: unknown;
|
|
784
|
+
};
|
|
785
|
+
content: {
|
|
786
|
+
"application/json": {
|
|
787
|
+
/** @description The sentence the caller is shown. */
|
|
788
|
+
error: string;
|
|
789
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
790
|
+
code?: string;
|
|
791
|
+
/**
|
|
792
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
793
|
+
* @enum {string}
|
|
794
|
+
*/
|
|
795
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
796
|
+
/** @description MeshKit's probable causes of the error. */
|
|
797
|
+
probableCause?: string[];
|
|
798
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
799
|
+
suggestedRemediation?: string[];
|
|
800
|
+
};
|
|
801
|
+
};
|
|
802
|
+
};
|
|
803
|
+
/** @description Internal server error */
|
|
804
|
+
500: {
|
|
805
|
+
headers: {
|
|
806
|
+
[name: string]: unknown;
|
|
807
|
+
};
|
|
808
|
+
content: {
|
|
809
|
+
"application/json": {
|
|
810
|
+
/** @description The sentence the caller is shown. */
|
|
811
|
+
error: string;
|
|
812
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
813
|
+
code?: string;
|
|
814
|
+
/**
|
|
815
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
816
|
+
* @enum {string}
|
|
817
|
+
*/
|
|
818
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
819
|
+
/** @description MeshKit's probable causes of the error. */
|
|
820
|
+
probableCause?: string[];
|
|
821
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
822
|
+
suggestedRemediation?: string[];
|
|
823
|
+
};
|
|
824
|
+
};
|
|
825
|
+
};
|
|
826
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
827
|
+
502: {
|
|
828
|
+
headers: {
|
|
829
|
+
[name: string]: unknown;
|
|
830
|
+
};
|
|
831
|
+
content: {
|
|
832
|
+
"application/json": {
|
|
833
|
+
/** @description The sentence the caller is shown. */
|
|
834
|
+
error: string;
|
|
835
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
836
|
+
code?: string;
|
|
837
|
+
/**
|
|
838
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
839
|
+
* @enum {string}
|
|
840
|
+
*/
|
|
841
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
842
|
+
/** @description MeshKit's probable causes of the error. */
|
|
843
|
+
probableCause?: string[];
|
|
844
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
845
|
+
suggestedRemediation?: string[];
|
|
846
|
+
};
|
|
847
|
+
};
|
|
848
|
+
};
|
|
849
|
+
};
|
|
850
|
+
};
|
|
851
|
+
verifyGithubRepositoryWorkflow: {
|
|
852
|
+
parameters: {
|
|
853
|
+
query?: {
|
|
854
|
+
/**
|
|
855
|
+
* @deprecated
|
|
856
|
+
* @description Ignored. Accepted for compatibility; the server resolves the installation itself.
|
|
857
|
+
*/
|
|
858
|
+
id?: string;
|
|
859
|
+
};
|
|
860
|
+
header?: never;
|
|
861
|
+
path: {
|
|
862
|
+
/** @description Login of the account that owns the repository. */
|
|
863
|
+
owner: string;
|
|
864
|
+
/** @description Repository name, without its owner. */
|
|
865
|
+
repo: string;
|
|
866
|
+
};
|
|
867
|
+
cookie?: never;
|
|
868
|
+
};
|
|
869
|
+
requestBody?: never;
|
|
870
|
+
responses: {
|
|
871
|
+
/** @description Workflow presence. */
|
|
872
|
+
200: {
|
|
873
|
+
headers: {
|
|
874
|
+
[name: string]: unknown;
|
|
875
|
+
};
|
|
876
|
+
content: {
|
|
877
|
+
"application/json": {
|
|
878
|
+
/**
|
|
879
|
+
* @description `ok` when no workflow is present; `error` when one is (`fileUrl` names it) or the check failed (`error` says why).
|
|
880
|
+
* @enum {string}
|
|
881
|
+
*/
|
|
882
|
+
status: "ok" | "error";
|
|
883
|
+
/**
|
|
884
|
+
* Format: uri
|
|
885
|
+
* @description URL of the workflow file already present.
|
|
886
|
+
*/
|
|
887
|
+
fileUrl?: string;
|
|
888
|
+
/** @description Why the repository cannot take the workflow. */
|
|
889
|
+
error?: string;
|
|
890
|
+
};
|
|
891
|
+
};
|
|
892
|
+
};
|
|
893
|
+
/** @description Invalid request body or request param */
|
|
894
|
+
400: {
|
|
895
|
+
headers: {
|
|
896
|
+
[name: string]: unknown;
|
|
897
|
+
};
|
|
898
|
+
content: {
|
|
899
|
+
"application/json": {
|
|
900
|
+
/** @description The sentence the caller is shown. */
|
|
901
|
+
error: string;
|
|
902
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
903
|
+
code?: string;
|
|
904
|
+
/**
|
|
905
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
906
|
+
* @enum {string}
|
|
907
|
+
*/
|
|
908
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
909
|
+
/** @description MeshKit's probable causes of the error. */
|
|
910
|
+
probableCause?: string[];
|
|
911
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
912
|
+
suggestedRemediation?: string[];
|
|
913
|
+
};
|
|
914
|
+
};
|
|
915
|
+
};
|
|
916
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
917
|
+
401: {
|
|
918
|
+
headers: {
|
|
919
|
+
[name: string]: unknown;
|
|
920
|
+
};
|
|
921
|
+
content: {
|
|
922
|
+
"text/plain": string;
|
|
923
|
+
};
|
|
924
|
+
};
|
|
925
|
+
/** @description Forbidden */
|
|
926
|
+
403: {
|
|
927
|
+
headers: {
|
|
928
|
+
[name: string]: unknown;
|
|
929
|
+
};
|
|
930
|
+
content: {
|
|
931
|
+
"application/json": {
|
|
932
|
+
/** @description The sentence the caller is shown. */
|
|
933
|
+
error: string;
|
|
934
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
935
|
+
code?: string;
|
|
936
|
+
/**
|
|
937
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
938
|
+
* @enum {string}
|
|
939
|
+
*/
|
|
940
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
941
|
+
/** @description MeshKit's probable causes of the error. */
|
|
942
|
+
probableCause?: string[];
|
|
943
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
944
|
+
suggestedRemediation?: string[];
|
|
945
|
+
};
|
|
946
|
+
};
|
|
947
|
+
};
|
|
948
|
+
/** @description Internal server error */
|
|
949
|
+
500: {
|
|
950
|
+
headers: {
|
|
951
|
+
[name: string]: unknown;
|
|
952
|
+
};
|
|
953
|
+
content: {
|
|
954
|
+
"application/json": {
|
|
955
|
+
/** @description The sentence the caller is shown. */
|
|
956
|
+
error: string;
|
|
957
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
958
|
+
code?: string;
|
|
959
|
+
/**
|
|
960
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
961
|
+
* @enum {string}
|
|
962
|
+
*/
|
|
963
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
964
|
+
/** @description MeshKit's probable causes of the error. */
|
|
965
|
+
probableCause?: string[];
|
|
966
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
967
|
+
suggestedRemediation?: string[];
|
|
968
|
+
};
|
|
969
|
+
};
|
|
970
|
+
};
|
|
971
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
972
|
+
502: {
|
|
973
|
+
headers: {
|
|
974
|
+
[name: string]: unknown;
|
|
975
|
+
};
|
|
976
|
+
content: {
|
|
977
|
+
"application/json": {
|
|
978
|
+
/** @description The sentence the caller is shown. */
|
|
979
|
+
error: string;
|
|
980
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
981
|
+
code?: string;
|
|
982
|
+
/**
|
|
983
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
984
|
+
* @enum {string}
|
|
985
|
+
*/
|
|
986
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
987
|
+
/** @description MeshKit's probable causes of the error. */
|
|
988
|
+
probableCause?: string[];
|
|
989
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
990
|
+
suggestedRemediation?: string[];
|
|
991
|
+
};
|
|
992
|
+
};
|
|
993
|
+
};
|
|
994
|
+
};
|
|
995
|
+
};
|
|
996
|
+
installGithubWorkflow: {
|
|
997
|
+
parameters: {
|
|
998
|
+
query?: {
|
|
999
|
+
/**
|
|
1000
|
+
* @deprecated
|
|
1001
|
+
* @description Ignored. Accepted for compatibility; the server resolves the installation itself.
|
|
1002
|
+
*/
|
|
1003
|
+
id?: string;
|
|
1004
|
+
};
|
|
1005
|
+
header?: never;
|
|
1006
|
+
path?: never;
|
|
1007
|
+
cookie?: never;
|
|
1008
|
+
};
|
|
1009
|
+
requestBody: {
|
|
1010
|
+
content: {
|
|
1011
|
+
"application/json": {
|
|
1012
|
+
/** @description Repositories as `<owner>/<repo>`. */
|
|
1013
|
+
repositories: string[];
|
|
1014
|
+
};
|
|
1015
|
+
};
|
|
1016
|
+
};
|
|
1017
|
+
responses: {
|
|
1018
|
+
/** @description One entry per requested repository. */
|
|
1019
|
+
200: {
|
|
1020
|
+
headers: {
|
|
1021
|
+
[name: string]: unknown;
|
|
1022
|
+
};
|
|
1023
|
+
content: {
|
|
1024
|
+
"application/json": {
|
|
1025
|
+
[key: string]: {
|
|
1026
|
+
/** @description HTTP-style status of the repository's outcome; `400` for a malformed repository identifier. */
|
|
1027
|
+
code?: number;
|
|
1028
|
+
/** @description The outcome, in words. */
|
|
1029
|
+
description?: string;
|
|
1030
|
+
};
|
|
1031
|
+
}[];
|
|
1032
|
+
};
|
|
1033
|
+
};
|
|
1034
|
+
/** @description Invalid request body or request param */
|
|
1035
|
+
400: {
|
|
1036
|
+
headers: {
|
|
1037
|
+
[name: string]: unknown;
|
|
1038
|
+
};
|
|
1039
|
+
content: {
|
|
1040
|
+
"application/json": {
|
|
1041
|
+
/** @description The sentence the caller is shown. */
|
|
1042
|
+
error: string;
|
|
1043
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
1044
|
+
code?: string;
|
|
1045
|
+
/**
|
|
1046
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
1047
|
+
* @enum {string}
|
|
1048
|
+
*/
|
|
1049
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
1050
|
+
/** @description MeshKit's probable causes of the error. */
|
|
1051
|
+
probableCause?: string[];
|
|
1052
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
1053
|
+
suggestedRemediation?: string[];
|
|
1054
|
+
};
|
|
1055
|
+
};
|
|
1056
|
+
};
|
|
1057
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1058
|
+
401: {
|
|
1059
|
+
headers: {
|
|
1060
|
+
[name: string]: unknown;
|
|
1061
|
+
};
|
|
1062
|
+
content: {
|
|
1063
|
+
"text/plain": string;
|
|
1064
|
+
};
|
|
1065
|
+
};
|
|
1066
|
+
/** @description Forbidden */
|
|
1067
|
+
403: {
|
|
1068
|
+
headers: {
|
|
1069
|
+
[name: string]: unknown;
|
|
1070
|
+
};
|
|
1071
|
+
content: {
|
|
1072
|
+
"application/json": {
|
|
1073
|
+
/** @description The sentence the caller is shown. */
|
|
1074
|
+
error: string;
|
|
1075
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
1076
|
+
code?: string;
|
|
1077
|
+
/**
|
|
1078
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
1079
|
+
* @enum {string}
|
|
1080
|
+
*/
|
|
1081
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
1082
|
+
/** @description MeshKit's probable causes of the error. */
|
|
1083
|
+
probableCause?: string[];
|
|
1084
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
1085
|
+
suggestedRemediation?: string[];
|
|
1086
|
+
};
|
|
1087
|
+
};
|
|
1088
|
+
};
|
|
1089
|
+
/** @description Internal server error */
|
|
1090
|
+
500: {
|
|
1091
|
+
headers: {
|
|
1092
|
+
[name: string]: unknown;
|
|
1093
|
+
};
|
|
1094
|
+
content: {
|
|
1095
|
+
"application/json": {
|
|
1096
|
+
/** @description The sentence the caller is shown. */
|
|
1097
|
+
error: string;
|
|
1098
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
1099
|
+
code?: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
1102
|
+
* @enum {string}
|
|
1103
|
+
*/
|
|
1104
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
1105
|
+
/** @description MeshKit's probable causes of the error. */
|
|
1106
|
+
probableCause?: string[];
|
|
1107
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
1108
|
+
suggestedRemediation?: string[];
|
|
1109
|
+
};
|
|
1110
|
+
};
|
|
1111
|
+
};
|
|
1112
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
1113
|
+
502: {
|
|
1114
|
+
headers: {
|
|
1115
|
+
[name: string]: unknown;
|
|
1116
|
+
};
|
|
1117
|
+
content: {
|
|
1118
|
+
"application/json": {
|
|
1119
|
+
/** @description The sentence the caller is shown. */
|
|
1120
|
+
error: string;
|
|
1121
|
+
/** @description MeshKit error code, e.g. `meshery_cloud-3420`. Omitted for an error that is not a MeshKit error. */
|
|
1122
|
+
code?: string;
|
|
1123
|
+
/**
|
|
1124
|
+
* @description MeshKit severity name. Omitted when MeshKit reports none.
|
|
1125
|
+
* @enum {string}
|
|
1126
|
+
*/
|
|
1127
|
+
severity?: "emergency" | "alert" | "critical" | "fatal";
|
|
1128
|
+
/** @description MeshKit's probable causes of the error. */
|
|
1129
|
+
probableCause?: string[];
|
|
1130
|
+
/** @description MeshKit's suggested remediations for the error. */
|
|
1131
|
+
suggestedRemediation?: string[];
|
|
1132
|
+
};
|
|
1133
|
+
};
|
|
1134
|
+
};
|
|
1135
|
+
};
|
|
1136
|
+
};
|
|
1137
|
+
startGithubAuthorization: {
|
|
1138
|
+
parameters: {
|
|
1139
|
+
query: {
|
|
1140
|
+
/** @description `install` sends the browser to the GitHub App's installation page; `authorize` sends it to GitHub's user-authorization page for the App. */
|
|
1141
|
+
flow: "install" | "authorize";
|
|
1142
|
+
};
|
|
1143
|
+
header?: never;
|
|
1144
|
+
path?: never;
|
|
1145
|
+
cookie?: never;
|
|
1146
|
+
};
|
|
1147
|
+
requestBody?: never;
|
|
1148
|
+
responses: {
|
|
1149
|
+
/** @description Redirect to GitHub, or to the connection wizard with a reason. */
|
|
1150
|
+
302: {
|
|
1151
|
+
headers: {
|
|
1152
|
+
[name: string]: unknown;
|
|
1153
|
+
};
|
|
1154
|
+
content?: never;
|
|
1155
|
+
};
|
|
1156
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1157
|
+
401: {
|
|
1158
|
+
headers: {
|
|
1159
|
+
[name: string]: unknown;
|
|
1160
|
+
};
|
|
1161
|
+
content: {
|
|
1162
|
+
"text/plain": string;
|
|
1163
|
+
};
|
|
1164
|
+
};
|
|
1165
|
+
};
|
|
1166
|
+
};
|
|
1167
|
+
githubAppCallback: {
|
|
1168
|
+
parameters: {
|
|
1169
|
+
query: {
|
|
1170
|
+
/** @description The single-use state `startGithubAuthorization` issued. */
|
|
1171
|
+
state: string;
|
|
1172
|
+
/** @description GitHub's one-time authorization code. */
|
|
1173
|
+
code?: string;
|
|
1174
|
+
/** @description The installation GitHub names on return (GitHub's parameter name). It is stored only when it is one of the installations GitHub lists for the authorizing account. */
|
|
1175
|
+
installation_id?: string;
|
|
1176
|
+
/** @description GitHub's setup action (GitHub's parameter name). */
|
|
1177
|
+
setup_action?: "install" | "update" | "request";
|
|
1178
|
+
};
|
|
1179
|
+
header?: never;
|
|
1180
|
+
path?: never;
|
|
1181
|
+
cookie?: never;
|
|
1182
|
+
};
|
|
1183
|
+
requestBody?: never;
|
|
1184
|
+
responses: {
|
|
1185
|
+
/** @description Redirect to the connection wizard, as described. */
|
|
1186
|
+
302: {
|
|
1187
|
+
headers: {
|
|
1188
|
+
[name: string]: unknown;
|
|
1189
|
+
};
|
|
1190
|
+
content?: never;
|
|
1191
|
+
};
|
|
1192
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
1193
|
+
401: {
|
|
1194
|
+
headers: {
|
|
1195
|
+
[name: string]: unknown;
|
|
1196
|
+
};
|
|
1197
|
+
content: {
|
|
1198
|
+
"text/plain": string;
|
|
1199
|
+
};
|
|
1200
|
+
};
|
|
1201
|
+
};
|
|
1202
|
+
};
|
|
1203
|
+
}
|