@meshery/schemas 1.3.63 → 1.3.65
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 +5016 -4195
- package/dist/cloudApi.d.ts +5016 -4195
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta3/design/Design.d.ts +768 -112
- package/dist/constructs/v1beta3/design/DesignSchema.js +37 -13
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +37 -13
- package/dist/mesheryApi.d.mts +2 -1
- package/dist/mesheryApi.d.ts +2 -1
- package/package.json +1 -1
|
@@ -146,7 +146,7 @@ export interface paths {
|
|
|
146
146
|
put?: never;
|
|
147
147
|
/**
|
|
148
148
|
* Refresh design from its source
|
|
149
|
-
* @description Re-fetches the source file recorded in the design's `location` (`type: github`, `host: github.com/<owner>/<repo>`, `path`, optional `branch`; an empty branch means the repository's default branch), re-identifies it, and rewrites the design's content in place under the same design ID. A Meshery Design source replaces `patternFile`; any other source type (Helm Chart, Kubernetes Manifest, Docker Compose) replaces `sourceContent` and clears `patternFile`, so Meshery reconverts it the next time the design is opened - exactly the state a first import leaves. Only the design's owner may refresh it. No request body. Denials: `404` answers both "no such design" and "not the caller's design" with the same body by design, so the route is not an existence oracle; `403` means the
|
|
149
|
+
* @description Re-fetches the source file recorded in the design's `location` (`type: github`, `host: github.com/<owner>/<repo>`, `path`, optional `branch`; an empty branch means the repository's default branch), re-identifies it, and rewrites the design's content in place under the same design ID. A Meshery Design source replaces `patternFile`; any other source type (Helm Chart, Kubernetes Manifest, Docker Compose) replaces `sourceContent` and clears `patternFile`, so Meshery reconverts it the next time the design is opened - exactly the state a first import leaves. Only the design's owner may refresh it. No request body. Denials: `404` answers both "no such design" and "not the caller's design" with the same body by design, so the route is not an existence oracle; `403` means the caller has no GitHub App installation with access to the design's repository; `409` means the design has no refreshable source (`location.type` is not `github`, or `host`/`path` is missing) or its source path no longer resolves to an importable file; `502` means GitHub could not be reached or rejected the request. The server resolves the tracked ref to a commit, reads the file at that commit, and records it in `location.commitSha`.
|
|
150
150
|
*/
|
|
151
151
|
post: operations["refreshPatternFromSource"];
|
|
152
152
|
delete?: never;
|
|
@@ -155,6 +155,26 @@ export interface paths {
|
|
|
155
155
|
patch?: never;
|
|
156
156
|
trace?: never;
|
|
157
157
|
};
|
|
158
|
+
"/api/content/patterns/{designId}/source": {
|
|
159
|
+
parameters: {
|
|
160
|
+
query?: never;
|
|
161
|
+
header?: never;
|
|
162
|
+
path?: never;
|
|
163
|
+
cookie?: never;
|
|
164
|
+
};
|
|
165
|
+
get?: never;
|
|
166
|
+
put?: never;
|
|
167
|
+
post?: never;
|
|
168
|
+
delete?: never;
|
|
169
|
+
options?: never;
|
|
170
|
+
head?: never;
|
|
171
|
+
/**
|
|
172
|
+
* Remap a design's GitHub source
|
|
173
|
+
* @description Re-points the design's source binding - the GitHub file its `location` records and `refreshPatternFromSource` re-reads - at another repository, path or ref. The design's content is not changed: call `refreshPatternFromSource` afterwards to replace it from the new source. The server resolves `ref` to a commit and confirms that `path` names an importable file at that commit before it writes anything, so a binding that a refresh could not read is never stored. It writes `location` as `type: github`, `host`, `path` and `branch` (= `ref`). When the binding changes, `location.commitSha` is removed, because the stored content was not read from the new source; it is kept when the request names the binding the design already has. A design with no GitHub source (an upload or URL import) may be bound to one; it becomes refreshable. Only the design's owner may remap it. Denials: `404` answers "no such design", "not the caller's design" and "connectionId is not the caller's own live GitHub connection" with the same body, so the route is not an existence oracle; `403` means the caller has no GitHub App installation with access to the repository; `409` means `ref` does not resolve to a commit, or `path` does not name an importable file at it (missing, a directory, or not a supported format); `502` means GitHub could not be reached or rejected the request.
|
|
174
|
+
*/
|
|
175
|
+
patch: operations["updatePatternSource"];
|
|
176
|
+
trace?: never;
|
|
177
|
+
};
|
|
158
178
|
"/api/pattern/import": {
|
|
159
179
|
parameters: {
|
|
160
180
|
query?: never;
|
|
@@ -203,7 +223,7 @@ export interface paths {
|
|
|
203
223
|
put?: never;
|
|
204
224
|
/**
|
|
205
225
|
* Import files from a GitHub repository as designs
|
|
206
|
-
* @description Imports the selected files (a selected directory is walked recursively) from one repository reachable through the caller's GitHub App connection. Matching is idempotent: a file whose (owner, location.type, location.host, location.path, location.branch) already identifies one of the caller's designs is handled per `onExisting`. `connectionId` must name the caller's own live GitHub connection (404 otherwise). `403` means the
|
|
226
|
+
* @description Imports the selected files (a selected directory is walked recursively) from one repository reachable through the caller's GitHub App connection. Matching is idempotent: a file whose (owner, location.type, location.host, location.path, location.branch) already identifies one of the caller's designs is handled per `onExisting`. `connectionId` must name the caller's own live GitHub connection (404 otherwise). `403` means the caller has no GitHub App installation with access to the repository; `502` means GitHub could not be reached or rejected the request. Each imported or updated design records the commit its file was read at in `location.commitSha`.
|
|
207
227
|
*/
|
|
208
228
|
post: operations["importGithubRepository"];
|
|
209
229
|
delete?: never;
|
|
@@ -212,6 +232,26 @@ export interface paths {
|
|
|
212
232
|
patch?: never;
|
|
213
233
|
trace?: never;
|
|
214
234
|
};
|
|
235
|
+
"/api/integrations/github/branches/{connectionId}": {
|
|
236
|
+
parameters: {
|
|
237
|
+
query?: never;
|
|
238
|
+
header?: never;
|
|
239
|
+
path?: never;
|
|
240
|
+
cookie?: never;
|
|
241
|
+
};
|
|
242
|
+
/**
|
|
243
|
+
* List a repository's branches
|
|
244
|
+
* @description Lists the branches of one repository reachable through the caller's GitHub App connection, with the repository's default branch, so a client can offer the refs a design's source can track. Branch order is GitHub's. `connectionId` must name the caller's own live GitHub connection (404 otherwise, with the same body as "no such connection"). `403` means the caller has no GitHub App installation with access to the repository; `502` means GitHub could not be reached or rejected the request.
|
|
245
|
+
*/
|
|
246
|
+
get: operations["getGithubRepositoryBranches"];
|
|
247
|
+
put?: never;
|
|
248
|
+
post?: never;
|
|
249
|
+
delete?: never;
|
|
250
|
+
options?: never;
|
|
251
|
+
head?: never;
|
|
252
|
+
patch?: never;
|
|
253
|
+
trace?: never;
|
|
254
|
+
};
|
|
215
255
|
"/api/catalog/content/{type}": {
|
|
216
256
|
parameters: {
|
|
217
257
|
query?: never;
|
|
@@ -2118,7 +2158,7 @@ export interface components {
|
|
|
2118
2158
|
totalCount?: number | null;
|
|
2119
2159
|
};
|
|
2120
2160
|
} | null;
|
|
2121
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
2161
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
2122
2162
|
location?: {
|
|
2123
2163
|
[key: string]: string;
|
|
2124
2164
|
};
|
|
@@ -2490,7 +2530,7 @@ export interface components {
|
|
|
2490
2530
|
totalCount?: number | null;
|
|
2491
2531
|
};
|
|
2492
2532
|
} | null;
|
|
2493
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
2533
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
2494
2534
|
location?: {
|
|
2495
2535
|
[key: string]: string;
|
|
2496
2536
|
};
|
|
@@ -3140,7 +3180,7 @@ export interface components {
|
|
|
3140
3180
|
totalCount?: number | null;
|
|
3141
3181
|
};
|
|
3142
3182
|
} | null;
|
|
3143
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
3183
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
3144
3184
|
location?: {
|
|
3145
3185
|
[key: string]: string;
|
|
3146
3186
|
};
|
|
@@ -3259,6 +3299,59 @@ export interface components {
|
|
|
3259
3299
|
deletedAt?: string | null;
|
|
3260
3300
|
}[];
|
|
3261
3301
|
};
|
|
3302
|
+
/** @description The GitHub file a design is bound to - what `refreshPatternFromSource` re-reads. */
|
|
3303
|
+
DesignSourceBindingPayload: {
|
|
3304
|
+
/**
|
|
3305
|
+
* Format: uuid
|
|
3306
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
3307
|
+
*/
|
|
3308
|
+
connectionId: string;
|
|
3309
|
+
/** @description Repository as `github.com/<owner>/<repo>` - the same form `location.host` stores. */
|
|
3310
|
+
host: string;
|
|
3311
|
+
/** @description Repository-relative path of a file (not a directory), with no leading slash. */
|
|
3312
|
+
path: string;
|
|
3313
|
+
/** @description Branch or tag the binding tracks, stored as `location.branch`. Empty or omitted means the repository's default branch. */
|
|
3314
|
+
ref?: string;
|
|
3315
|
+
};
|
|
3316
|
+
/** @description The keys of a design's `location` (a MapObject on MesheryPattern) when the design is bound to a GitHub source. Written by `importGithubRepository`, `refreshPatternFromSource` and `updatePatternSource`. A design created by an upload or a URL import retains no source - it carries no `github` location and cannot be refreshed until it is bound to one. */
|
|
3317
|
+
DesignSourceLocation: {
|
|
3318
|
+
/** @description Source kind; `github` for a design bound to a GitHub file. */
|
|
3319
|
+
type?: string;
|
|
3320
|
+
/** @description Repository as `github.com/<owner>/<repo>`. */
|
|
3321
|
+
host?: string;
|
|
3322
|
+
/** @description Repository-relative path of the source file. */
|
|
3323
|
+
path?: string;
|
|
3324
|
+
/** @description Ref the binding tracks (a branch or tag name). Empty means the repository's default branch. */
|
|
3325
|
+
branch?: string;
|
|
3326
|
+
/** @description The commit the design's stored content was last read from, by an import or a refresh. Absent when the content was not read from the current binding - after a remap without a refresh, or for a design imported before commits were recorded. Compare it with the head of `branch` to tell whether the source has drifted. */
|
|
3327
|
+
commitSha?: string;
|
|
3328
|
+
} & {
|
|
3329
|
+
[key: string]: unknown;
|
|
3330
|
+
};
|
|
3331
|
+
/** @description One branch of a GitHub repository. */
|
|
3332
|
+
GithubBranch: {
|
|
3333
|
+
/** @description Branch name. */
|
|
3334
|
+
name: string;
|
|
3335
|
+
/** @description Commit at the head of the branch. */
|
|
3336
|
+
commitSha: string;
|
|
3337
|
+
};
|
|
3338
|
+
/** @description A page of a repository's branches. GitHub does not report a total, so the page says whether another follows instead of carrying a count. */
|
|
3339
|
+
GithubBranchPage: {
|
|
3340
|
+
/** @description The repository's default branch. */
|
|
3341
|
+
defaultBranch: string;
|
|
3342
|
+
branches: {
|
|
3343
|
+
/** @description Branch name. */
|
|
3344
|
+
name: string;
|
|
3345
|
+
/** @description Commit at the head of the branch. */
|
|
3346
|
+
commitSha: string;
|
|
3347
|
+
}[];
|
|
3348
|
+
/** @description Zero-based page index served. */
|
|
3349
|
+
page: number;
|
|
3350
|
+
/** @description Page size served. */
|
|
3351
|
+
pageSize: number;
|
|
3352
|
+
/** @description True when another page of branches follows. */
|
|
3353
|
+
hasMore: boolean;
|
|
3354
|
+
};
|
|
3262
3355
|
/** @description Design-level preferences */
|
|
3263
3356
|
DesignPreferences: {
|
|
3264
3357
|
/** @description Map of available layers, where keys are layer names. */
|
|
@@ -3582,7 +3675,7 @@ export interface components {
|
|
|
3582
3675
|
totalCount?: number | null;
|
|
3583
3676
|
};
|
|
3584
3677
|
} | null;
|
|
3585
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
3678
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
3586
3679
|
location?: {
|
|
3587
3680
|
[key: string]: string;
|
|
3588
3681
|
};
|
|
@@ -4906,7 +4999,7 @@ export interface operations {
|
|
|
4906
4999
|
totalCount?: number | null;
|
|
4907
5000
|
};
|
|
4908
5001
|
} | null;
|
|
4909
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
5002
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
4910
5003
|
location?: {
|
|
4911
5004
|
[key: string]: string;
|
|
4912
5005
|
};
|
|
@@ -5387,7 +5480,7 @@ export interface operations {
|
|
|
5387
5480
|
totalCount?: number | null;
|
|
5388
5481
|
};
|
|
5389
5482
|
} | null;
|
|
5390
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
5483
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
5391
5484
|
location?: {
|
|
5392
5485
|
[key: string]: string;
|
|
5393
5486
|
};
|
|
@@ -5862,7 +5955,7 @@ export interface operations {
|
|
|
5862
5955
|
totalCount?: number | null;
|
|
5863
5956
|
};
|
|
5864
5957
|
} | null;
|
|
5865
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
5958
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
5866
5959
|
location?: {
|
|
5867
5960
|
[key: string]: string;
|
|
5868
5961
|
};
|
|
@@ -6322,7 +6415,7 @@ export interface operations {
|
|
|
6322
6415
|
totalCount?: number | null;
|
|
6323
6416
|
};
|
|
6324
6417
|
} | null;
|
|
6325
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
6418
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
6326
6419
|
location?: {
|
|
6327
6420
|
[key: string]: string;
|
|
6328
6421
|
};
|
|
@@ -6854,7 +6947,7 @@ export interface operations {
|
|
|
6854
6947
|
totalCount?: number | null;
|
|
6855
6948
|
};
|
|
6856
6949
|
} | null;
|
|
6857
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
6950
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
6858
6951
|
location?: {
|
|
6859
6952
|
[key: string]: string;
|
|
6860
6953
|
};
|
|
@@ -6978,44 +7071,35 @@ export interface operations {
|
|
|
6978
7071
|
};
|
|
6979
7072
|
};
|
|
6980
7073
|
};
|
|
6981
|
-
|
|
7074
|
+
updatePatternSource: {
|
|
6982
7075
|
parameters: {
|
|
6983
7076
|
query?: never;
|
|
6984
7077
|
header?: never;
|
|
6985
|
-
path
|
|
7078
|
+
path: {
|
|
7079
|
+
/** @description Design (Pattern) ID */
|
|
7080
|
+
designId: string;
|
|
7081
|
+
};
|
|
6986
7082
|
cookie?: never;
|
|
6987
7083
|
};
|
|
6988
7084
|
requestBody: {
|
|
6989
7085
|
content: {
|
|
6990
7086
|
"application/json": {
|
|
6991
7087
|
/**
|
|
6992
|
-
* Format:
|
|
6993
|
-
* @description
|
|
6994
|
-
*/
|
|
6995
|
-
file: string;
|
|
6996
|
-
/** @description The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the server uses it to identify the file type. */
|
|
6997
|
-
fileName: string;
|
|
6998
|
-
/**
|
|
6999
|
-
* @description Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
|
|
7000
|
-
* @default Untitled Design
|
|
7001
|
-
*/
|
|
7002
|
-
name?: string;
|
|
7003
|
-
} | {
|
|
7004
|
-
/**
|
|
7005
|
-
* Format: uri
|
|
7006
|
-
* @description A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure the resource is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details.
|
|
7007
|
-
*/
|
|
7008
|
-
url: string;
|
|
7009
|
-
/**
|
|
7010
|
-
* @description Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
|
|
7011
|
-
* @default Untitled Design
|
|
7088
|
+
* Format: uuid
|
|
7089
|
+
* @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
|
|
7012
7090
|
*/
|
|
7013
|
-
|
|
7091
|
+
connectionId: string;
|
|
7092
|
+
/** @description Repository as `github.com/<owner>/<repo>` - the same form `location.host` stores. */
|
|
7093
|
+
host: string;
|
|
7094
|
+
/** @description Repository-relative path of a file (not a directory), with no leading slash. */
|
|
7095
|
+
path: string;
|
|
7096
|
+
/** @description Branch or tag the binding tracks, stored as `location.branch`. Empty or omitted means the repository's default branch. */
|
|
7097
|
+
ref?: string;
|
|
7014
7098
|
};
|
|
7015
7099
|
};
|
|
7016
7100
|
};
|
|
7017
7101
|
responses: {
|
|
7018
|
-
/** @description
|
|
7102
|
+
/** @description Source binding updated. `sourceContent` and `patternFile` are omitted from the response body, as on refresh and import. */
|
|
7019
7103
|
200: {
|
|
7020
7104
|
headers: {
|
|
7021
7105
|
[name: string]: unknown;
|
|
@@ -7327,7 +7411,7 @@ export interface operations {
|
|
|
7327
7411
|
totalCount?: number | null;
|
|
7328
7412
|
};
|
|
7329
7413
|
} | null;
|
|
7330
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
7414
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
7331
7415
|
location?: {
|
|
7332
7416
|
[key: string]: string;
|
|
7333
7417
|
};
|
|
@@ -7383,15 +7467,17 @@ export interface operations {
|
|
|
7383
7467
|
* @description Timestamp of last design modification.
|
|
7384
7468
|
*/
|
|
7385
7469
|
updatedAt?: string;
|
|
7386
|
-
}
|
|
7470
|
+
};
|
|
7387
7471
|
};
|
|
7388
7472
|
};
|
|
7389
|
-
/** @description Invalid request
|
|
7473
|
+
/** @description Invalid request body or request param */
|
|
7390
7474
|
400: {
|
|
7391
7475
|
headers: {
|
|
7392
7476
|
[name: string]: unknown;
|
|
7393
7477
|
};
|
|
7394
|
-
content
|
|
7478
|
+
content: {
|
|
7479
|
+
"text/plain": string;
|
|
7480
|
+
};
|
|
7395
7481
|
};
|
|
7396
7482
|
/** @description Expired JWT token used or insufficient privilege */
|
|
7397
7483
|
401: {
|
|
@@ -7402,99 +7488,570 @@ export interface operations {
|
|
|
7402
7488
|
"text/plain": string;
|
|
7403
7489
|
};
|
|
7404
7490
|
};
|
|
7491
|
+
/** @description Forbidden */
|
|
7492
|
+
403: {
|
|
7493
|
+
headers: {
|
|
7494
|
+
[name: string]: unknown;
|
|
7495
|
+
};
|
|
7496
|
+
content: {
|
|
7497
|
+
"text/plain": string;
|
|
7498
|
+
};
|
|
7499
|
+
};
|
|
7500
|
+
/** @description Result not found */
|
|
7501
|
+
404: {
|
|
7502
|
+
headers: {
|
|
7503
|
+
[name: string]: unknown;
|
|
7504
|
+
};
|
|
7505
|
+
content: {
|
|
7506
|
+
"text/plain": string;
|
|
7507
|
+
};
|
|
7508
|
+
};
|
|
7509
|
+
/** @description Publish request already exists */
|
|
7510
|
+
409: {
|
|
7511
|
+
headers: {
|
|
7512
|
+
[name: string]: unknown;
|
|
7513
|
+
};
|
|
7514
|
+
content: {
|
|
7515
|
+
"text/plain": string;
|
|
7516
|
+
};
|
|
7517
|
+
};
|
|
7405
7518
|
/** @description Internal server error */
|
|
7406
7519
|
500: {
|
|
7407
7520
|
headers: {
|
|
7408
7521
|
[name: string]: unknown;
|
|
7409
7522
|
};
|
|
7410
|
-
content
|
|
7523
|
+
content: {
|
|
7524
|
+
"text/plain": string;
|
|
7525
|
+
};
|
|
7526
|
+
};
|
|
7527
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
7528
|
+
502: {
|
|
7529
|
+
headers: {
|
|
7530
|
+
[name: string]: unknown;
|
|
7531
|
+
};
|
|
7532
|
+
content: {
|
|
7533
|
+
"text/plain": string;
|
|
7534
|
+
};
|
|
7411
7535
|
};
|
|
7412
7536
|
};
|
|
7413
7537
|
};
|
|
7414
|
-
|
|
7538
|
+
importDesign: {
|
|
7415
7539
|
parameters: {
|
|
7416
|
-
query?:
|
|
7417
|
-
/** @description Restrict to one repository, as `<owner>/<repo>` (case-insensitive). */
|
|
7418
|
-
repository?: string;
|
|
7419
|
-
/** @description Get responses by page */
|
|
7420
|
-
page?: number;
|
|
7421
|
-
/** @description Number of items per page (canonical camelCase form). */
|
|
7422
|
-
pageSize?: number;
|
|
7423
|
-
};
|
|
7540
|
+
query?: never;
|
|
7424
7541
|
header?: never;
|
|
7425
|
-
path
|
|
7426
|
-
/** @description ID of a GitHub App connection. */
|
|
7427
|
-
connectionId: string;
|
|
7428
|
-
};
|
|
7542
|
+
path?: never;
|
|
7429
7543
|
cookie?: never;
|
|
7430
7544
|
};
|
|
7431
|
-
requestBody
|
|
7545
|
+
requestBody: {
|
|
7546
|
+
content: {
|
|
7547
|
+
"application/json": {
|
|
7548
|
+
/**
|
|
7549
|
+
* Format: byte
|
|
7550
|
+
* @description Base64-encoded file bytes. Supported formats: Kubernetes Manifests, Helm Charts, Docker Compose, and Meshery Designs. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details.
|
|
7551
|
+
*/
|
|
7552
|
+
file: string;
|
|
7553
|
+
/** @description The name of the pattern file being imported. Include the extension (e.g. `design.yaml`), as the server uses it to identify the file type. */
|
|
7554
|
+
fileName: string;
|
|
7555
|
+
/**
|
|
7556
|
+
* @description Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
|
|
7557
|
+
* @default Untitled Design
|
|
7558
|
+
*/
|
|
7559
|
+
name?: string;
|
|
7560
|
+
} | {
|
|
7561
|
+
/**
|
|
7562
|
+
* Format: uri
|
|
7563
|
+
* @description A direct URL to a single file, for example: https://raw.github.com/your-design-file.yaml. Ensure the resource is in a supported format: Kubernetes Manifest, Helm Chart, Docker Compose, or Meshery Design. See [Import Designs Documentation](https://docs.meshery.io/guides/configuration-management/importing-designs#import-designs-using-meshery-ui) for details.
|
|
7564
|
+
*/
|
|
7565
|
+
url: string;
|
|
7566
|
+
/**
|
|
7567
|
+
* @description Provide a name for your design. This name will help you identify the design later. You can also change the name of your design after importing it.
|
|
7568
|
+
* @default Untitled Design
|
|
7569
|
+
*/
|
|
7570
|
+
name?: string;
|
|
7571
|
+
};
|
|
7572
|
+
};
|
|
7573
|
+
};
|
|
7432
7574
|
responses: {
|
|
7433
|
-
/** @description
|
|
7575
|
+
/** @description Successful import. The response body is a JSON array of the saved designs, not a message envelope. The import path saves exactly one design, so the array carries a single element and consumers read the imported design as the first element. */
|
|
7434
7576
|
200: {
|
|
7435
7577
|
headers: {
|
|
7436
7578
|
[name: string]: unknown;
|
|
7437
7579
|
};
|
|
7438
7580
|
content: {
|
|
7439
7581
|
"application/json": {
|
|
7440
|
-
/**
|
|
7441
|
-
|
|
7442
|
-
|
|
7443
|
-
|
|
7444
|
-
|
|
7445
|
-
|
|
7446
|
-
|
|
7447
|
-
|
|
7582
|
+
/**
|
|
7583
|
+
* Format: uuid
|
|
7584
|
+
* @description Server-generated design ID.
|
|
7585
|
+
*/
|
|
7586
|
+
id?: string;
|
|
7587
|
+
/** @description Human-readable design name. */
|
|
7588
|
+
name?: string;
|
|
7589
|
+
/** @description Catalog metadata attached to the design when published. */
|
|
7590
|
+
catalogData?: {
|
|
7591
|
+
/** @description Tracks the specific content version that has been made available in the Catalog. */
|
|
7592
|
+
publishedVersion?: string;
|
|
7593
|
+
/** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
|
|
7594
|
+
class?: string & ("official" | "verified" | "reference architecture");
|
|
7448
7595
|
/**
|
|
7449
|
-
*
|
|
7450
|
-
* @description
|
|
7596
|
+
* Model
|
|
7597
|
+
* @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
|
|
7451
7598
|
*/
|
|
7452
|
-
|
|
7453
|
-
/** @description Human-readable design name. */
|
|
7454
|
-
name?: string;
|
|
7455
|
-
/** @description Catalog metadata attached to the design when published. */
|
|
7456
|
-
catalogData?: {
|
|
7457
|
-
/** @description Tracks the specific content version that has been made available in the Catalog. */
|
|
7458
|
-
publishedVersion?: string;
|
|
7459
|
-
/** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
|
|
7460
|
-
class?: string & ("official" | "verified" | "reference architecture");
|
|
7461
|
-
/**
|
|
7462
|
-
* Model
|
|
7463
|
-
* @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
|
|
7464
|
-
*/
|
|
7465
|
-
compatibility: "kubernetes"[];
|
|
7466
|
-
/**
|
|
7467
|
-
* Caveats and Considerations
|
|
7468
|
-
* @description Specific stipulations to consider and known behaviors to be aware of when using this design.
|
|
7469
|
-
*/
|
|
7470
|
-
patternCaveats: string;
|
|
7471
|
-
/**
|
|
7472
|
-
* Description
|
|
7473
|
-
* @description Purpose of the design along with its intended and unintended uses.
|
|
7474
|
-
*/
|
|
7475
|
-
patternInfo: string;
|
|
7476
|
-
/**
|
|
7477
|
-
* Type
|
|
7478
|
-
* @description Categorization of the type of design or operational flow depicted in this design.
|
|
7479
|
-
* @default Deployment
|
|
7480
|
-
* @enum {string}
|
|
7481
|
-
*/
|
|
7482
|
-
type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
|
|
7483
|
-
/** @description Contains reference to the dark and light mode snapshots of the design. */
|
|
7484
|
-
snapshotURL?: string[];
|
|
7485
|
-
};
|
|
7599
|
+
compatibility: "kubernetes"[];
|
|
7486
7600
|
/**
|
|
7487
|
-
*
|
|
7488
|
-
* @description
|
|
7601
|
+
* Caveats and Considerations
|
|
7602
|
+
* @description Specific stipulations to consider and known behaviors to be aware of when using this design.
|
|
7489
7603
|
*/
|
|
7490
|
-
|
|
7491
|
-
/**
|
|
7492
|
-
|
|
7493
|
-
|
|
7494
|
-
|
|
7495
|
-
|
|
7496
|
-
|
|
7497
|
-
|
|
7604
|
+
patternCaveats: string;
|
|
7605
|
+
/**
|
|
7606
|
+
* Description
|
|
7607
|
+
* @description Purpose of the design along with its intended and unintended uses.
|
|
7608
|
+
*/
|
|
7609
|
+
patternInfo: string;
|
|
7610
|
+
/**
|
|
7611
|
+
* Type
|
|
7612
|
+
* @description Categorization of the type of design or operational flow depicted in this design.
|
|
7613
|
+
* @default Deployment
|
|
7614
|
+
* @enum {string}
|
|
7615
|
+
*/
|
|
7616
|
+
type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
|
|
7617
|
+
/** @description Contains reference to the dark and light mode snapshots of the design. */
|
|
7618
|
+
snapshotURL?: string[];
|
|
7619
|
+
};
|
|
7620
|
+
/**
|
|
7621
|
+
* Format: uuid
|
|
7622
|
+
* @description Owning user ID.
|
|
7623
|
+
*/
|
|
7624
|
+
userId?: string;
|
|
7625
|
+
/** @description Owning user record, joined inline by the catalog list/get handlers when shaping responses. Server-projected from the users table via the design's userId; not a column on the meshery_patterns table itself, so the generated Go field is tagged `db:"-"` to keep it out of ORM column scans. */
|
|
7626
|
+
user?: {
|
|
7627
|
+
/**
|
|
7628
|
+
* Format: uuid
|
|
7629
|
+
* @description Unique identifier for the user
|
|
7630
|
+
*/
|
|
7631
|
+
id: string;
|
|
7632
|
+
/**
|
|
7633
|
+
* @deprecated
|
|
7634
|
+
* @description Legacy IdP-derived identifier. Removed in v1beta3; resolve users by id or email.
|
|
7635
|
+
*/
|
|
7636
|
+
userId: string;
|
|
7637
|
+
/**
|
|
7638
|
+
* @description Authentication provider (e.g., Google, Github)
|
|
7639
|
+
* @example [
|
|
7640
|
+
* "local",
|
|
7641
|
+
* "github",
|
|
7642
|
+
* "google",
|
|
7643
|
+
* "twitter"
|
|
7644
|
+
* ]
|
|
7645
|
+
*/
|
|
7646
|
+
provider: string;
|
|
7647
|
+
/**
|
|
7648
|
+
* Format: email
|
|
7649
|
+
* @description User's email address
|
|
7650
|
+
*/
|
|
7651
|
+
email: string;
|
|
7652
|
+
/** @description User's first name */
|
|
7653
|
+
firstName: string;
|
|
7654
|
+
/** @description User's last name */
|
|
7655
|
+
lastName: string;
|
|
7656
|
+
/**
|
|
7657
|
+
* Format: uri
|
|
7658
|
+
* @description URL to user's avatar image
|
|
7659
|
+
*/
|
|
7660
|
+
avatarUrl?: string;
|
|
7661
|
+
/**
|
|
7662
|
+
* @description User account status
|
|
7663
|
+
* @enum {string}
|
|
7664
|
+
*/
|
|
7665
|
+
status: "active" | "inactive" | "pending" | "anonymous";
|
|
7666
|
+
/**
|
|
7667
|
+
* @description User's biography or description
|
|
7668
|
+
* @default
|
|
7669
|
+
*/
|
|
7670
|
+
bio: string;
|
|
7671
|
+
/** @description User's country information stored as JSONB */
|
|
7672
|
+
country?: {
|
|
7673
|
+
[key: string]: unknown;
|
|
7674
|
+
};
|
|
7675
|
+
/** @description User's region information stored as JSONB */
|
|
7676
|
+
region?: {
|
|
7677
|
+
[key: string]: unknown;
|
|
7678
|
+
};
|
|
7679
|
+
/** @description User preferences stored as JSONB */
|
|
7680
|
+
preferences?: {
|
|
7681
|
+
/** @description The mesh adapters of the preference. */
|
|
7682
|
+
meshAdapters?: Record<string, never>[];
|
|
7683
|
+
grafana?: {
|
|
7684
|
+
/** @description Grafana URL for the user configuration. */
|
|
7685
|
+
grafanaUrl?: string;
|
|
7686
|
+
/** @description Grafana API key for the user configuration. */
|
|
7687
|
+
grafanaApiKey?: string;
|
|
7688
|
+
/** @description Selected Grafana board configurations for the user. */
|
|
7689
|
+
selectedBoardsConfigs?: {
|
|
7690
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
7691
|
+
board?: Record<string, never>;
|
|
7692
|
+
/** @description Panels selected for the Grafana board configuration. */
|
|
7693
|
+
panels?: Record<string, never>[];
|
|
7694
|
+
/** @description Template variables applied to the selected Grafana board configuration. */
|
|
7695
|
+
templateVars?: string[];
|
|
7696
|
+
}[];
|
|
7697
|
+
};
|
|
7698
|
+
prometheus?: {
|
|
7699
|
+
/** @description The prometheus URL of the prometheus. */
|
|
7700
|
+
prometheusUrl?: string;
|
|
7701
|
+
/** @description The selected prometheus boards configs of the prometheus. */
|
|
7702
|
+
selectedPrometheusBoardsConfigs?: {
|
|
7703
|
+
/** @description Placeholder for GrafanaBoard definition (define fields as needed) */
|
|
7704
|
+
board?: Record<string, never>;
|
|
7705
|
+
/** @description Panels selected for the Grafana board configuration. */
|
|
7706
|
+
panels?: Record<string, never>[];
|
|
7707
|
+
/** @description Template variables applied to the selected Grafana board configuration. */
|
|
7708
|
+
templateVars?: string[];
|
|
7709
|
+
}[];
|
|
7710
|
+
};
|
|
7711
|
+
loadTestPrefs?: {
|
|
7712
|
+
/** @description Concurrent requests */
|
|
7713
|
+
c?: number;
|
|
7714
|
+
/** @description Queries per second */
|
|
7715
|
+
qps?: number;
|
|
7716
|
+
/** @description Duration */
|
|
7717
|
+
t?: string;
|
|
7718
|
+
/** @description Load generator */
|
|
7719
|
+
gen?: string;
|
|
7720
|
+
};
|
|
7721
|
+
/** @description The anonymous usage stats of the preference. */
|
|
7722
|
+
anonymousUsageStats: boolean;
|
|
7723
|
+
/** @description The anonymous perf results of the preference. */
|
|
7724
|
+
anonymousPerfResults: boolean;
|
|
7725
|
+
/**
|
|
7726
|
+
* Format: date-time
|
|
7727
|
+
* @description Timestamp of when the resource was last updated.
|
|
7728
|
+
*/
|
|
7729
|
+
updatedAt: string;
|
|
7730
|
+
/** @description The dashboard preferences of the preference. */
|
|
7731
|
+
dashboardPreferences: {
|
|
7732
|
+
[key: string]: unknown;
|
|
7733
|
+
};
|
|
7734
|
+
/**
|
|
7735
|
+
* Format: uuid
|
|
7736
|
+
* @description ID of the associated selectedOrganization.
|
|
7737
|
+
*/
|
|
7738
|
+
selectedOrganizationId: string;
|
|
7739
|
+
/** @description The selected workspace for organizations of the preference. */
|
|
7740
|
+
selectedWorkspaceForOrganizations: {
|
|
7741
|
+
[key: string]: string;
|
|
7742
|
+
};
|
|
7743
|
+
/** @description The users extension preferences of the preference. */
|
|
7744
|
+
usersExtensionPreferences: {
|
|
7745
|
+
[key: string]: unknown;
|
|
7746
|
+
};
|
|
7747
|
+
/** @description The remote provider preferences of the preference. */
|
|
7748
|
+
remoteProviderPreferences: {
|
|
7749
|
+
[key: string]: unknown;
|
|
7750
|
+
};
|
|
7751
|
+
};
|
|
7752
|
+
/**
|
|
7753
|
+
* Format: date-time
|
|
7754
|
+
* @description Timestamp when user accepted terms and conditions
|
|
7755
|
+
*/
|
|
7756
|
+
acceptedTermsAt?: string;
|
|
7757
|
+
/**
|
|
7758
|
+
* Format: date-time
|
|
7759
|
+
* @description Timestamp of user's first login
|
|
7760
|
+
*/
|
|
7761
|
+
firstLoginTime?: string;
|
|
7762
|
+
/**
|
|
7763
|
+
* Format: date-time
|
|
7764
|
+
* @description Timestamp of user's most recent login
|
|
7765
|
+
*/
|
|
7766
|
+
lastLoginTime: string;
|
|
7767
|
+
/**
|
|
7768
|
+
* Format: date-time
|
|
7769
|
+
* @description Timestamp when the user record was created
|
|
7770
|
+
*/
|
|
7771
|
+
createdAt: string;
|
|
7772
|
+
/**
|
|
7773
|
+
* Format: date-time
|
|
7774
|
+
* @description Timestamp when the user record was last updated
|
|
7775
|
+
*/
|
|
7776
|
+
updatedAt: string;
|
|
7777
|
+
/** @description Various online profiles associated with the user account */
|
|
7778
|
+
socials?: {
|
|
7779
|
+
/** @description The site of the social. */
|
|
7780
|
+
site: string;
|
|
7781
|
+
/**
|
|
7782
|
+
* Format: uri
|
|
7783
|
+
* @description The link of the social.
|
|
7784
|
+
*/
|
|
7785
|
+
link: string;
|
|
7786
|
+
}[];
|
|
7787
|
+
/**
|
|
7788
|
+
* Format: date-time
|
|
7789
|
+
* @description Timestamp when the user record was soft-deleted (null if not deleted)
|
|
7790
|
+
*/
|
|
7791
|
+
deletedAt: string | null;
|
|
7792
|
+
/**
|
|
7793
|
+
* @description Names of the global roles assigned to the user. Free-form, user-generated values sourced from the roles table (role_name is a varchar, not a fixed enumeration); the seeded system roles such as "admin", "organization admin" and "user" are a subset, not the whole set.
|
|
7794
|
+
* @example [
|
|
7795
|
+
* "organization admin",
|
|
7796
|
+
* "user"
|
|
7797
|
+
* ]
|
|
7798
|
+
*/
|
|
7799
|
+
roleNames?: string[];
|
|
7800
|
+
/** @description Teams the user belongs to with role information */
|
|
7801
|
+
teams?: {
|
|
7802
|
+
/** @description Team memberships for the user with their assigned roles. null means the team memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
7803
|
+
teamsWithRoles?: {
|
|
7804
|
+
/**
|
|
7805
|
+
* Format: uuid
|
|
7806
|
+
* @description Unique identifier of the team.
|
|
7807
|
+
*/
|
|
7808
|
+
id: string;
|
|
7809
|
+
/** @description Name of the team. */
|
|
7810
|
+
name: string;
|
|
7811
|
+
/** @description Human readable description of the team. */
|
|
7812
|
+
description?: string;
|
|
7813
|
+
/**
|
|
7814
|
+
* Format: uuid
|
|
7815
|
+
* @description Identifier of the team owner.
|
|
7816
|
+
*/
|
|
7817
|
+
owner?: string;
|
|
7818
|
+
/** @description Free-form metadata associated with the team. */
|
|
7819
|
+
metadata?: {
|
|
7820
|
+
[key: string]: unknown;
|
|
7821
|
+
};
|
|
7822
|
+
/**
|
|
7823
|
+
* Format: date-time
|
|
7824
|
+
* @description Timestamp when the team was created.
|
|
7825
|
+
*/
|
|
7826
|
+
createdAt?: string;
|
|
7827
|
+
/**
|
|
7828
|
+
* Format: date-time
|
|
7829
|
+
* @description Timestamp when the team was last updated.
|
|
7830
|
+
*/
|
|
7831
|
+
updatedAt?: string;
|
|
7832
|
+
/**
|
|
7833
|
+
* Format: date-time
|
|
7834
|
+
* @description Timestamp when the team was soft-deleted (null if not deleted).
|
|
7835
|
+
*/
|
|
7836
|
+
deletedAt?: string | null;
|
|
7837
|
+
/** @description Names of the roles assigned to the user within this team. Free-form, user-generated role names; not a fixed enumeration. */
|
|
7838
|
+
roleNames: string[];
|
|
7839
|
+
}[] | null;
|
|
7840
|
+
/** @description Total number of team memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
7841
|
+
totalCount?: number | null;
|
|
7842
|
+
};
|
|
7843
|
+
/** @description Organizations the user belongs to with role information */
|
|
7844
|
+
organizations?: {
|
|
7845
|
+
/** @description Organization memberships for the user with their assigned roles. null means the organization memberships were not measured: the read failed, so the list is unknown. An empty array is only ever a measured absence of memberships. */
|
|
7846
|
+
organizationsWithRoles?: {
|
|
7847
|
+
/**
|
|
7848
|
+
* Format: uuid
|
|
7849
|
+
* @description Unique identifier of the organization.
|
|
7850
|
+
*/
|
|
7851
|
+
id: string;
|
|
7852
|
+
/** @description Name of the organization. */
|
|
7853
|
+
name: string;
|
|
7854
|
+
/** @description Human readable description of the organization. */
|
|
7855
|
+
description?: string;
|
|
7856
|
+
/** @description Country associated with the organization. */
|
|
7857
|
+
country?: string;
|
|
7858
|
+
/** @description Region associated with the organization. */
|
|
7859
|
+
region?: string;
|
|
7860
|
+
/**
|
|
7861
|
+
* Format: uuid
|
|
7862
|
+
* @description Identifier of the organization owner.
|
|
7863
|
+
*/
|
|
7864
|
+
owner?: string;
|
|
7865
|
+
/**
|
|
7866
|
+
* Format: date-time
|
|
7867
|
+
* @description Timestamp when the organization was created.
|
|
7868
|
+
*/
|
|
7869
|
+
createdAt?: string;
|
|
7870
|
+
/**
|
|
7871
|
+
* Format: date-time
|
|
7872
|
+
* @description Timestamp when the organization was last updated.
|
|
7873
|
+
*/
|
|
7874
|
+
updatedAt?: string;
|
|
7875
|
+
/**
|
|
7876
|
+
* Format: date-time
|
|
7877
|
+
* @description Timestamp when the organization was soft-deleted (null if not deleted).
|
|
7878
|
+
*/
|
|
7879
|
+
deletedAt?: string | null;
|
|
7880
|
+
/** @description Names of the roles assigned to the user within this organization. Free-form, user-generated role names; not a fixed enumeration. */
|
|
7881
|
+
roleNames: string[];
|
|
7882
|
+
}[] | null;
|
|
7883
|
+
/** @description Total number of organization memberships for the user. null means the count was not measured: the membership read failed, so the value is unknown and must be presented as unknown, never as 0. A number, including 0, is always a measured value. */
|
|
7884
|
+
totalCount?: number | null;
|
|
7885
|
+
};
|
|
7886
|
+
} | null;
|
|
7887
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
7888
|
+
location?: {
|
|
7889
|
+
[key: string]: string;
|
|
7890
|
+
};
|
|
7891
|
+
/** @description Raw design body as it is persisted in the meshery_patterns table's `pattern_file` column. The wire form is the YAML/JSON string the server stores verbatim; consumers that need the structured form transcode at the boundary by parsing the string into a PatternFile (see #/components/schemas/PatternFile) and marshalling it back when they write. Keeping the wire shape as a string mirrors the column's actual representation and avoids forcing every consumer through the structured-vs- string union that the previous *PatternFile typing implied. */
|
|
7892
|
+
patternFile?: string;
|
|
7893
|
+
/**
|
|
7894
|
+
* @description Visibility scope of the design — controls whether non-owners may read or list it. `private` is owner-only, `public` is readable by anyone in the org, and `published` is visible in the catalog.
|
|
7895
|
+
* @enum {string}
|
|
7896
|
+
*/
|
|
7897
|
+
visibility?: "private" | "public" | "published";
|
|
7898
|
+
/**
|
|
7899
|
+
* @description Discriminator identifying the source format of the design body, persisted in the meshery_patterns table's `source_type` column (nullable; null for legacy rows imported before the column was introduced). For catalog listings the server may also project this field from the attached catalog metadata. Use this field to branch rendering between native Meshery designs and imported Helm charts, Kubernetes manifests, and Docker Compose files.
|
|
7900
|
+
* @enum {string|null}
|
|
7901
|
+
*/
|
|
7902
|
+
designType?: "Design" | "Helm Chart" | "Docker Compose" | "Kubernetes Manifest" | null;
|
|
7903
|
+
/**
|
|
7904
|
+
* Format: byte
|
|
7905
|
+
* @description Raw bytes of the imported source artifact (Helm chart tarball, Kubernetes manifest, Docker Compose file, etc.) preserved in the meshery_patterns table's `source_content` column for non-Meshery-Design imports. Empty / null for native Meshery designs. Server-managed: populated by the import and upload handlers and scrubbed to null on most read responses, so clients should treat this as opaque base64-encoded bytes when it does appear on the wire.
|
|
7906
|
+
*/
|
|
7907
|
+
sourceContent?: string | null;
|
|
7908
|
+
/**
|
|
7909
|
+
* @description Server-aggregated count of views on this design in the catalog. Present on list/catalog responses; server-managed and ignored on writes.
|
|
7910
|
+
* @default 0
|
|
7911
|
+
*/
|
|
7912
|
+
viewCount: number;
|
|
7913
|
+
/**
|
|
7914
|
+
* @description Server-aggregated count of downloads of this design from the catalog. Server-managed and ignored on writes.
|
|
7915
|
+
* @default 0
|
|
7916
|
+
*/
|
|
7917
|
+
downloadCount: number;
|
|
7918
|
+
/**
|
|
7919
|
+
* @description Server-aggregated count of times this design has been cloned from the catalog. Server-managed and ignored on writes.
|
|
7920
|
+
* @default 0
|
|
7921
|
+
*/
|
|
7922
|
+
cloneCount: number;
|
|
7923
|
+
/**
|
|
7924
|
+
* @description Server-aggregated count of deployments originated from this design. Server-managed and ignored on writes.
|
|
7925
|
+
* @default 0
|
|
7926
|
+
*/
|
|
7927
|
+
deploymentCount: number;
|
|
7928
|
+
/**
|
|
7929
|
+
* @description Server-aggregated count of share events for this design. Server-managed and ignored on writes.
|
|
7930
|
+
* @default 0
|
|
7931
|
+
*/
|
|
7932
|
+
shareCount: number;
|
|
7933
|
+
/**
|
|
7934
|
+
* Format: date-time
|
|
7935
|
+
* @description Timestamp of design creation.
|
|
7936
|
+
*/
|
|
7937
|
+
createdAt?: string;
|
|
7938
|
+
/**
|
|
7939
|
+
* Format: date-time
|
|
7940
|
+
* @description Timestamp of last design modification.
|
|
7941
|
+
*/
|
|
7942
|
+
updatedAt?: string;
|
|
7943
|
+
}[];
|
|
7944
|
+
};
|
|
7945
|
+
};
|
|
7946
|
+
/** @description Invalid request format */
|
|
7947
|
+
400: {
|
|
7948
|
+
headers: {
|
|
7949
|
+
[name: string]: unknown;
|
|
7950
|
+
};
|
|
7951
|
+
content?: never;
|
|
7952
|
+
};
|
|
7953
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
7954
|
+
401: {
|
|
7955
|
+
headers: {
|
|
7956
|
+
[name: string]: unknown;
|
|
7957
|
+
};
|
|
7958
|
+
content: {
|
|
7959
|
+
"text/plain": string;
|
|
7960
|
+
};
|
|
7961
|
+
};
|
|
7962
|
+
/** @description Internal server error */
|
|
7963
|
+
500: {
|
|
7964
|
+
headers: {
|
|
7965
|
+
[name: string]: unknown;
|
|
7966
|
+
};
|
|
7967
|
+
content?: never;
|
|
7968
|
+
};
|
|
7969
|
+
};
|
|
7970
|
+
};
|
|
7971
|
+
getGithubImportedDesigns: {
|
|
7972
|
+
parameters: {
|
|
7973
|
+
query?: {
|
|
7974
|
+
/** @description Restrict to one repository, as `<owner>/<repo>` (case-insensitive). */
|
|
7975
|
+
repository?: string;
|
|
7976
|
+
/** @description Get responses by page */
|
|
7977
|
+
page?: number;
|
|
7978
|
+
/** @description Number of items per page (canonical camelCase form). */
|
|
7979
|
+
pageSize?: number;
|
|
7980
|
+
};
|
|
7981
|
+
header?: never;
|
|
7982
|
+
path: {
|
|
7983
|
+
/** @description ID of a GitHub App connection. */
|
|
7984
|
+
connectionId: string;
|
|
7985
|
+
};
|
|
7986
|
+
cookie?: never;
|
|
7987
|
+
};
|
|
7988
|
+
requestBody?: never;
|
|
7989
|
+
responses: {
|
|
7990
|
+
/** @description Imported designs page. */
|
|
7991
|
+
200: {
|
|
7992
|
+
headers: {
|
|
7993
|
+
[name: string]: unknown;
|
|
7994
|
+
};
|
|
7995
|
+
content: {
|
|
7996
|
+
"application/json": {
|
|
7997
|
+
/** @description Current page number of the result set. */
|
|
7998
|
+
page?: number;
|
|
7999
|
+
/** @description Number of items per page. */
|
|
8000
|
+
pageSize?: number;
|
|
8001
|
+
/** @description Total number of items available. */
|
|
8002
|
+
totalCount?: number;
|
|
8003
|
+
/** @description Designs included on this page of results. */
|
|
8004
|
+
patterns?: {
|
|
8005
|
+
/**
|
|
8006
|
+
* Format: uuid
|
|
8007
|
+
* @description Server-generated design ID.
|
|
8008
|
+
*/
|
|
8009
|
+
id?: string;
|
|
8010
|
+
/** @description Human-readable design name. */
|
|
8011
|
+
name?: string;
|
|
8012
|
+
/** @description Catalog metadata attached to the design when published. */
|
|
8013
|
+
catalogData?: {
|
|
8014
|
+
/** @description Tracks the specific content version that has been made available in the Catalog. */
|
|
8015
|
+
publishedVersion?: string;
|
|
8016
|
+
/** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
|
|
8017
|
+
class?: string & ("official" | "verified" | "reference architecture");
|
|
8018
|
+
/**
|
|
8019
|
+
* Model
|
|
8020
|
+
* @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
|
|
8021
|
+
*/
|
|
8022
|
+
compatibility: "kubernetes"[];
|
|
8023
|
+
/**
|
|
8024
|
+
* Caveats and Considerations
|
|
8025
|
+
* @description Specific stipulations to consider and known behaviors to be aware of when using this design.
|
|
8026
|
+
*/
|
|
8027
|
+
patternCaveats: string;
|
|
8028
|
+
/**
|
|
8029
|
+
* Description
|
|
8030
|
+
* @description Purpose of the design along with its intended and unintended uses.
|
|
8031
|
+
*/
|
|
8032
|
+
patternInfo: string;
|
|
8033
|
+
/**
|
|
8034
|
+
* Type
|
|
8035
|
+
* @description Categorization of the type of design or operational flow depicted in this design.
|
|
8036
|
+
* @default Deployment
|
|
8037
|
+
* @enum {string}
|
|
8038
|
+
*/
|
|
8039
|
+
type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
|
|
8040
|
+
/** @description Contains reference to the dark and light mode snapshots of the design. */
|
|
8041
|
+
snapshotURL?: string[];
|
|
8042
|
+
};
|
|
8043
|
+
/**
|
|
8044
|
+
* Format: uuid
|
|
8045
|
+
* @description Owning user ID.
|
|
8046
|
+
*/
|
|
8047
|
+
userId?: string;
|
|
8048
|
+
/** @description Owning user record, joined inline by the catalog list/get handlers when shaping responses. Server-projected from the users table via the design's userId; not a column on the meshery_patterns table itself, so the generated Go field is tagged `db:"-"` to keep it out of ORM column scans. */
|
|
8049
|
+
user?: {
|
|
8050
|
+
/**
|
|
8051
|
+
* Format: uuid
|
|
8052
|
+
* @description Unique identifier for the user
|
|
8053
|
+
*/
|
|
8054
|
+
id: string;
|
|
7498
8055
|
/**
|
|
7499
8056
|
* @deprecated
|
|
7500
8057
|
* @description Legacy IdP-derived identifier. Removed in v1beta3; resolve users by id or email.
|
|
@@ -7750,7 +8307,7 @@ export interface operations {
|
|
|
7750
8307
|
totalCount?: number | null;
|
|
7751
8308
|
};
|
|
7752
8309
|
} | null;
|
|
7753
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
8310
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
7754
8311
|
location?: {
|
|
7755
8312
|
[key: string]: string;
|
|
7756
8313
|
};
|
|
@@ -8204,7 +8761,7 @@ export interface operations {
|
|
|
8204
8761
|
totalCount?: number | null;
|
|
8205
8762
|
};
|
|
8206
8763
|
} | null;
|
|
8207
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
8764
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
8208
8765
|
location?: {
|
|
8209
8766
|
[key: string]: string;
|
|
8210
8767
|
};
|
|
@@ -8381,6 +8938,105 @@ export interface operations {
|
|
|
8381
8938
|
};
|
|
8382
8939
|
};
|
|
8383
8940
|
};
|
|
8941
|
+
getGithubRepositoryBranches: {
|
|
8942
|
+
parameters: {
|
|
8943
|
+
query: {
|
|
8944
|
+
/** @description Repository as `<owner>/<repo>` (case-insensitive). */
|
|
8945
|
+
repository: string;
|
|
8946
|
+
/** @description Get responses by page */
|
|
8947
|
+
page?: number;
|
|
8948
|
+
/** @description Number of items per page (canonical camelCase form). */
|
|
8949
|
+
pageSize?: number;
|
|
8950
|
+
};
|
|
8951
|
+
header?: never;
|
|
8952
|
+
path: {
|
|
8953
|
+
/** @description ID of a GitHub App connection. */
|
|
8954
|
+
connectionId: string;
|
|
8955
|
+
};
|
|
8956
|
+
cookie?: never;
|
|
8957
|
+
};
|
|
8958
|
+
requestBody?: never;
|
|
8959
|
+
responses: {
|
|
8960
|
+
/** @description Repository branches page. */
|
|
8961
|
+
200: {
|
|
8962
|
+
headers: {
|
|
8963
|
+
[name: string]: unknown;
|
|
8964
|
+
};
|
|
8965
|
+
content: {
|
|
8966
|
+
"application/json": {
|
|
8967
|
+
/** @description The repository's default branch. */
|
|
8968
|
+
defaultBranch: string;
|
|
8969
|
+
branches: {
|
|
8970
|
+
/** @description Branch name. */
|
|
8971
|
+
name: string;
|
|
8972
|
+
/** @description Commit at the head of the branch. */
|
|
8973
|
+
commitSha: string;
|
|
8974
|
+
}[];
|
|
8975
|
+
/** @description Zero-based page index served. */
|
|
8976
|
+
page: number;
|
|
8977
|
+
/** @description Page size served. */
|
|
8978
|
+
pageSize: number;
|
|
8979
|
+
/** @description True when another page of branches follows. */
|
|
8980
|
+
hasMore: boolean;
|
|
8981
|
+
};
|
|
8982
|
+
};
|
|
8983
|
+
};
|
|
8984
|
+
/** @description Invalid request body or request param */
|
|
8985
|
+
400: {
|
|
8986
|
+
headers: {
|
|
8987
|
+
[name: string]: unknown;
|
|
8988
|
+
};
|
|
8989
|
+
content: {
|
|
8990
|
+
"text/plain": string;
|
|
8991
|
+
};
|
|
8992
|
+
};
|
|
8993
|
+
/** @description Expired JWT token used or insufficient privilege */
|
|
8994
|
+
401: {
|
|
8995
|
+
headers: {
|
|
8996
|
+
[name: string]: unknown;
|
|
8997
|
+
};
|
|
8998
|
+
content: {
|
|
8999
|
+
"text/plain": string;
|
|
9000
|
+
};
|
|
9001
|
+
};
|
|
9002
|
+
/** @description Forbidden */
|
|
9003
|
+
403: {
|
|
9004
|
+
headers: {
|
|
9005
|
+
[name: string]: unknown;
|
|
9006
|
+
};
|
|
9007
|
+
content: {
|
|
9008
|
+
"text/plain": string;
|
|
9009
|
+
};
|
|
9010
|
+
};
|
|
9011
|
+
/** @description Result not found */
|
|
9012
|
+
404: {
|
|
9013
|
+
headers: {
|
|
9014
|
+
[name: string]: unknown;
|
|
9015
|
+
};
|
|
9016
|
+
content: {
|
|
9017
|
+
"text/plain": string;
|
|
9018
|
+
};
|
|
9019
|
+
};
|
|
9020
|
+
/** @description Internal server error */
|
|
9021
|
+
500: {
|
|
9022
|
+
headers: {
|
|
9023
|
+
[name: string]: unknown;
|
|
9024
|
+
};
|
|
9025
|
+
content: {
|
|
9026
|
+
"text/plain": string;
|
|
9027
|
+
};
|
|
9028
|
+
};
|
|
9029
|
+
/** @description Bad gateway - an upstream service the operation depends on could not be reached or rejected the request */
|
|
9030
|
+
502: {
|
|
9031
|
+
headers: {
|
|
9032
|
+
[name: string]: unknown;
|
|
9033
|
+
};
|
|
9034
|
+
content: {
|
|
9035
|
+
"text/plain": string;
|
|
9036
|
+
};
|
|
9037
|
+
};
|
|
9038
|
+
};
|
|
9039
|
+
};
|
|
8384
9040
|
getCatalogContent: {
|
|
8385
9041
|
parameters: {
|
|
8386
9042
|
query?: {
|
|
@@ -8730,7 +9386,7 @@ export interface operations {
|
|
|
8730
9386
|
totalCount?: number | null;
|
|
8731
9387
|
};
|
|
8732
9388
|
} | null;
|
|
8733
|
-
/** @description Optional structured location metadata (branch, host, path, ...). */
|
|
9389
|
+
/** @description Optional structured location metadata (branch, host, path, ...). For a design bound to a GitHub source the keys are those of DesignSourceLocation, including commitSha. */
|
|
8734
9390
|
location?: {
|
|
8735
9391
|
[key: string]: string;
|
|
8736
9392
|
};
|