@meshery/schemas 1.3.116 → 1.3.118

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 (66) hide show
  1. package/README.md +10 -0
  2. package/dist/api.d.mts +9 -1
  3. package/dist/api.d.ts +9 -1
  4. package/dist/api.js +2 -2
  5. package/dist/api.mjs +2 -2
  6. package/dist/cloudApi.d.mts +739 -20
  7. package/dist/cloudApi.d.ts +739 -20
  8. package/dist/cloudApi.js +1 -1
  9. package/dist/cloudApi.mjs +1 -1
  10. package/dist/constructs/v1alpha1/controllers_config/ControllersConfig.d.ts +37 -1392
  11. package/dist/constructs/v1alpha1/controllers_config/ControllersConfigSchema.js +1 -1
  12. package/dist/constructs/v1alpha1/controllers_config/ControllersConfigSchema.mjs +1 -1
  13. package/dist/constructs/v1beta1/component/ComponentSchema.js +1 -1
  14. package/dist/constructs/v1beta1/component/ComponentSchema.mjs +1 -1
  15. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.js +4 -4
  16. package/dist/constructs/v1beta1/evaluation/EvaluationSchema.mjs +4 -4
  17. package/dist/constructs/v1beta1/model/ModelSchema.js +3 -3
  18. package/dist/constructs/v1beta1/model/ModelSchema.mjs +3 -3
  19. package/dist/constructs/v1beta1/pattern/PatternSchema.js +12 -12
  20. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +12 -12
  21. package/dist/constructs/v1beta1/registry/RegistrySchema.js +18 -18
  22. package/dist/constructs/v1beta1/registry/RegistrySchema.mjs +18 -18
  23. package/dist/constructs/v1beta1/user/User.d.ts +9 -0
  24. package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
  25. package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
  26. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.js +2 -2
  27. package/dist/constructs/v1beta1/workspace/WorkspaceSchema.mjs +2 -2
  28. package/dist/constructs/v1beta2/component/ComponentSchema.js +1 -1
  29. package/dist/constructs/v1beta2/component/ComponentSchema.mjs +1 -1
  30. package/dist/constructs/v1beta2/design/DesignSchema.js +12 -12
  31. package/dist/constructs/v1beta2/design/DesignSchema.mjs +12 -12
  32. package/dist/constructs/v1beta2/model/ModelSchema.js +3 -3
  33. package/dist/constructs/v1beta2/model/ModelSchema.mjs +3 -3
  34. package/dist/constructs/v1beta2/user/User.d.ts +28 -1
  35. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  36. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  37. package/dist/constructs/v1beta2/view/View.d.ts +226 -22
  38. package/dist/constructs/v1beta2/view/ViewSchema.js +4 -4
  39. package/dist/constructs/v1beta2/view/ViewSchema.mjs +4 -4
  40. package/dist/constructs/v1beta3/component/ComponentSchema.js +1 -1
  41. package/dist/constructs/v1beta3/component/ComponentSchema.mjs +1 -1
  42. package/dist/constructs/v1beta3/connection/Connection.d.ts +17 -5
  43. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +3 -3
  44. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +3 -3
  45. package/dist/constructs/v1beta3/content_item/ContentItem.d.ts +2 -2
  46. package/dist/constructs/v1beta3/content_item/ContentItemSchema.js +11 -11
  47. package/dist/constructs/v1beta3/content_item/ContentItemSchema.mjs +11 -11
  48. package/dist/constructs/v1beta3/design/DesignSchema.js +1 -1
  49. package/dist/constructs/v1beta3/design/DesignSchema.mjs +1 -1
  50. package/dist/constructs/v1beta3/event/Event.d.ts +111 -10
  51. package/dist/constructs/v1beta3/event/EventSchema.js +7 -3
  52. package/dist/constructs/v1beta3/event/EventSchema.mjs +7 -3
  53. package/dist/constructs/v1beta3/schedule/Schedule.d.ts +390 -1
  54. package/dist/constructs/v1beta3/schedule/ScheduleSchema.js +35 -15
  55. package/dist/constructs/v1beta3/schedule/ScheduleSchema.mjs +35 -15
  56. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  57. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  58. package/dist/index.d.mts +13 -7
  59. package/dist/index.d.ts +13 -7
  60. package/dist/index.js +31 -31
  61. package/dist/index.mjs +31 -31
  62. package/dist/mesheryApi.d.mts +466 -833
  63. package/dist/mesheryApi.d.ts +466 -833
  64. package/dist/mesheryApi.js +1 -1
  65. package/dist/mesheryApi.mjs +1 -1
  66. package/package.json +2 -2
@@ -75,388 +75,29 @@ export interface components {
75
75
  */
76
76
  schemaVersion: string;
77
77
  /** @description Configuration for the Meshery Operator on the managed cluster. */
78
- operator?: {
79
- /**
80
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
81
- * @enum {string}
82
- */
83
- deploymentMode?: "operator" | "embedded";
84
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
85
- version?: string;
86
- };
78
+ operator?: components["schemas"]["MesheryOperatorConfig"];
87
79
  /** @description Configuration for the MeshSync agent on the managed cluster. */
88
- meshsync?: {
89
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
90
- version?: string;
91
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
92
- replicas?: number;
93
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
94
- watchList?: {
95
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
96
- whitelist?: {
97
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
98
- resource: string;
99
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
100
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
101
- }[];
102
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
103
- blacklist?: string[];
104
- };
105
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
106
- outputNamespaces?: string[];
107
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
108
- outputResources?: string[];
109
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
110
- redactSecrets?: boolean;
111
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
112
- brokerContentDedup?: boolean;
113
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
114
- debugLogging?: boolean;
115
- };
80
+ meshsync?: components["schemas"]["MeshSyncConfig"];
116
81
  /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
117
- broker?: {
118
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
119
- version?: string;
120
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
121
- replicas?: number;
122
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
123
- service?: {
124
- /**
125
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
126
- * @enum {string}
127
- */
128
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
129
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
130
- annotations?: {
131
- [key: string]: string;
132
- };
133
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
134
- loadBalancerClass?: string;
135
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
136
- loadBalancerSourceRanges?: string[];
137
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
138
- externalEndpointOverride?: string;
139
- };
140
- };
82
+ broker?: components["schemas"]["MesheryBrokerConfig"];
141
83
  };
142
84
  /** @description Layered view of the controllers configuration for a single Kubernetes connection. Exposes each precedence layer so clients can indicate, per field, whether the effective value is inherited from the server-wide default or overridden on the connection. */
143
85
  ConnectionControllersConfig: {
144
- /**
145
- * MesheryControllersConfig
146
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
147
- */
148
- override?: {
149
- /**
150
- * @description Specifies the version of the schema used for this configuration document.
151
- * @default controllers.meshery.io/v1alpha1
152
- * @example [
153
- * "v1",
154
- * "v1alpha1",
155
- * "v2beta3",
156
- * "v1.custom-suffix",
157
- * "models.meshery.io/v1beta1",
158
- * "capability.meshery.io/v1alpha1"
159
- * ]
160
- */
161
- schemaVersion: string;
162
- /** @description Configuration for the Meshery Operator on the managed cluster. */
163
- operator?: {
164
- /**
165
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
166
- * @enum {string}
167
- */
168
- deploymentMode?: "operator" | "embedded";
169
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
170
- version?: string;
171
- };
172
- /** @description Configuration for the MeshSync agent on the managed cluster. */
173
- meshsync?: {
174
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
175
- version?: string;
176
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
177
- replicas?: number;
178
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
179
- watchList?: {
180
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
181
- whitelist?: {
182
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
183
- resource: string;
184
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
185
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
186
- }[];
187
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
188
- blacklist?: string[];
189
- };
190
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
191
- outputNamespaces?: string[];
192
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
193
- outputResources?: string[];
194
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
195
- redactSecrets?: boolean;
196
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
197
- brokerContentDedup?: boolean;
198
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
199
- debugLogging?: boolean;
200
- };
201
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
202
- broker?: {
203
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
204
- version?: string;
205
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
206
- replicas?: number;
207
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
208
- service?: {
209
- /**
210
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
211
- * @enum {string}
212
- */
213
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
214
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
215
- annotations?: {
216
- [key: string]: string;
217
- };
218
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
219
- loadBalancerClass?: string;
220
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
221
- loadBalancerSourceRanges?: string[];
222
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
223
- externalEndpointOverride?: string;
224
- };
225
- };
226
- };
227
- /**
228
- * MesheryControllersConfig
229
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
230
- */
231
- default?: {
232
- /**
233
- * @description Specifies the version of the schema used for this configuration document.
234
- * @default controllers.meshery.io/v1alpha1
235
- * @example [
236
- * "v1",
237
- * "v1alpha1",
238
- * "v2beta3",
239
- * "v1.custom-suffix",
240
- * "models.meshery.io/v1beta1",
241
- * "capability.meshery.io/v1alpha1"
242
- * ]
243
- */
244
- schemaVersion: string;
245
- /** @description Configuration for the Meshery Operator on the managed cluster. */
246
- operator?: {
247
- /**
248
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
249
- * @enum {string}
250
- */
251
- deploymentMode?: "operator" | "embedded";
252
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
253
- version?: string;
254
- };
255
- /** @description Configuration for the MeshSync agent on the managed cluster. */
256
- meshsync?: {
257
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
258
- version?: string;
259
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
260
- replicas?: number;
261
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
262
- watchList?: {
263
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
264
- whitelist?: {
265
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
266
- resource: string;
267
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
268
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
269
- }[];
270
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
271
- blacklist?: string[];
272
- };
273
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
274
- outputNamespaces?: string[];
275
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
276
- outputResources?: string[];
277
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
278
- redactSecrets?: boolean;
279
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
280
- brokerContentDedup?: boolean;
281
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
282
- debugLogging?: boolean;
283
- };
284
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
285
- broker?: {
286
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
287
- version?: string;
288
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
289
- replicas?: number;
290
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
291
- service?: {
292
- /**
293
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
294
- * @enum {string}
295
- */
296
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
297
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
298
- annotations?: {
299
- [key: string]: string;
300
- };
301
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
302
- loadBalancerClass?: string;
303
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
304
- loadBalancerSourceRanges?: string[];
305
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
306
- externalEndpointOverride?: string;
307
- };
308
- };
309
- };
310
- /**
311
- * MesheryControllersConfig
312
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
313
- */
314
- effective: {
315
- /**
316
- * @description Specifies the version of the schema used for this configuration document.
317
- * @default controllers.meshery.io/v1alpha1
318
- * @example [
319
- * "v1",
320
- * "v1alpha1",
321
- * "v2beta3",
322
- * "v1.custom-suffix",
323
- * "models.meshery.io/v1beta1",
324
- * "capability.meshery.io/v1alpha1"
325
- * ]
326
- */
327
- schemaVersion: string;
328
- /** @description Configuration for the Meshery Operator on the managed cluster. */
329
- operator?: {
330
- /**
331
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
332
- * @enum {string}
333
- */
334
- deploymentMode?: "operator" | "embedded";
335
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
336
- version?: string;
337
- };
338
- /** @description Configuration for the MeshSync agent on the managed cluster. */
339
- meshsync?: {
340
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
341
- version?: string;
342
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
343
- replicas?: number;
344
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
345
- watchList?: {
346
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
347
- whitelist?: {
348
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
349
- resource: string;
350
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
351
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
352
- }[];
353
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
354
- blacklist?: string[];
355
- };
356
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
357
- outputNamespaces?: string[];
358
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
359
- outputResources?: string[];
360
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
361
- redactSecrets?: boolean;
362
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
363
- brokerContentDedup?: boolean;
364
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
365
- debugLogging?: boolean;
366
- };
367
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
368
- broker?: {
369
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
370
- version?: string;
371
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
372
- replicas?: number;
373
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
374
- service?: {
375
- /**
376
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
377
- * @enum {string}
378
- */
379
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
380
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
381
- annotations?: {
382
- [key: string]: string;
383
- };
384
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
385
- loadBalancerClass?: string;
386
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
387
- loadBalancerSourceRanges?: string[];
388
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
389
- externalEndpointOverride?: string;
390
- };
391
- };
392
- };
86
+ /** @description Per-connection override stored in the connection's metadata. Absent when the connection has no override. */
87
+ override?: components["schemas"]["MesheryControllersConfig"];
88
+ /** @description Current server-wide default configuration. Absent when no server-wide defaults have been set. */
89
+ default?: components["schemas"]["MesheryControllersConfig"];
90
+ /** @description Resolved effective configuration for the connection (override, then server-wide default, then built-in default). */
91
+ effective: components["schemas"]["MesheryControllersConfig"];
393
92
  };
394
93
  /** @description Client-settable controllers configuration document, used as the body of update requests at both layers (server-wide defaults and per-connection override). Identical to MesheryControllersConfig minus the server-stamped schemaVersion. Every field is optional: an absent field inherits from the next precedence layer, and an empty document clears the layer entirely. */
395
94
  MesheryControllersConfigPayload: {
396
95
  /** @description Configuration for the Meshery Operator on the managed cluster. */
397
- operator?: {
398
- /**
399
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
400
- * @enum {string}
401
- */
402
- deploymentMode?: "operator" | "embedded";
403
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
404
- version?: string;
405
- };
96
+ operator?: components["schemas"]["MesheryOperatorConfig"];
406
97
  /** @description Configuration for the MeshSync agent on the managed cluster. */
407
- meshsync?: {
408
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
409
- version?: string;
410
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
411
- replicas?: number;
412
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
413
- watchList?: {
414
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
415
- whitelist?: {
416
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
417
- resource: string;
418
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
419
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
420
- }[];
421
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
422
- blacklist?: string[];
423
- };
424
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
425
- outputNamespaces?: string[];
426
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
427
- outputResources?: string[];
428
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
429
- redactSecrets?: boolean;
430
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
431
- brokerContentDedup?: boolean;
432
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
433
- debugLogging?: boolean;
434
- };
98
+ meshsync?: components["schemas"]["MeshSyncConfig"];
435
99
  /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
436
- broker?: {
437
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
438
- version?: string;
439
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
440
- replicas?: number;
441
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
442
- service?: {
443
- /**
444
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
445
- * @enum {string}
446
- */
447
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
448
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
449
- annotations?: {
450
- [key: string]: string;
451
- };
452
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
453
- loadBalancerClass?: string;
454
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
455
- loadBalancerSourceRanges?: string[];
456
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
457
- externalEndpointOverride?: string;
458
- };
459
- };
100
+ broker?: components["schemas"]["MesheryBrokerConfig"];
460
101
  };
461
102
  /** @description Configuration for the Meshery Operator on a managed cluster. The operator deploys and reconciles MeshSync and Meshery Broker; in embedded mode no operator is installed and MeshSync runs in-process inside Meshery Server. */
462
103
  MesheryOperatorConfig: {
@@ -475,17 +116,7 @@ export interface components {
475
116
  /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
476
117
  replicas?: number;
477
118
  /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
478
- watchList?: {
479
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
480
- whitelist?: {
481
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
482
- resource: string;
483
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
484
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
485
- }[];
486
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
487
- blacklist?: string[];
488
- };
119
+ watchList?: components["schemas"]["MeshSyncWatchList"];
489
120
  /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
490
121
  outputNamespaces?: string[];
491
122
  /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
@@ -500,12 +131,7 @@ export interface components {
500
131
  /** @description Discovery scope for MeshSync. At most one of whitelist or blacklist may be set (enforced by this schema and by MeshSync itself): a whitelist watches only the listed resource types with the listed event types, while a blacklist watches MeshSync's default resource set minus the listed resource types. When both are empty or absent, MeshSync watches its built-in default resource set. Applied through the MeshSync custom resource; MeshSync reads it at startup, so changes trigger a MeshSync restart. */
501
132
  MeshSyncWatchList: {
502
133
  /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
503
- whitelist?: {
504
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
505
- resource: string;
506
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
507
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
508
- }[];
134
+ whitelist?: components["schemas"]["MeshSyncWatchedResource"][];
509
135
  /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
510
136
  blacklist?: string[];
511
137
  };
@@ -523,23 +149,7 @@ export interface components {
523
149
  /** @description Number of NATS server replicas (Broker custom resource spec.size). */
524
150
  replicas?: number;
525
151
  /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
526
- service?: {
527
- /**
528
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
529
- * @enum {string}
530
- */
531
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
532
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
533
- annotations?: {
534
- [key: string]: string;
535
- };
536
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
537
- loadBalancerClass?: string;
538
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
539
- loadBalancerSourceRanges?: string[];
540
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
541
- externalEndpointOverride?: string;
542
- };
152
+ service?: components["schemas"]["MesheryBrokerServiceConfig"];
543
153
  };
544
154
  /** @description Networking configuration for the broker's client-facing Kubernetes Service (Broker custom resource spec.service). Every field reconciles in place: the operator updates the live Service and re-derives the broker endpoint without recreating broker pods. */
545
155
  MesheryBrokerServiceConfig: {
@@ -606,72 +216,7 @@ export interface components {
606
216
  /** @description Controllers configuration document. Absent fields inherit from the next precedence layer. */
607
217
  controllersConfigPayload: {
608
218
  content: {
609
- "application/json": {
610
- /** @description Configuration for the Meshery Operator on the managed cluster. */
611
- operator?: {
612
- /**
613
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
614
- * @enum {string}
615
- */
616
- deploymentMode?: "operator" | "embedded";
617
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
618
- version?: string;
619
- };
620
- /** @description Configuration for the MeshSync agent on the managed cluster. */
621
- meshsync?: {
622
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
623
- version?: string;
624
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
625
- replicas?: number;
626
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
627
- watchList?: {
628
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
629
- whitelist?: {
630
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
631
- resource: string;
632
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
633
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
634
- }[];
635
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
636
- blacklist?: string[];
637
- };
638
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
639
- outputNamespaces?: string[];
640
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
641
- outputResources?: string[];
642
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
643
- redactSecrets?: boolean;
644
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
645
- brokerContentDedup?: boolean;
646
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
647
- debugLogging?: boolean;
648
- };
649
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
650
- broker?: {
651
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
652
- version?: string;
653
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
654
- replicas?: number;
655
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
656
- service?: {
657
- /**
658
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
659
- * @enum {string}
660
- */
661
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
662
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
663
- annotations?: {
664
- [key: string]: string;
665
- };
666
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
667
- loadBalancerClass?: string;
668
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
669
- loadBalancerSourceRanges?: string[];
670
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
671
- externalEndpointOverride?: string;
672
- };
673
- };
674
- };
219
+ "application/json": components["schemas"]["MesheryControllersConfigPayload"];
675
220
  };
676
221
  };
677
222
  };
@@ -695,105 +240,11 @@ export interface operations {
695
240
  [name: string]: unknown;
696
241
  };
697
242
  content: {
698
- "application/json": {
699
- /**
700
- * @description Specifies the version of the schema used for this configuration document.
701
- * @default controllers.meshery.io/v1alpha1
702
- * @example [
703
- * "v1",
704
- * "v1alpha1",
705
- * "v2beta3",
706
- * "v1.custom-suffix",
707
- * "models.meshery.io/v1beta1",
708
- * "capability.meshery.io/v1alpha1"
709
- * ]
710
- */
711
- schemaVersion: string;
712
- /** @description Configuration for the Meshery Operator on the managed cluster. */
713
- operator?: {
714
- /**
715
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
716
- * @enum {string}
717
- */
718
- deploymentMode?: "operator" | "embedded";
719
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
720
- version?: string;
721
- };
722
- /** @description Configuration for the MeshSync agent on the managed cluster. */
723
- meshsync?: {
724
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
725
- version?: string;
726
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
727
- replicas?: number;
728
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
729
- watchList?: {
730
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
731
- whitelist?: {
732
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
733
- resource: string;
734
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
735
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
736
- }[];
737
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
738
- blacklist?: string[];
739
- };
740
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
741
- outputNamespaces?: string[];
742
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
743
- outputResources?: string[];
744
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
745
- redactSecrets?: boolean;
746
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
747
- brokerContentDedup?: boolean;
748
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
749
- debugLogging?: boolean;
750
- };
751
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
752
- broker?: {
753
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
754
- version?: string;
755
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
756
- replicas?: number;
757
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
758
- service?: {
759
- /**
760
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
761
- * @enum {string}
762
- */
763
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
764
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
765
- annotations?: {
766
- [key: string]: string;
767
- };
768
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
769
- loadBalancerClass?: string;
770
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
771
- loadBalancerSourceRanges?: string[];
772
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
773
- externalEndpointOverride?: string;
774
- };
775
- };
776
- };
777
- };
778
- };
779
- /** @description Expired JWT token used or insufficient privilege */
780
- 401: {
781
- headers: {
782
- [name: string]: unknown;
783
- };
784
- content: {
785
- "text/plain": string;
786
- };
787
- };
788
- /** @description Internal server error */
789
- 500: {
790
- headers: {
791
- [name: string]: unknown;
792
- };
793
- content: {
794
- "text/plain": string;
243
+ "application/json": components["schemas"]["MesheryControllersConfig"];
795
244
  };
796
245
  };
246
+ 401: components["responses"]["401"];
247
+ 500: components["responses"]["500"];
797
248
  };
798
249
  };
799
250
  updateControllersDefaultConfig: {
@@ -803,77 +254,7 @@ export interface operations {
803
254
  path?: never;
804
255
  cookie?: never;
805
256
  };
806
- /** @description Controllers configuration document. Absent fields inherit from the next precedence layer. */
807
- requestBody: {
808
- content: {
809
- "application/json": {
810
- /** @description Configuration for the Meshery Operator on the managed cluster. */
811
- operator?: {
812
- /**
813
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
814
- * @enum {string}
815
- */
816
- deploymentMode?: "operator" | "embedded";
817
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
818
- version?: string;
819
- };
820
- /** @description Configuration for the MeshSync agent on the managed cluster. */
821
- meshsync?: {
822
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
823
- version?: string;
824
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
825
- replicas?: number;
826
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
827
- watchList?: {
828
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
829
- whitelist?: {
830
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
831
- resource: string;
832
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
833
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
834
- }[];
835
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
836
- blacklist?: string[];
837
- };
838
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
839
- outputNamespaces?: string[];
840
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
841
- outputResources?: string[];
842
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
843
- redactSecrets?: boolean;
844
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
845
- brokerContentDedup?: boolean;
846
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
847
- debugLogging?: boolean;
848
- };
849
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
850
- broker?: {
851
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
852
- version?: string;
853
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
854
- replicas?: number;
855
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
856
- service?: {
857
- /**
858
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
859
- * @enum {string}
860
- */
861
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
862
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
863
- annotations?: {
864
- [key: string]: string;
865
- };
866
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
867
- loadBalancerClass?: string;
868
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
869
- loadBalancerSourceRanges?: string[];
870
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
871
- externalEndpointOverride?: string;
872
- };
873
- };
874
- };
875
- };
876
- };
257
+ requestBody: components["requestBodies"]["controllersConfigPayload"];
877
258
  responses: {
878
259
  /** @description Persisted server-wide controllers configuration defaults */
879
260
  200: {
@@ -881,114 +262,12 @@ export interface operations {
881
262
  [name: string]: unknown;
882
263
  };
883
264
  content: {
884
- "application/json": {
885
- /**
886
- * @description Specifies the version of the schema used for this configuration document.
887
- * @default controllers.meshery.io/v1alpha1
888
- * @example [
889
- * "v1",
890
- * "v1alpha1",
891
- * "v2beta3",
892
- * "v1.custom-suffix",
893
- * "models.meshery.io/v1beta1",
894
- * "capability.meshery.io/v1alpha1"
895
- * ]
896
- */
897
- schemaVersion: string;
898
- /** @description Configuration for the Meshery Operator on the managed cluster. */
899
- operator?: {
900
- /**
901
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
902
- * @enum {string}
903
- */
904
- deploymentMode?: "operator" | "embedded";
905
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
906
- version?: string;
907
- };
908
- /** @description Configuration for the MeshSync agent on the managed cluster. */
909
- meshsync?: {
910
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
911
- version?: string;
912
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
913
- replicas?: number;
914
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
915
- watchList?: {
916
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
917
- whitelist?: {
918
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
919
- resource: string;
920
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
921
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
922
- }[];
923
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
924
- blacklist?: string[];
925
- };
926
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
927
- outputNamespaces?: string[];
928
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
929
- outputResources?: string[];
930
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
931
- redactSecrets?: boolean;
932
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
933
- brokerContentDedup?: boolean;
934
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
935
- debugLogging?: boolean;
936
- };
937
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
938
- broker?: {
939
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
940
- version?: string;
941
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
942
- replicas?: number;
943
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
944
- service?: {
945
- /**
946
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
947
- * @enum {string}
948
- */
949
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
950
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
951
- annotations?: {
952
- [key: string]: string;
953
- };
954
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
955
- loadBalancerClass?: string;
956
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
957
- loadBalancerSourceRanges?: string[];
958
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
959
- externalEndpointOverride?: string;
960
- };
961
- };
962
- };
963
- };
964
- };
965
- /** @description Invalid request body or request param */
966
- 400: {
967
- headers: {
968
- [name: string]: unknown;
969
- };
970
- content: {
971
- "text/plain": string;
972
- };
973
- };
974
- /** @description Expired JWT token used or insufficient privilege */
975
- 401: {
976
- headers: {
977
- [name: string]: unknown;
978
- };
979
- content: {
980
- "text/plain": string;
981
- };
982
- };
983
- /** @description Internal server error */
984
- 500: {
985
- headers: {
986
- [name: string]: unknown;
987
- };
988
- content: {
989
- "text/plain": string;
265
+ "application/json": components["schemas"]["MesheryControllersConfig"];
990
266
  };
991
267
  };
268
+ 400: components["responses"]["400"];
269
+ 401: components["responses"]["401"];
270
+ 500: components["responses"]["500"];
992
271
  };
993
272
  };
994
273
  getConnectionControllersConfig: {
@@ -997,7 +276,7 @@ export interface operations {
997
276
  header?: never;
998
277
  path: {
999
278
  /** @description Kubernetes connection ID. */
1000
- connectionId: string;
279
+ connectionId: components["parameters"]["connectionId"];
1001
280
  };
1002
281
  cookie?: never;
1003
282
  };
@@ -1009,295 +288,13 @@ export interface operations {
1009
288
  [name: string]: unknown;
1010
289
  };
1011
290
  content: {
1012
- "application/json": {
1013
- /**
1014
- * MesheryControllersConfig
1015
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
1016
- */
1017
- override?: {
1018
- /**
1019
- * @description Specifies the version of the schema used for this configuration document.
1020
- * @default controllers.meshery.io/v1alpha1
1021
- * @example [
1022
- * "v1",
1023
- * "v1alpha1",
1024
- * "v2beta3",
1025
- * "v1.custom-suffix",
1026
- * "models.meshery.io/v1beta1",
1027
- * "capability.meshery.io/v1alpha1"
1028
- * ]
1029
- */
1030
- schemaVersion: string;
1031
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1032
- operator?: {
1033
- /**
1034
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1035
- * @enum {string}
1036
- */
1037
- deploymentMode?: "operator" | "embedded";
1038
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1039
- version?: string;
1040
- };
1041
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1042
- meshsync?: {
1043
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1044
- version?: string;
1045
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1046
- replicas?: number;
1047
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1048
- watchList?: {
1049
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1050
- whitelist?: {
1051
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1052
- resource: string;
1053
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1054
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1055
- }[];
1056
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1057
- blacklist?: string[];
1058
- };
1059
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1060
- outputNamespaces?: string[];
1061
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1062
- outputResources?: string[];
1063
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1064
- redactSecrets?: boolean;
1065
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1066
- brokerContentDedup?: boolean;
1067
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1068
- debugLogging?: boolean;
1069
- };
1070
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1071
- broker?: {
1072
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1073
- version?: string;
1074
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1075
- replicas?: number;
1076
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1077
- service?: {
1078
- /**
1079
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1080
- * @enum {string}
1081
- */
1082
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1083
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1084
- annotations?: {
1085
- [key: string]: string;
1086
- };
1087
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1088
- loadBalancerClass?: string;
1089
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1090
- loadBalancerSourceRanges?: string[];
1091
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1092
- externalEndpointOverride?: string;
1093
- };
1094
- };
1095
- };
1096
- /**
1097
- * MesheryControllersConfig
1098
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
1099
- */
1100
- default?: {
1101
- /**
1102
- * @description Specifies the version of the schema used for this configuration document.
1103
- * @default controllers.meshery.io/v1alpha1
1104
- * @example [
1105
- * "v1",
1106
- * "v1alpha1",
1107
- * "v2beta3",
1108
- * "v1.custom-suffix",
1109
- * "models.meshery.io/v1beta1",
1110
- * "capability.meshery.io/v1alpha1"
1111
- * ]
1112
- */
1113
- schemaVersion: string;
1114
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1115
- operator?: {
1116
- /**
1117
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1118
- * @enum {string}
1119
- */
1120
- deploymentMode?: "operator" | "embedded";
1121
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1122
- version?: string;
1123
- };
1124
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1125
- meshsync?: {
1126
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1127
- version?: string;
1128
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1129
- replicas?: number;
1130
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1131
- watchList?: {
1132
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1133
- whitelist?: {
1134
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1135
- resource: string;
1136
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1137
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1138
- }[];
1139
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1140
- blacklist?: string[];
1141
- };
1142
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1143
- outputNamespaces?: string[];
1144
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1145
- outputResources?: string[];
1146
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1147
- redactSecrets?: boolean;
1148
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1149
- brokerContentDedup?: boolean;
1150
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1151
- debugLogging?: boolean;
1152
- };
1153
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1154
- broker?: {
1155
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1156
- version?: string;
1157
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1158
- replicas?: number;
1159
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1160
- service?: {
1161
- /**
1162
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1163
- * @enum {string}
1164
- */
1165
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1166
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1167
- annotations?: {
1168
- [key: string]: string;
1169
- };
1170
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1171
- loadBalancerClass?: string;
1172
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1173
- loadBalancerSourceRanges?: string[];
1174
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1175
- externalEndpointOverride?: string;
1176
- };
1177
- };
1178
- };
1179
- /**
1180
- * MesheryControllersConfig
1181
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
1182
- */
1183
- effective: {
1184
- /**
1185
- * @description Specifies the version of the schema used for this configuration document.
1186
- * @default controllers.meshery.io/v1alpha1
1187
- * @example [
1188
- * "v1",
1189
- * "v1alpha1",
1190
- * "v2beta3",
1191
- * "v1.custom-suffix",
1192
- * "models.meshery.io/v1beta1",
1193
- * "capability.meshery.io/v1alpha1"
1194
- * ]
1195
- */
1196
- schemaVersion: string;
1197
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1198
- operator?: {
1199
- /**
1200
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1201
- * @enum {string}
1202
- */
1203
- deploymentMode?: "operator" | "embedded";
1204
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1205
- version?: string;
1206
- };
1207
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1208
- meshsync?: {
1209
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1210
- version?: string;
1211
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1212
- replicas?: number;
1213
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1214
- watchList?: {
1215
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1216
- whitelist?: {
1217
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1218
- resource: string;
1219
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1220
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1221
- }[];
1222
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1223
- blacklist?: string[];
1224
- };
1225
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1226
- outputNamespaces?: string[];
1227
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1228
- outputResources?: string[];
1229
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1230
- redactSecrets?: boolean;
1231
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1232
- brokerContentDedup?: boolean;
1233
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1234
- debugLogging?: boolean;
1235
- };
1236
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1237
- broker?: {
1238
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1239
- version?: string;
1240
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1241
- replicas?: number;
1242
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1243
- service?: {
1244
- /**
1245
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1246
- * @enum {string}
1247
- */
1248
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1249
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1250
- annotations?: {
1251
- [key: string]: string;
1252
- };
1253
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1254
- loadBalancerClass?: string;
1255
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1256
- loadBalancerSourceRanges?: string[];
1257
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1258
- externalEndpointOverride?: string;
1259
- };
1260
- };
1261
- };
1262
- };
1263
- };
1264
- };
1265
- /** @description Invalid request body or request param */
1266
- 400: {
1267
- headers: {
1268
- [name: string]: unknown;
1269
- };
1270
- content: {
1271
- "text/plain": string;
1272
- };
1273
- };
1274
- /** @description Expired JWT token used or insufficient privilege */
1275
- 401: {
1276
- headers: {
1277
- [name: string]: unknown;
1278
- };
1279
- content: {
1280
- "text/plain": string;
1281
- };
1282
- };
1283
- /** @description Result not found */
1284
- 404: {
1285
- headers: {
1286
- [name: string]: unknown;
1287
- };
1288
- content: {
1289
- "text/plain": string;
1290
- };
1291
- };
1292
- /** @description Internal server error */
1293
- 500: {
1294
- headers: {
1295
- [name: string]: unknown;
1296
- };
1297
- content: {
1298
- "text/plain": string;
291
+ "application/json": components["schemas"]["ConnectionControllersConfig"];
1299
292
  };
1300
293
  };
294
+ 400: components["responses"]["400"];
295
+ 401: components["responses"]["401"];
296
+ 404: components["responses"]["404"];
297
+ 500: components["responses"]["500"];
1301
298
  };
1302
299
  };
1303
300
  updateConnectionControllersConfig: {
@@ -1306,81 +303,11 @@ export interface operations {
1306
303
  header?: never;
1307
304
  path: {
1308
305
  /** @description Kubernetes connection ID. */
1309
- connectionId: string;
306
+ connectionId: components["parameters"]["connectionId"];
1310
307
  };
1311
308
  cookie?: never;
1312
309
  };
1313
- /** @description Controllers configuration document. Absent fields inherit from the next precedence layer. */
1314
- requestBody: {
1315
- content: {
1316
- "application/json": {
1317
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1318
- operator?: {
1319
- /**
1320
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1321
- * @enum {string}
1322
- */
1323
- deploymentMode?: "operator" | "embedded";
1324
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1325
- version?: string;
1326
- };
1327
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1328
- meshsync?: {
1329
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1330
- version?: string;
1331
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1332
- replicas?: number;
1333
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1334
- watchList?: {
1335
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1336
- whitelist?: {
1337
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1338
- resource: string;
1339
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1340
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1341
- }[];
1342
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1343
- blacklist?: string[];
1344
- };
1345
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1346
- outputNamespaces?: string[];
1347
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1348
- outputResources?: string[];
1349
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1350
- redactSecrets?: boolean;
1351
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1352
- brokerContentDedup?: boolean;
1353
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1354
- debugLogging?: boolean;
1355
- };
1356
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1357
- broker?: {
1358
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1359
- version?: string;
1360
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1361
- replicas?: number;
1362
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1363
- service?: {
1364
- /**
1365
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1366
- * @enum {string}
1367
- */
1368
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1369
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1370
- annotations?: {
1371
- [key: string]: string;
1372
- };
1373
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1374
- loadBalancerClass?: string;
1375
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1376
- loadBalancerSourceRanges?: string[];
1377
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1378
- externalEndpointOverride?: string;
1379
- };
1380
- };
1381
- };
1382
- };
1383
- };
310
+ requestBody: components["requestBodies"]["controllersConfigPayload"];
1384
311
  responses: {
1385
312
  /** @description Updated controllers configuration for the connection */
1386
313
  200: {
@@ -1388,295 +315,13 @@ export interface operations {
1388
315
  [name: string]: unknown;
1389
316
  };
1390
317
  content: {
1391
- "application/json": {
1392
- /**
1393
- * MesheryControllersConfig
1394
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
1395
- */
1396
- override?: {
1397
- /**
1398
- * @description Specifies the version of the schema used for this configuration document.
1399
- * @default controllers.meshery.io/v1alpha1
1400
- * @example [
1401
- * "v1",
1402
- * "v1alpha1",
1403
- * "v2beta3",
1404
- * "v1.custom-suffix",
1405
- * "models.meshery.io/v1beta1",
1406
- * "capability.meshery.io/v1alpha1"
1407
- * ]
1408
- */
1409
- schemaVersion: string;
1410
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1411
- operator?: {
1412
- /**
1413
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1414
- * @enum {string}
1415
- */
1416
- deploymentMode?: "operator" | "embedded";
1417
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1418
- version?: string;
1419
- };
1420
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1421
- meshsync?: {
1422
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1423
- version?: string;
1424
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1425
- replicas?: number;
1426
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1427
- watchList?: {
1428
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1429
- whitelist?: {
1430
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1431
- resource: string;
1432
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1433
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1434
- }[];
1435
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1436
- blacklist?: string[];
1437
- };
1438
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1439
- outputNamespaces?: string[];
1440
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1441
- outputResources?: string[];
1442
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1443
- redactSecrets?: boolean;
1444
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1445
- brokerContentDedup?: boolean;
1446
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1447
- debugLogging?: boolean;
1448
- };
1449
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1450
- broker?: {
1451
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1452
- version?: string;
1453
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1454
- replicas?: number;
1455
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1456
- service?: {
1457
- /**
1458
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1459
- * @enum {string}
1460
- */
1461
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1462
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1463
- annotations?: {
1464
- [key: string]: string;
1465
- };
1466
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1467
- loadBalancerClass?: string;
1468
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1469
- loadBalancerSourceRanges?: string[];
1470
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1471
- externalEndpointOverride?: string;
1472
- };
1473
- };
1474
- };
1475
- /**
1476
- * MesheryControllersConfig
1477
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
1478
- */
1479
- default?: {
1480
- /**
1481
- * @description Specifies the version of the schema used for this configuration document.
1482
- * @default controllers.meshery.io/v1alpha1
1483
- * @example [
1484
- * "v1",
1485
- * "v1alpha1",
1486
- * "v2beta3",
1487
- * "v1.custom-suffix",
1488
- * "models.meshery.io/v1beta1",
1489
- * "capability.meshery.io/v1alpha1"
1490
- * ]
1491
- */
1492
- schemaVersion: string;
1493
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1494
- operator?: {
1495
- /**
1496
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1497
- * @enum {string}
1498
- */
1499
- deploymentMode?: "operator" | "embedded";
1500
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1501
- version?: string;
1502
- };
1503
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1504
- meshsync?: {
1505
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1506
- version?: string;
1507
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1508
- replicas?: number;
1509
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1510
- watchList?: {
1511
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1512
- whitelist?: {
1513
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1514
- resource: string;
1515
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1516
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1517
- }[];
1518
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1519
- blacklist?: string[];
1520
- };
1521
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1522
- outputNamespaces?: string[];
1523
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1524
- outputResources?: string[];
1525
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1526
- redactSecrets?: boolean;
1527
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1528
- brokerContentDedup?: boolean;
1529
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1530
- debugLogging?: boolean;
1531
- };
1532
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1533
- broker?: {
1534
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1535
- version?: string;
1536
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1537
- replicas?: number;
1538
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1539
- service?: {
1540
- /**
1541
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1542
- * @enum {string}
1543
- */
1544
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1545
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1546
- annotations?: {
1547
- [key: string]: string;
1548
- };
1549
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1550
- loadBalancerClass?: string;
1551
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1552
- loadBalancerSourceRanges?: string[];
1553
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1554
- externalEndpointOverride?: string;
1555
- };
1556
- };
1557
- };
1558
- /**
1559
- * MesheryControllersConfig
1560
- * @description Deployment and runtime configuration for the Meshery controllers that manage a Kubernetes connection: Meshery Operator, MeshSync, and Meshery Broker. The same document shape is used at two layers. As a server-wide default it declares how Meshery Server deploys and configures the controllers for every managed cluster. As a per-connection override, stored in the connection's metadata, it overrides the server-wide default for a single connection. Every configuration field is optional: an absent field inherits the value from the next layer (per-connection override, then server-wide default, then built-in default). The only required field is the server-stamped schemaVersion discriminator, which identifies the document revision for future migrations. Learn more at https://docs.meshery.io/concepts/architecture
1561
- */
1562
- effective: {
1563
- /**
1564
- * @description Specifies the version of the schema used for this configuration document.
1565
- * @default controllers.meshery.io/v1alpha1
1566
- * @example [
1567
- * "v1",
1568
- * "v1alpha1",
1569
- * "v2beta3",
1570
- * "v1.custom-suffix",
1571
- * "models.meshery.io/v1beta1",
1572
- * "capability.meshery.io/v1alpha1"
1573
- * ]
1574
- */
1575
- schemaVersion: string;
1576
- /** @description Configuration for the Meshery Operator on the managed cluster. */
1577
- operator?: {
1578
- /**
1579
- * @description How MeshSync is deployed for the connection. "operator" installs Meshery Operator into the cluster, which runs MeshSync and Meshery Broker there; "embedded" runs MeshSync in-process inside Meshery Server and installs nothing into the cluster.
1580
- * @enum {string}
1581
- */
1582
- deploymentMode?: "operator" | "embedded";
1583
- /** @description Meshery Operator Helm chart version to deploy. When absent, the operator version tracks the Meshery Server release. */
1584
- version?: string;
1585
- };
1586
- /** @description Configuration for the MeshSync agent on the managed cluster. */
1587
- meshsync?: {
1588
- /** @description MeshSync image tag to run (for example "v1.0.2" or "stable-latest"). Applies to operator deployment mode only; in embedded mode MeshSync runs at the version compiled into Meshery Server. Secret redaction and broker content deduplication require MeshSync v1.0.2 or newer. */
1589
- version?: string;
1590
- /** @description Number of MeshSync replicas (MeshSync custom resource spec.size). Applies to operator deployment mode only. */
1591
- replicas?: number;
1592
- /** @description Discovery scope for MeshSync, as a whitelist or a blacklist of Kubernetes resource types. */
1593
- watchList?: {
1594
- /** @description Resource types MeshSync watches, each with the event types to subscribe to. Mutually exclusive with blacklist. */
1595
- whitelist?: {
1596
- /** @description Resource key in "<plural>.<version>.<group>" form (for example "pods.v1." for core-group pods or "deployments.v1.apps"). */
1597
- resource: string;
1598
- /** @description Event types to subscribe to for this resource. Empty or absent subscribes to all event types. */
1599
- events?: ("ADDED" | "MODIFIED" | "DELETED")[];
1600
- }[];
1601
- /** @description Resource types excluded from MeshSync's default discovery scope, in "<plural>.<version>.<group>" form (for example "pods.v1." or "deployments.v1.apps"). Mutually exclusive with whitelist. */
1602
- blacklist?: string[];
1603
- };
1604
- /** @description Namespaces whose resources MeshSync publishes. Empty or absent publishes resources from all namespaces. Discovery scope is unaffected; this filters only what is published. */
1605
- outputNamespaces?: string[];
1606
- /** @description Resource types MeshSync publishes (lowercase Kubernetes kinds, for example "pod" or "deployment"). Empty or absent publishes all discovered resource types. Discovery scope is unaffected; this filters only what is published. */
1607
- outputResources?: string[];
1608
- /** @description When true, MeshSync redacts Kubernetes Secret data values (keys are preserved) before publishing. Requires MeshSync v1.0.2 or newer. Off by default; enabling is recommended when Secrets are within the discovery scope. */
1609
- redactSecrets?: boolean;
1610
- /** @description When true, MeshSync suppresses byte-identical republishes of a resource to the broker. Requires MeshSync v1.0.2 or newer. Off by default. */
1611
- brokerContentDedup?: boolean;
1612
- /** @description When true, MeshSync runs with debug-level logging (DEBUG environment variable). */
1613
- debugLogging?: boolean;
1614
- };
1615
- /** @description Configuration for the Meshery Broker (NATS) on the managed cluster. */
1616
- broker?: {
1617
- /** @description NATS server image tag to run (Broker custom resource spec.version). When absent, the operator's bundled default NATS version is used. */
1618
- version?: string;
1619
- /** @description Number of NATS server replicas (Broker custom resource spec.size). */
1620
- replicas?: number;
1621
- /** @description How the broker is exposed on the network. Service changes reconcile in place without restarting broker pods. */
1622
- service?: {
1623
- /**
1624
- * @description Kubernetes Service type for client access. When absent the broker stays cluster-internal (ClusterIP). LoadBalancer acquires a cloud load-balancer address; NodePort exposes the broker on node IPs.
1625
- * @enum {string}
1626
- */
1627
- type?: "ClusterIP" | "NodePort" | "LoadBalancer";
1628
- /** @description Annotations merged onto the client Service (cloud load-balancer hints, MetalLB address pools, internal-LB switches). */
1629
- annotations?: {
1630
- [key: string]: string;
1631
- };
1632
- /** @description Load-balancer implementation to use. Valid only when type is LoadBalancer. */
1633
- loadBalancerClass?: string;
1634
- /** @description CIDR ranges allowed to reach the broker. Valid only when type is LoadBalancer. */
1635
- loadBalancerSourceRanges?: string[];
1636
- /** @description Pins the advertised external broker endpoint as "host:port" when auto-derivation is undesirable: an ingress or gateway in front of the broker, an air-gapped topology, or NAT. The nats:// scheme is added by consumers. */
1637
- externalEndpointOverride?: string;
1638
- };
1639
- };
1640
- };
1641
- };
1642
- };
1643
- };
1644
- /** @description Invalid request body or request param */
1645
- 400: {
1646
- headers: {
1647
- [name: string]: unknown;
1648
- };
1649
- content: {
1650
- "text/plain": string;
1651
- };
1652
- };
1653
- /** @description Expired JWT token used or insufficient privilege */
1654
- 401: {
1655
- headers: {
1656
- [name: string]: unknown;
1657
- };
1658
- content: {
1659
- "text/plain": string;
1660
- };
1661
- };
1662
- /** @description Result not found */
1663
- 404: {
1664
- headers: {
1665
- [name: string]: unknown;
1666
- };
1667
- content: {
1668
- "text/plain": string;
1669
- };
1670
- };
1671
- /** @description Internal server error */
1672
- 500: {
1673
- headers: {
1674
- [name: string]: unknown;
1675
- };
1676
- content: {
1677
- "text/plain": string;
318
+ "application/json": components["schemas"]["ConnectionControllersConfig"];
1678
319
  };
1679
320
  };
321
+ 400: components["responses"]["400"];
322
+ 401: components["responses"]["401"];
323
+ 404: components["responses"]["404"];
324
+ 500: components["responses"]["500"];
1680
325
  };
1681
326
  };
1682
327
  }