@meshery/schemas 1.2.1 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/api.d.mts +39 -4
  2. package/dist/api.d.ts +39 -4
  3. package/dist/api.js +2 -2
  4. package/dist/api.mjs +2 -2
  5. package/dist/cloudApi.d.mts +12600 -14467
  6. package/dist/cloudApi.d.ts +12600 -14467
  7. package/dist/cloudApi.js +1 -1
  8. package/dist/cloudApi.mjs +1 -1
  9. package/dist/constructs/v1beta2/team/Team.d.mts +28 -8
  10. package/dist/constructs/v1beta2/team/Team.d.ts +28 -8
  11. package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
  12. package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
  13. package/dist/constructs/v1beta3/design/Design.d.mts +2324 -14651
  14. package/dist/constructs/v1beta3/design/Design.d.ts +2324 -14651
  15. package/dist/constructs/v1beta3/design/DesignSchema.js +17 -471
  16. package/dist/constructs/v1beta3/design/DesignSchema.mjs +17 -471
  17. package/dist/constructs/v1beta3/filter/Filter.d.mts +1366 -0
  18. package/dist/constructs/v1beta3/filter/Filter.d.ts +1366 -0
  19. package/dist/constructs/v1beta3/filter/Filter.js +1 -0
  20. package/dist/constructs/v1beta3/filter/Filter.mjs +0 -0
  21. package/dist/constructs/v1beta3/filter/FilterSchema.d.mts +7 -0
  22. package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +7 -0
  23. package/dist/constructs/v1beta3/filter/FilterSchema.js +80 -0
  24. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +80 -0
  25. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.mts +832 -0
  26. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +832 -0
  27. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.js +1 -0
  28. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.mjs +0 -0
  29. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.mts +7 -0
  30. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +7 -0
  31. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +2 -0
  32. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +2 -0
  33. package/dist/mesheryApi.d.mts +1094 -1086
  34. package/dist/mesheryApi.d.ts +1094 -1086
  35. package/dist/mesheryApi.js +1 -1
  36. package/dist/mesheryApi.mjs +1 -1
  37. package/package.json +1 -1
@@ -0,0 +1,1366 @@
1
+ /**
2
+ * This file was auto-generated by openapi-typescript.
3
+ * Do not make direct changes to the file.
4
+ */
5
+ interface paths {
6
+ "/api/content/filters": {
7
+ /** Returns a paginated list of filters accessible to the user. */
8
+ get: operations["getFilters"];
9
+ /** Creates or updates a Meshery filter. */
10
+ post: operations["upsertFilter"];
11
+ };
12
+ "/api/content/filters/delete": {
13
+ /**
14
+ * Deletes multiple filters by ID. Modeled as a `POST .../delete`
15
+ * sub-resource because REST clients and proxies may strip request
16
+ * bodies on `DELETE`.
17
+ */
18
+ post: operations["deleteFilters"];
19
+ };
20
+ "/api/content/filters/{filterId}": {
21
+ get: operations["getFilter"];
22
+ /**
23
+ * Updates the filter at the supplied ID with the provided payload.
24
+ * Provided as a canonical-CRUD complement to the upsert `POST
25
+ * /api/content/filters` form so consumers that prefer explicit
26
+ * update semantics can address the resource directly.
27
+ */
28
+ put: operations["updateFilter"];
29
+ delete: operations["deleteFilter"];
30
+ };
31
+ "/api/content/filters/clone/{filterId}": {
32
+ /** Creates a copy of an existing filter. */
33
+ post: operations["cloneFilter"];
34
+ };
35
+ "/api/content/filters/download/{filterId}": {
36
+ /**
37
+ * Downloads the raw filter body associated with the supplied
38
+ * filter ID. The server streams the bytes verbatim with
39
+ * `Content-Type: application/wasm` and a
40
+ * `Content-Disposition: attachment` header naming the filter.
41
+ */
42
+ get: operations["getFilterFile"];
43
+ };
44
+ }
45
+ interface components {
46
+ schemas: {
47
+ /**
48
+ * Filter Schema
49
+ * @description Server-returned Meshery filter resource as persisted by meshery-cloud
50
+ * (`meshery_filters` table) and consumed by meshery's
51
+ * `models.MesheryFilter`. Filters carry an opaque body (`filterFile`) plus
52
+ * catalog and visibility metadata, and follow the same content-resource
53
+ * shape as designs minus the catalog engagement counters (the
54
+ * `meshery_filters` table has no `view_count` / `download_count` columns).
55
+ */
56
+ MesheryFilter: {
57
+ /**
58
+ * Format: uuid
59
+ * @description Server-generated filter ID.
60
+ */
61
+ id: string;
62
+ /** @description Human-readable filter name; required, used for catalog listings. */
63
+ name: string;
64
+ /**
65
+ * Format: uuid
66
+ * @description Owning user ID.
67
+ */
68
+ userId: string;
69
+ /**
70
+ * Format: byte
71
+ * @description Raw filter source persisted as a byte array (`bytea` column
72
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
73
+ */
74
+ filterFile?: string;
75
+ /**
76
+ * @description Filter resource discriminator describing the filter body's source
77
+ * format (e.g. WASM module identifier or external resource path).
78
+ * Stored in the `filter_resource` text column.
79
+ */
80
+ filterResource?: string;
81
+ /** @description Optional structured location metadata (branch, host, path, ...). */
82
+ location?: {
83
+ [key: string]: string;
84
+ };
85
+ /**
86
+ * @description Visibility scope (private, public, published).
87
+ * @enum {string}
88
+ */
89
+ visibility?: "private" | "public" | "published";
90
+ /** @description Catalog metadata attached to the filter when published. */
91
+ catalogData?: {
92
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
93
+ publishedVersion?: string;
94
+ /** @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. */
95
+ class?: string;
96
+ /**
97
+ * Model
98
+ * @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.
99
+ */
100
+ compatibility: "kubernetes"[];
101
+ /**
102
+ * Caveats and Considerations
103
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
104
+ */
105
+ patternCaveats: string;
106
+ /**
107
+ * Description
108
+ * @description Purpose of the design along with its intended and unintended uses.
109
+ */
110
+ patternInfo: string;
111
+ /**
112
+ * Type
113
+ * @description Categorization of the type of design or operational flow depicted in this design.
114
+ * @default Deployment
115
+ * @enum {string}
116
+ */
117
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
118
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
119
+ snapshotURL?: string[];
120
+ };
121
+ /**
122
+ * Format: date-time
123
+ * @description Timestamp of filter creation.
124
+ */
125
+ createdAt: string;
126
+ /**
127
+ * Format: date-time
128
+ * @description Timestamp of last filter modification.
129
+ */
130
+ updatedAt: string;
131
+ };
132
+ /**
133
+ * @description Payload for creating or updating a filter via
134
+ * `POST /api/content/filters` or
135
+ * `PUT /api/content/filters/{filterId}`. Contains only
136
+ * client-settable fields; server-generated `createdAt` /
137
+ * `updatedAt` and the owning `userId` (which the server derives
138
+ * from the authenticated session) are intentionally excluded.
139
+ */
140
+ MesheryFilterPayload: {
141
+ /**
142
+ * Format: uuid
143
+ * @description Existing filter ID for updates; omit on create. Wrapped in
144
+ * an `allOf` so we can attach the `json:"id,omitempty"` tag
145
+ * for upsert ergonomics without recursing into the underlying
146
+ * UUID definition.
147
+ */
148
+ id?: string;
149
+ /** @description Human-readable filter name. */
150
+ name: string;
151
+ /**
152
+ * Format: byte
153
+ * @description Raw filter source as base64-encoded bytes (`format: byte`).
154
+ * Optional on update — the server preserves the existing body
155
+ * when omitted.
156
+ */
157
+ filterFile?: string;
158
+ /**
159
+ * @description Filter resource discriminator describing the body's source
160
+ * format (e.g. WASM module identifier or external resource
161
+ * path).
162
+ */
163
+ filterResource?: string;
164
+ /** @description Optional structured location metadata. */
165
+ location?: {
166
+ [key: string]: string;
167
+ };
168
+ /**
169
+ * @description Requested visibility scope. The server may downgrade a
170
+ * requested `published` value to `private` for callers that
171
+ * do not own the filter.
172
+ *
173
+ * @enum {string}
174
+ */
175
+ visibility?: "private" | "public" | "published";
176
+ /** @description Catalog metadata to attach when publishing. */
177
+ catalogData?: {
178
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
179
+ publishedVersion?: string;
180
+ /** @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. */
181
+ class?: string;
182
+ /**
183
+ * Model
184
+ * @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.
185
+ */
186
+ compatibility: "kubernetes"[];
187
+ /**
188
+ * Caveats and Considerations
189
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
190
+ */
191
+ patternCaveats: string;
192
+ /**
193
+ * Description
194
+ * @description Purpose of the design along with its intended and unintended uses.
195
+ */
196
+ patternInfo: string;
197
+ /**
198
+ * Type
199
+ * @description Categorization of the type of design or operational flow depicted in this design.
200
+ * @default Deployment
201
+ * @enum {string}
202
+ */
203
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
204
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
205
+ snapshotURL?: string[];
206
+ };
207
+ };
208
+ /** @description Paginated collection of filters. */
209
+ MesheryFilterPage: {
210
+ /** @description Current page number of the result set. */
211
+ page?: number;
212
+ /** @description Number of items per page. */
213
+ pageSize?: number;
214
+ /** @description Total number of items available. */
215
+ totalCount?: number;
216
+ /** @description Filters included on this page of results. */
217
+ filters?: {
218
+ /**
219
+ * Format: uuid
220
+ * @description Server-generated filter ID.
221
+ */
222
+ id: string;
223
+ /** @description Human-readable filter name; required, used for catalog listings. */
224
+ name: string;
225
+ /**
226
+ * Format: uuid
227
+ * @description Owning user ID.
228
+ */
229
+ userId: string;
230
+ /**
231
+ * Format: byte
232
+ * @description Raw filter source persisted as a byte array (`bytea` column
233
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
234
+ */
235
+ filterFile?: string;
236
+ /**
237
+ * @description Filter resource discriminator describing the filter body's source
238
+ * format (e.g. WASM module identifier or external resource path).
239
+ * Stored in the `filter_resource` text column.
240
+ */
241
+ filterResource?: string;
242
+ /** @description Optional structured location metadata (branch, host, path, ...). */
243
+ location?: {
244
+ [key: string]: string;
245
+ };
246
+ /**
247
+ * @description Visibility scope (private, public, published).
248
+ * @enum {string}
249
+ */
250
+ visibility?: "private" | "public" | "published";
251
+ /** @description Catalog metadata attached to the filter when published. */
252
+ catalogData?: {
253
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
254
+ publishedVersion?: string;
255
+ /** @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. */
256
+ class?: string;
257
+ /**
258
+ * Model
259
+ * @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.
260
+ */
261
+ compatibility: "kubernetes"[];
262
+ /**
263
+ * Caveats and Considerations
264
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
265
+ */
266
+ patternCaveats: string;
267
+ /**
268
+ * Description
269
+ * @description Purpose of the design along with its intended and unintended uses.
270
+ */
271
+ patternInfo: string;
272
+ /**
273
+ * Type
274
+ * @description Categorization of the type of design or operational flow depicted in this design.
275
+ * @default Deployment
276
+ * @enum {string}
277
+ */
278
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
279
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
280
+ snapshotURL?: string[];
281
+ };
282
+ /**
283
+ * Format: date-time
284
+ * @description Timestamp of filter creation.
285
+ */
286
+ createdAt: string;
287
+ /**
288
+ * Format: date-time
289
+ * @description Timestamp of last filter modification.
290
+ */
291
+ updatedAt: string;
292
+ }[];
293
+ };
294
+ /** @description Reference to a filter for bulk deletion by ID. */
295
+ DeleteFilterModel: {
296
+ /**
297
+ * Format: uuid
298
+ * @description Filter ID targeted for deletion.
299
+ */
300
+ id?: string;
301
+ /**
302
+ * @description Human-readable filter name (informational only; the server
303
+ * matches on `id`).
304
+ */
305
+ name?: string;
306
+ };
307
+ /** @description Payload for bulk deleting filters by ID. */
308
+ MesheryFilterDeleteRequestBody: {
309
+ /** @description Filters targeted for deletion. */
310
+ filters: {
311
+ /**
312
+ * Format: uuid
313
+ * @description Filter ID targeted for deletion.
314
+ */
315
+ id?: string;
316
+ /**
317
+ * @description Human-readable filter name (informational only; the server
318
+ * matches on `id`).
319
+ */
320
+ name?: string;
321
+ }[];
322
+ };
323
+ /**
324
+ * @description Payload for `POST /api/content/filters/clone/{filterId}`. The
325
+ * only client-settable field is the optional name applied to the
326
+ * cloned filter; the server derives ownership and visibility from
327
+ * the request context.
328
+ */
329
+ MesheryFilterCloneRequestBody: {
330
+ /**
331
+ * @description Optional name to apply to the cloned filter. Defaults to a
332
+ * server-generated derivative of the source filter's name.
333
+ */
334
+ name?: string;
335
+ };
336
+ /**
337
+ * @description Payload for upserting a filter via `POST /api/content/filters`.
338
+ * Mirrors meshery-cloud's `MesheryFilterRequestBody` and
339
+ * meshery's `MesheryFilterRequestBody` — the wrapper carries an
340
+ * optional source URL/path plus a `save` toggle and an embedded
341
+ * `filterData` payload. Wire form for the embedded payload field
342
+ * is canonical camelCase (`filterData`); legacy snake_case
343
+ * (`filter_data`) is accepted by the existing handlers for the
344
+ * deprecation window but new clients MUST emit `filterData`.
345
+ */
346
+ MesheryFilterRequestBody: {
347
+ /**
348
+ * Format: uri
349
+ * @description Optional source URL the filter was fetched from.
350
+ */
351
+ url?: string;
352
+ /** @description Optional source path the filter was loaded from. */
353
+ path?: string;
354
+ /**
355
+ * @description When true, persist the filter in addition to parsing it.
356
+ * When false, the server returns the parsed payload without
357
+ * committing it to the database.
358
+ */
359
+ save?: boolean;
360
+ /** @description Filter body to persist. */
361
+ filterData?: {
362
+ /**
363
+ * Format: uuid
364
+ * @description Existing filter ID for updates; omit on create. Wrapped in
365
+ * an `allOf` so we can attach the `json:"id,omitempty"` tag
366
+ * for upsert ergonomics without recursing into the underlying
367
+ * UUID definition.
368
+ */
369
+ id?: string;
370
+ /** @description Human-readable filter name. */
371
+ name: string;
372
+ /**
373
+ * Format: byte
374
+ * @description Raw filter source as base64-encoded bytes (`format: byte`).
375
+ * Optional on update — the server preserves the existing body
376
+ * when omitted.
377
+ */
378
+ filterFile?: string;
379
+ /**
380
+ * @description Filter resource discriminator describing the body's source
381
+ * format (e.g. WASM module identifier or external resource
382
+ * path).
383
+ */
384
+ filterResource?: string;
385
+ /** @description Optional structured location metadata. */
386
+ location?: {
387
+ [key: string]: string;
388
+ };
389
+ /**
390
+ * @description Requested visibility scope. The server may downgrade a
391
+ * requested `published` value to `private` for callers that
392
+ * do not own the filter.
393
+ *
394
+ * @enum {string}
395
+ */
396
+ visibility?: "private" | "public" | "published";
397
+ /** @description Catalog metadata to attach when publishing. */
398
+ catalogData?: {
399
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
400
+ publishedVersion?: string;
401
+ /** @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. */
402
+ class?: string;
403
+ /**
404
+ * Model
405
+ * @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.
406
+ */
407
+ compatibility: "kubernetes"[];
408
+ /**
409
+ * Caveats and Considerations
410
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
411
+ */
412
+ patternCaveats: string;
413
+ /**
414
+ * Description
415
+ * @description Purpose of the design along with its intended and unintended uses.
416
+ */
417
+ patternInfo: string;
418
+ /**
419
+ * Type
420
+ * @description Categorization of the type of design or operational flow depicted in this design.
421
+ * @default Deployment
422
+ * @enum {string}
423
+ */
424
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
425
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
426
+ snapshotURL?: string[];
427
+ };
428
+ };
429
+ /**
430
+ * @description Optional opaque configuration string passed through to the
431
+ * underlying filter runtime. Persisted only on the local
432
+ * meshery `MesheryFilterPayload` shape; meshery-cloud
433
+ * currently ignores the field, but it is documented here so
434
+ * the canonical contract is single-sourced.
435
+ */
436
+ config?: string;
437
+ };
438
+ };
439
+ responses: {
440
+ /** Invalid request body or request param */
441
+ 400: {
442
+ content: {
443
+ "text/plain": string;
444
+ };
445
+ };
446
+ /** Expired JWT token used or insufficient privilege */
447
+ 401: {
448
+ content: {
449
+ "text/plain": string;
450
+ };
451
+ };
452
+ /** Result not found */
453
+ 404: {
454
+ content: {
455
+ "text/plain": string;
456
+ };
457
+ };
458
+ /** Internal server error */
459
+ 500: {
460
+ content: {
461
+ "text/plain": string;
462
+ };
463
+ };
464
+ };
465
+ parameters: {
466
+ /** @description Filter ID */
467
+ filterId: string;
468
+ /** @description Get responses by page */
469
+ page: string;
470
+ /** @description Number of items per page (canonical camelCase form). */
471
+ pageSize: number;
472
+ /** @description Get responses that match search param value */
473
+ search: string;
474
+ /** @description Get ordered responses */
475
+ order: string;
476
+ /** @description User's organization ID */
477
+ orgIdQuery: string;
478
+ };
479
+ }
480
+ interface operations {
481
+ /** Returns a paginated list of filters accessible to the user. */
482
+ getFilters: {
483
+ parameters: {
484
+ query: {
485
+ /** Get responses by page */
486
+ page?: string;
487
+ /** Number of items per page (canonical camelCase form). */
488
+ pageSize?: number;
489
+ /** Get responses that match search param value */
490
+ search?: string;
491
+ /** Get ordered responses */
492
+ order?: string;
493
+ /** User's organization ID */
494
+ orgId?: string;
495
+ /** Filter by visibility (public, private, published). May be repeated. */
496
+ visibility?: string[];
497
+ /**
498
+ * UUID of the owning user. Pass when fetching public/published
499
+ * filters for a specific user (public-profile lookups).
500
+ */
501
+ userId?: string;
502
+ };
503
+ };
504
+ responses: {
505
+ /** Filters response */
506
+ 200: {
507
+ content: {
508
+ "application/json": {
509
+ /** @description Current page number of the result set. */
510
+ page?: number;
511
+ /** @description Number of items per page. */
512
+ pageSize?: number;
513
+ /** @description Total number of items available. */
514
+ totalCount?: number;
515
+ /** @description Filters included on this page of results. */
516
+ filters?: {
517
+ /**
518
+ * Format: uuid
519
+ * @description Server-generated filter ID.
520
+ */
521
+ id: string;
522
+ /** @description Human-readable filter name; required, used for catalog listings. */
523
+ name: string;
524
+ /**
525
+ * Format: uuid
526
+ * @description Owning user ID.
527
+ */
528
+ userId: string;
529
+ /**
530
+ * Format: byte
531
+ * @description Raw filter source persisted as a byte array (`bytea` column
532
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
533
+ */
534
+ filterFile?: string;
535
+ /**
536
+ * @description Filter resource discriminator describing the filter body's source
537
+ * format (e.g. WASM module identifier or external resource path).
538
+ * Stored in the `filter_resource` text column.
539
+ */
540
+ filterResource?: string;
541
+ /** @description Optional structured location metadata (branch, host, path, ...). */
542
+ location?: {
543
+ [key: string]: string;
544
+ };
545
+ /**
546
+ * @description Visibility scope (private, public, published).
547
+ * @enum {string}
548
+ */
549
+ visibility?: "private" | "public" | "published";
550
+ /** @description Catalog metadata attached to the filter when published. */
551
+ catalogData?: {
552
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
553
+ publishedVersion?: string;
554
+ /** @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. */
555
+ class?: string;
556
+ /**
557
+ * Model
558
+ * @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.
559
+ */
560
+ compatibility: "kubernetes"[];
561
+ /**
562
+ * Caveats and Considerations
563
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
564
+ */
565
+ patternCaveats: string;
566
+ /**
567
+ * Description
568
+ * @description Purpose of the design along with its intended and unintended uses.
569
+ */
570
+ patternInfo: string;
571
+ /**
572
+ * Type
573
+ * @description Categorization of the type of design or operational flow depicted in this design.
574
+ * @default Deployment
575
+ * @enum {string}
576
+ */
577
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
578
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
579
+ snapshotURL?: string[];
580
+ };
581
+ /**
582
+ * Format: date-time
583
+ * @description Timestamp of filter creation.
584
+ */
585
+ createdAt: string;
586
+ /**
587
+ * Format: date-time
588
+ * @description Timestamp of last filter modification.
589
+ */
590
+ updatedAt: string;
591
+ }[];
592
+ };
593
+ };
594
+ };
595
+ /** Expired JWT token used or insufficient privilege */
596
+ 401: {
597
+ content: {
598
+ "text/plain": string;
599
+ };
600
+ };
601
+ /** Internal server error */
602
+ 500: {
603
+ content: {
604
+ "text/plain": string;
605
+ };
606
+ };
607
+ };
608
+ };
609
+ /** Creates or updates a Meshery filter. */
610
+ upsertFilter: {
611
+ responses: {
612
+ /** Filter saved */
613
+ 200: {
614
+ content: {
615
+ "application/json": {
616
+ /**
617
+ * Format: uuid
618
+ * @description Server-generated filter ID.
619
+ */
620
+ id: string;
621
+ /** @description Human-readable filter name; required, used for catalog listings. */
622
+ name: string;
623
+ /**
624
+ * Format: uuid
625
+ * @description Owning user ID.
626
+ */
627
+ userId: string;
628
+ /**
629
+ * Format: byte
630
+ * @description Raw filter source persisted as a byte array (`bytea` column
631
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
632
+ */
633
+ filterFile?: string;
634
+ /**
635
+ * @description Filter resource discriminator describing the filter body's source
636
+ * format (e.g. WASM module identifier or external resource path).
637
+ * Stored in the `filter_resource` text column.
638
+ */
639
+ filterResource?: string;
640
+ /** @description Optional structured location metadata (branch, host, path, ...). */
641
+ location?: {
642
+ [key: string]: string;
643
+ };
644
+ /**
645
+ * @description Visibility scope (private, public, published).
646
+ * @enum {string}
647
+ */
648
+ visibility?: "private" | "public" | "published";
649
+ /** @description Catalog metadata attached to the filter when published. */
650
+ catalogData?: {
651
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
652
+ publishedVersion?: string;
653
+ /** @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. */
654
+ class?: string;
655
+ /**
656
+ * Model
657
+ * @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.
658
+ */
659
+ compatibility: "kubernetes"[];
660
+ /**
661
+ * Caveats and Considerations
662
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
663
+ */
664
+ patternCaveats: string;
665
+ /**
666
+ * Description
667
+ * @description Purpose of the design along with its intended and unintended uses.
668
+ */
669
+ patternInfo: string;
670
+ /**
671
+ * Type
672
+ * @description Categorization of the type of design or operational flow depicted in this design.
673
+ * @default Deployment
674
+ * @enum {string}
675
+ */
676
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
677
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
678
+ snapshotURL?: string[];
679
+ };
680
+ /**
681
+ * Format: date-time
682
+ * @description Timestamp of filter creation.
683
+ */
684
+ createdAt: string;
685
+ /**
686
+ * Format: date-time
687
+ * @description Timestamp of last filter modification.
688
+ */
689
+ updatedAt: string;
690
+ };
691
+ };
692
+ };
693
+ /** Invalid request body or request param */
694
+ 400: {
695
+ content: {
696
+ "text/plain": string;
697
+ };
698
+ };
699
+ /** Expired JWT token used or insufficient privilege */
700
+ 401: {
701
+ content: {
702
+ "text/plain": string;
703
+ };
704
+ };
705
+ /** Internal server error */
706
+ 500: {
707
+ content: {
708
+ "text/plain": string;
709
+ };
710
+ };
711
+ };
712
+ requestBody: {
713
+ content: {
714
+ "application/json": {
715
+ /**
716
+ * Format: uri
717
+ * @description Optional source URL the filter was fetched from.
718
+ */
719
+ url?: string;
720
+ /** @description Optional source path the filter was loaded from. */
721
+ path?: string;
722
+ /**
723
+ * @description When true, persist the filter in addition to parsing it.
724
+ * When false, the server returns the parsed payload without
725
+ * committing it to the database.
726
+ */
727
+ save?: boolean;
728
+ /** @description Filter body to persist. */
729
+ filterData?: {
730
+ /**
731
+ * Format: uuid
732
+ * @description Existing filter ID for updates; omit on create. Wrapped in
733
+ * an `allOf` so we can attach the `json:"id,omitempty"` tag
734
+ * for upsert ergonomics without recursing into the underlying
735
+ * UUID definition.
736
+ */
737
+ id?: string;
738
+ /** @description Human-readable filter name. */
739
+ name: string;
740
+ /**
741
+ * Format: byte
742
+ * @description Raw filter source as base64-encoded bytes (`format: byte`).
743
+ * Optional on update — the server preserves the existing body
744
+ * when omitted.
745
+ */
746
+ filterFile?: string;
747
+ /**
748
+ * @description Filter resource discriminator describing the body's source
749
+ * format (e.g. WASM module identifier or external resource
750
+ * path).
751
+ */
752
+ filterResource?: string;
753
+ /** @description Optional structured location metadata. */
754
+ location?: {
755
+ [key: string]: string;
756
+ };
757
+ /**
758
+ * @description Requested visibility scope. The server may downgrade a
759
+ * requested `published` value to `private` for callers that
760
+ * do not own the filter.
761
+ *
762
+ * @enum {string}
763
+ */
764
+ visibility?: "private" | "public" | "published";
765
+ /** @description Catalog metadata to attach when publishing. */
766
+ catalogData?: {
767
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
768
+ publishedVersion?: string;
769
+ /** @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. */
770
+ class?: string;
771
+ /**
772
+ * Model
773
+ * @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.
774
+ */
775
+ compatibility: "kubernetes"[];
776
+ /**
777
+ * Caveats and Considerations
778
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
779
+ */
780
+ patternCaveats: string;
781
+ /**
782
+ * Description
783
+ * @description Purpose of the design along with its intended and unintended uses.
784
+ */
785
+ patternInfo: string;
786
+ /**
787
+ * Type
788
+ * @description Categorization of the type of design or operational flow depicted in this design.
789
+ * @default Deployment
790
+ * @enum {string}
791
+ */
792
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
793
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
794
+ snapshotURL?: string[];
795
+ };
796
+ };
797
+ /**
798
+ * @description Optional opaque configuration string passed through to the
799
+ * underlying filter runtime. Persisted only on the local
800
+ * meshery `MesheryFilterPayload` shape; meshery-cloud
801
+ * currently ignores the field, but it is documented here so
802
+ * the canonical contract is single-sourced.
803
+ */
804
+ config?: string;
805
+ };
806
+ };
807
+ };
808
+ };
809
+ /**
810
+ * Deletes multiple filters by ID. Modeled as a `POST .../delete`
811
+ * sub-resource because REST clients and proxies may strip request
812
+ * bodies on `DELETE`.
813
+ */
814
+ deleteFilters: {
815
+ responses: {
816
+ /** Filters deleted */
817
+ 200: unknown;
818
+ /** Invalid request body or request param */
819
+ 400: {
820
+ content: {
821
+ "text/plain": string;
822
+ };
823
+ };
824
+ /** Expired JWT token used or insufficient privilege */
825
+ 401: {
826
+ content: {
827
+ "text/plain": string;
828
+ };
829
+ };
830
+ /** Internal server error */
831
+ 500: {
832
+ content: {
833
+ "text/plain": string;
834
+ };
835
+ };
836
+ };
837
+ requestBody: {
838
+ content: {
839
+ "application/json": {
840
+ /** @description Filters targeted for deletion. */
841
+ filters: {
842
+ /**
843
+ * Format: uuid
844
+ * @description Filter ID targeted for deletion.
845
+ */
846
+ id?: string;
847
+ /**
848
+ * @description Human-readable filter name (informational only; the server
849
+ * matches on `id`).
850
+ */
851
+ name?: string;
852
+ }[];
853
+ };
854
+ };
855
+ };
856
+ };
857
+ getFilter: {
858
+ parameters: {
859
+ path: {
860
+ /** Filter ID */
861
+ filterId: string;
862
+ };
863
+ };
864
+ responses: {
865
+ /** Filter response */
866
+ 200: {
867
+ content: {
868
+ "application/json": {
869
+ /**
870
+ * Format: uuid
871
+ * @description Server-generated filter ID.
872
+ */
873
+ id: string;
874
+ /** @description Human-readable filter name; required, used for catalog listings. */
875
+ name: string;
876
+ /**
877
+ * Format: uuid
878
+ * @description Owning user ID.
879
+ */
880
+ userId: string;
881
+ /**
882
+ * Format: byte
883
+ * @description Raw filter source persisted as a byte array (`bytea` column
884
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
885
+ */
886
+ filterFile?: string;
887
+ /**
888
+ * @description Filter resource discriminator describing the filter body's source
889
+ * format (e.g. WASM module identifier or external resource path).
890
+ * Stored in the `filter_resource` text column.
891
+ */
892
+ filterResource?: string;
893
+ /** @description Optional structured location metadata (branch, host, path, ...). */
894
+ location?: {
895
+ [key: string]: string;
896
+ };
897
+ /**
898
+ * @description Visibility scope (private, public, published).
899
+ * @enum {string}
900
+ */
901
+ visibility?: "private" | "public" | "published";
902
+ /** @description Catalog metadata attached to the filter when published. */
903
+ catalogData?: {
904
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
905
+ publishedVersion?: string;
906
+ /** @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. */
907
+ class?: string;
908
+ /**
909
+ * Model
910
+ * @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.
911
+ */
912
+ compatibility: "kubernetes"[];
913
+ /**
914
+ * Caveats and Considerations
915
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
916
+ */
917
+ patternCaveats: string;
918
+ /**
919
+ * Description
920
+ * @description Purpose of the design along with its intended and unintended uses.
921
+ */
922
+ patternInfo: string;
923
+ /**
924
+ * Type
925
+ * @description Categorization of the type of design or operational flow depicted in this design.
926
+ * @default Deployment
927
+ * @enum {string}
928
+ */
929
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
930
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
931
+ snapshotURL?: string[];
932
+ };
933
+ /**
934
+ * Format: date-time
935
+ * @description Timestamp of filter creation.
936
+ */
937
+ createdAt: string;
938
+ /**
939
+ * Format: date-time
940
+ * @description Timestamp of last filter modification.
941
+ */
942
+ updatedAt: string;
943
+ };
944
+ };
945
+ };
946
+ /** Invalid request body or request param */
947
+ 400: {
948
+ content: {
949
+ "text/plain": string;
950
+ };
951
+ };
952
+ /** Expired JWT token used or insufficient privilege */
953
+ 401: {
954
+ content: {
955
+ "text/plain": string;
956
+ };
957
+ };
958
+ /** Result not found */
959
+ 404: {
960
+ content: {
961
+ "text/plain": string;
962
+ };
963
+ };
964
+ /** Internal server error */
965
+ 500: {
966
+ content: {
967
+ "text/plain": string;
968
+ };
969
+ };
970
+ };
971
+ };
972
+ /**
973
+ * Updates the filter at the supplied ID with the provided payload.
974
+ * Provided as a canonical-CRUD complement to the upsert `POST
975
+ * /api/content/filters` form so consumers that prefer explicit
976
+ * update semantics can address the resource directly.
977
+ */
978
+ updateFilter: {
979
+ parameters: {
980
+ path: {
981
+ /** Filter ID */
982
+ filterId: string;
983
+ };
984
+ };
985
+ responses: {
986
+ /** Filter updated */
987
+ 200: {
988
+ content: {
989
+ "application/json": {
990
+ /**
991
+ * Format: uuid
992
+ * @description Server-generated filter ID.
993
+ */
994
+ id: string;
995
+ /** @description Human-readable filter name; required, used for catalog listings. */
996
+ name: string;
997
+ /**
998
+ * Format: uuid
999
+ * @description Owning user ID.
1000
+ */
1001
+ userId: string;
1002
+ /**
1003
+ * Format: byte
1004
+ * @description Raw filter source persisted as a byte array (`bytea` column
1005
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
1006
+ */
1007
+ filterFile?: string;
1008
+ /**
1009
+ * @description Filter resource discriminator describing the filter body's source
1010
+ * format (e.g. WASM module identifier or external resource path).
1011
+ * Stored in the `filter_resource` text column.
1012
+ */
1013
+ filterResource?: string;
1014
+ /** @description Optional structured location metadata (branch, host, path, ...). */
1015
+ location?: {
1016
+ [key: string]: string;
1017
+ };
1018
+ /**
1019
+ * @description Visibility scope (private, public, published).
1020
+ * @enum {string}
1021
+ */
1022
+ visibility?: "private" | "public" | "published";
1023
+ /** @description Catalog metadata attached to the filter when published. */
1024
+ catalogData?: {
1025
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
1026
+ publishedVersion?: string;
1027
+ /** @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. */
1028
+ class?: string;
1029
+ /**
1030
+ * Model
1031
+ * @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.
1032
+ */
1033
+ compatibility: "kubernetes"[];
1034
+ /**
1035
+ * Caveats and Considerations
1036
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
1037
+ */
1038
+ patternCaveats: string;
1039
+ /**
1040
+ * Description
1041
+ * @description Purpose of the design along with its intended and unintended uses.
1042
+ */
1043
+ patternInfo: string;
1044
+ /**
1045
+ * Type
1046
+ * @description Categorization of the type of design or operational flow depicted in this design.
1047
+ * @default Deployment
1048
+ * @enum {string}
1049
+ */
1050
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
1051
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
1052
+ snapshotURL?: string[];
1053
+ };
1054
+ /**
1055
+ * Format: date-time
1056
+ * @description Timestamp of filter creation.
1057
+ */
1058
+ createdAt: string;
1059
+ /**
1060
+ * Format: date-time
1061
+ * @description Timestamp of last filter modification.
1062
+ */
1063
+ updatedAt: string;
1064
+ };
1065
+ };
1066
+ };
1067
+ /** Invalid request body or request param */
1068
+ 400: {
1069
+ content: {
1070
+ "text/plain": string;
1071
+ };
1072
+ };
1073
+ /** Expired JWT token used or insufficient privilege */
1074
+ 401: {
1075
+ content: {
1076
+ "text/plain": string;
1077
+ };
1078
+ };
1079
+ /** Result not found */
1080
+ 404: {
1081
+ content: {
1082
+ "text/plain": string;
1083
+ };
1084
+ };
1085
+ /** Internal server error */
1086
+ 500: {
1087
+ content: {
1088
+ "text/plain": string;
1089
+ };
1090
+ };
1091
+ };
1092
+ requestBody: {
1093
+ content: {
1094
+ "application/json": {
1095
+ /**
1096
+ * Format: uuid
1097
+ * @description Existing filter ID for updates; omit on create. Wrapped in
1098
+ * an `allOf` so we can attach the `json:"id,omitempty"` tag
1099
+ * for upsert ergonomics without recursing into the underlying
1100
+ * UUID definition.
1101
+ */
1102
+ id?: string;
1103
+ /** @description Human-readable filter name. */
1104
+ name: string;
1105
+ /**
1106
+ * Format: byte
1107
+ * @description Raw filter source as base64-encoded bytes (`format: byte`).
1108
+ * Optional on update — the server preserves the existing body
1109
+ * when omitted.
1110
+ */
1111
+ filterFile?: string;
1112
+ /**
1113
+ * @description Filter resource discriminator describing the body's source
1114
+ * format (e.g. WASM module identifier or external resource
1115
+ * path).
1116
+ */
1117
+ filterResource?: string;
1118
+ /** @description Optional structured location metadata. */
1119
+ location?: {
1120
+ [key: string]: string;
1121
+ };
1122
+ /**
1123
+ * @description Requested visibility scope. The server may downgrade a
1124
+ * requested `published` value to `private` for callers that
1125
+ * do not own the filter.
1126
+ *
1127
+ * @enum {string}
1128
+ */
1129
+ visibility?: "private" | "public" | "published";
1130
+ /** @description Catalog metadata to attach when publishing. */
1131
+ catalogData?: {
1132
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
1133
+ publishedVersion?: string;
1134
+ /** @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. */
1135
+ class?: string;
1136
+ /**
1137
+ * Model
1138
+ * @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.
1139
+ */
1140
+ compatibility: "kubernetes"[];
1141
+ /**
1142
+ * Caveats and Considerations
1143
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
1144
+ */
1145
+ patternCaveats: string;
1146
+ /**
1147
+ * Description
1148
+ * @description Purpose of the design along with its intended and unintended uses.
1149
+ */
1150
+ patternInfo: string;
1151
+ /**
1152
+ * Type
1153
+ * @description Categorization of the type of design or operational flow depicted in this design.
1154
+ * @default Deployment
1155
+ * @enum {string}
1156
+ */
1157
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
1158
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
1159
+ snapshotURL?: string[];
1160
+ };
1161
+ };
1162
+ };
1163
+ };
1164
+ };
1165
+ deleteFilter: {
1166
+ parameters: {
1167
+ path: {
1168
+ /** Filter ID */
1169
+ filterId: string;
1170
+ };
1171
+ };
1172
+ responses: {
1173
+ /** Filter deleted */
1174
+ 204: never;
1175
+ /** Expired JWT token used or insufficient privilege */
1176
+ 401: {
1177
+ content: {
1178
+ "text/plain": string;
1179
+ };
1180
+ };
1181
+ /** Result not found */
1182
+ 404: {
1183
+ content: {
1184
+ "text/plain": string;
1185
+ };
1186
+ };
1187
+ /** Internal server error */
1188
+ 500: {
1189
+ content: {
1190
+ "text/plain": string;
1191
+ };
1192
+ };
1193
+ };
1194
+ };
1195
+ /** Creates a copy of an existing filter. */
1196
+ cloneFilter: {
1197
+ parameters: {
1198
+ path: {
1199
+ /** Filter ID */
1200
+ filterId: string;
1201
+ };
1202
+ };
1203
+ responses: {
1204
+ /** Filter cloned */
1205
+ 200: {
1206
+ content: {
1207
+ "application/json": {
1208
+ /**
1209
+ * Format: uuid
1210
+ * @description Server-generated filter ID.
1211
+ */
1212
+ id: string;
1213
+ /** @description Human-readable filter name; required, used for catalog listings. */
1214
+ name: string;
1215
+ /**
1216
+ * Format: uuid
1217
+ * @description Owning user ID.
1218
+ */
1219
+ userId: string;
1220
+ /**
1221
+ * Format: byte
1222
+ * @description Raw filter source persisted as a byte array (`bytea` column
1223
+ * `filter_file`). Wire form is base64 per OpenAPI `format: byte`.
1224
+ */
1225
+ filterFile?: string;
1226
+ /**
1227
+ * @description Filter resource discriminator describing the filter body's source
1228
+ * format (e.g. WASM module identifier or external resource path).
1229
+ * Stored in the `filter_resource` text column.
1230
+ */
1231
+ filterResource?: string;
1232
+ /** @description Optional structured location metadata (branch, host, path, ...). */
1233
+ location?: {
1234
+ [key: string]: string;
1235
+ };
1236
+ /**
1237
+ * @description Visibility scope (private, public, published).
1238
+ * @enum {string}
1239
+ */
1240
+ visibility?: "private" | "public" | "published";
1241
+ /** @description Catalog metadata attached to the filter when published. */
1242
+ catalogData?: {
1243
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
1244
+ publishedVersion?: string;
1245
+ /** @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. */
1246
+ class?: string;
1247
+ /**
1248
+ * Model
1249
+ * @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.
1250
+ */
1251
+ compatibility: "kubernetes"[];
1252
+ /**
1253
+ * Caveats and Considerations
1254
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
1255
+ */
1256
+ patternCaveats: string;
1257
+ /**
1258
+ * Description
1259
+ * @description Purpose of the design along with its intended and unintended uses.
1260
+ */
1261
+ patternInfo: string;
1262
+ /**
1263
+ * Type
1264
+ * @description Categorization of the type of design or operational flow depicted in this design.
1265
+ * @default Deployment
1266
+ * @enum {string}
1267
+ */
1268
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
1269
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
1270
+ snapshotURL?: string[];
1271
+ };
1272
+ /**
1273
+ * Format: date-time
1274
+ * @description Timestamp of filter creation.
1275
+ */
1276
+ createdAt: string;
1277
+ /**
1278
+ * Format: date-time
1279
+ * @description Timestamp of last filter modification.
1280
+ */
1281
+ updatedAt: string;
1282
+ };
1283
+ };
1284
+ };
1285
+ /** Invalid request body or request param */
1286
+ 400: {
1287
+ content: {
1288
+ "text/plain": string;
1289
+ };
1290
+ };
1291
+ /** Expired JWT token used or insufficient privilege */
1292
+ 401: {
1293
+ content: {
1294
+ "text/plain": string;
1295
+ };
1296
+ };
1297
+ /** Result not found */
1298
+ 404: {
1299
+ content: {
1300
+ "text/plain": string;
1301
+ };
1302
+ };
1303
+ /** Internal server error */
1304
+ 500: {
1305
+ content: {
1306
+ "text/plain": string;
1307
+ };
1308
+ };
1309
+ };
1310
+ requestBody: {
1311
+ content: {
1312
+ "application/json": {
1313
+ /**
1314
+ * @description Optional name to apply to the cloned filter. Defaults to a
1315
+ * server-generated derivative of the source filter's name.
1316
+ */
1317
+ name?: string;
1318
+ };
1319
+ };
1320
+ };
1321
+ };
1322
+ /**
1323
+ * Downloads the raw filter body associated with the supplied
1324
+ * filter ID. The server streams the bytes verbatim with
1325
+ * `Content-Type: application/wasm` and a
1326
+ * `Content-Disposition: attachment` header naming the filter.
1327
+ */
1328
+ getFilterFile: {
1329
+ parameters: {
1330
+ path: {
1331
+ /** Filter ID */
1332
+ filterId: string;
1333
+ };
1334
+ };
1335
+ responses: {
1336
+ /** Filter file content */
1337
+ 200: {
1338
+ content: {
1339
+ "application/wasm": string;
1340
+ };
1341
+ };
1342
+ /** Expired JWT token used or insufficient privilege */
1343
+ 401: {
1344
+ content: {
1345
+ "text/plain": string;
1346
+ };
1347
+ };
1348
+ /** Result not found */
1349
+ 404: {
1350
+ content: {
1351
+ "text/plain": string;
1352
+ };
1353
+ };
1354
+ /** Internal server error */
1355
+ 500: {
1356
+ content: {
1357
+ "text/plain": string;
1358
+ };
1359
+ };
1360
+ };
1361
+ };
1362
+ }
1363
+ interface external {
1364
+ }
1365
+
1366
+ export type { components, external, operations, paths };