@meshery/schemas 1.2.14 → 1.2.16

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