@meshery/schemas 1.3.45 → 1.3.46

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.
@@ -29,13 +29,31 @@ export interface components {
29
29
  /** @description Specifies the version of the relationship definition. */
30
30
  version: string;
31
31
  /**
32
- * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
32
+ * @description Kind of the Relationship. Enum: hierarchical, edge, sibling.
33
+ *
34
+ * hierarchical: parent-child containment, nesting, or inheritance. from is the child; to is the parent.
35
+ * edge: a connection between peers (network, mount, permission, reference, and similar).
36
+ * sibling: schema-native encoding for peer grouping such as tagsets. In-tree Kubernetes models instead encode tagsets as kind=hierarchical, type=sibling, subType=matchlabels. Do not mix the two encodings in one model.
37
+ *
38
+ * Learn more at https://docs.meshery.io/concepts/logical/relationships.
33
39
  * @enum {string}
34
40
  */
35
41
  kind: "hierarchical" | "edge" | "sibling";
36
- /** @description Classification of relationships. Used to group relationships similar in nature. */
42
+ /**
43
+ * @description Classification of relationships. Open string (not an enum). Used with kind and subType to select the visual paradigm and evaluation policy.
44
+ *
45
+ * Canonical values: parent (with kind=hierarchical); binding (assigns, mounts, or entitles); non-binding (real link that does not provision the attachment); sibling (in-tree tagsets with kind=hierarchical); matchlabels (schema-native tagsets with kind=sibling).
46
+ *
47
+ * Copy an established kind/type/subType combination rather than inventing a type. See docs/relationship-definition-taxonomy.md.
48
+ */
37
49
  type: string;
38
- /** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
50
+ /**
51
+ * @description Most granular unit of relationship classification. Open string. Combined with kind and type, uniquely identifies the visual paradigm.
52
+ *
53
+ * Canonical values: inventory, alias, wallet, matchlabels, tagsets, reference, network, firewall, permission, mount, annotation.
54
+ *
55
+ * badge is a visual-paradigm name only; there is no in-tree encoding. Do not invent subType=badge without a visualization and evaluation policy. See docs/relationship-definition-taxonomy.md.
56
+ */
39
57
  subType: string;
40
58
  /**
41
59
  * @description Status of the relationship.
@@ -231,7 +249,7 @@ export interface components {
231
249
  selectors?: {
232
250
  /** @description Selectors used to define relationships which are allowed. */
233
251
  allow: {
234
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
252
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
235
253
  from: {
236
254
  /**
237
255
  * Format: uuid
@@ -253,8 +271,19 @@ export interface components {
253
271
  id?: string;
254
272
  /** @description Kind of the resource. */
255
273
  kind: string;
256
- /** @description JSON ref to value from where patch should be applied. */
274
+ /**
275
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
276
+ *
277
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
278
+ *
279
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
280
+ */
257
281
  mutatorRef?: string[][];
282
+ /**
283
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
284
+ *
285
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
286
+ */
258
287
  mutatedRef?: string[][];
259
288
  }[];
260
289
  /** @description The to of the matchselector. */
@@ -266,8 +295,19 @@ export interface components {
266
295
  id?: string;
267
296
  /** @description Kind of the resource. */
268
297
  kind: string;
269
- /** @description JSON ref to value from where patch should be applied. */
298
+ /**
299
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
300
+ *
301
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
302
+ *
303
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
304
+ */
270
305
  mutatorRef?: string[][];
306
+ /**
307
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
308
+ *
309
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
310
+ */
271
311
  mutatedRef?: string[][];
272
312
  }[];
273
313
  };
@@ -302,7 +342,7 @@ export interface components {
302
342
  kind: string;
303
343
  };
304
344
  };
305
- /** @description Patch configuration for the selector */
345
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
306
346
  patch?: {
307
347
  /**
308
348
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -311,18 +351,30 @@ export interface components {
311
351
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
312
352
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
313
353
  * remove: Removes a value.
354
+ * replace: Replaces the value at the target location.
314
355
  * copy: Copies a value from one location to another.
315
356
  * move: Moves a value from one location to another.
316
357
  * test: Tests that a value at the target location is equal to a specified value.
317
358
  * @enum {string}
318
359
  */
319
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
320
- /** @description JSON ref to value from where patch should be applied. */
360
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
361
+ /**
362
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
363
+ *
364
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
365
+ *
366
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
367
+ */
321
368
  mutatorRef?: string[][];
369
+ /**
370
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
371
+ *
372
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
373
+ */
322
374
  mutatedRef?: string[][];
323
375
  };
324
376
  }[];
325
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
377
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
326
378
  to: {
327
379
  /**
328
380
  * Format: uuid
@@ -344,8 +396,19 @@ export interface components {
344
396
  id?: string;
345
397
  /** @description Kind of the resource. */
346
398
  kind: string;
347
- /** @description JSON ref to value from where patch should be applied. */
399
+ /**
400
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
401
+ *
402
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
403
+ *
404
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
405
+ */
348
406
  mutatorRef?: string[][];
407
+ /**
408
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
409
+ *
410
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
411
+ */
349
412
  mutatedRef?: string[][];
350
413
  }[];
351
414
  /** @description The to of the matchselector. */
@@ -357,8 +420,19 @@ export interface components {
357
420
  id?: string;
358
421
  /** @description Kind of the resource. */
359
422
  kind: string;
360
- /** @description JSON ref to value from where patch should be applied. */
423
+ /**
424
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
425
+ *
426
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
427
+ *
428
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
429
+ */
361
430
  mutatorRef?: string[][];
431
+ /**
432
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
433
+ *
434
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
435
+ */
362
436
  mutatedRef?: string[][];
363
437
  }[];
364
438
  };
@@ -393,7 +467,7 @@ export interface components {
393
467
  kind: string;
394
468
  };
395
469
  };
396
- /** @description Patch configuration for the selector */
470
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
397
471
  patch?: {
398
472
  /**
399
473
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -402,21 +476,33 @@ export interface components {
402
476
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
403
477
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
404
478
  * remove: Removes a value.
479
+ * replace: Replaces the value at the target location.
405
480
  * copy: Copies a value from one location to another.
406
481
  * move: Moves a value from one location to another.
407
482
  * test: Tests that a value at the target location is equal to a specified value.
408
483
  * @enum {string}
409
484
  */
410
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
411
- /** @description JSON ref to value from where patch should be applied. */
485
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
486
+ /**
487
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
488
+ *
489
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
490
+ *
491
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
492
+ */
412
493
  mutatorRef?: string[][];
494
+ /**
495
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
496
+ *
497
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
498
+ */
413
499
  mutatedRef?: string[][];
414
500
  };
415
501
  }[];
416
502
  };
417
503
  /** @description Optional selectors used to define relationships which should not be created / is restricted. */
418
504
  deny?: {
419
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
505
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
420
506
  from: {
421
507
  /**
422
508
  * Format: uuid
@@ -438,8 +524,19 @@ export interface components {
438
524
  id?: string;
439
525
  /** @description Kind of the resource. */
440
526
  kind: string;
441
- /** @description JSON ref to value from where patch should be applied. */
527
+ /**
528
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
529
+ *
530
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
531
+ *
532
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
533
+ */
442
534
  mutatorRef?: string[][];
535
+ /**
536
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
537
+ *
538
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
539
+ */
443
540
  mutatedRef?: string[][];
444
541
  }[];
445
542
  /** @description The to of the matchselector. */
@@ -451,8 +548,19 @@ export interface components {
451
548
  id?: string;
452
549
  /** @description Kind of the resource. */
453
550
  kind: string;
454
- /** @description JSON ref to value from where patch should be applied. */
551
+ /**
552
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
553
+ *
554
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
555
+ *
556
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
557
+ */
455
558
  mutatorRef?: string[][];
559
+ /**
560
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
561
+ *
562
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
563
+ */
456
564
  mutatedRef?: string[][];
457
565
  }[];
458
566
  };
@@ -487,7 +595,7 @@ export interface components {
487
595
  kind: string;
488
596
  };
489
597
  };
490
- /** @description Patch configuration for the selector */
598
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
491
599
  patch?: {
492
600
  /**
493
601
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -496,18 +604,30 @@ export interface components {
496
604
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
497
605
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
498
606
  * remove: Removes a value.
607
+ * replace: Replaces the value at the target location.
499
608
  * copy: Copies a value from one location to another.
500
609
  * move: Moves a value from one location to another.
501
610
  * test: Tests that a value at the target location is equal to a specified value.
502
611
  * @enum {string}
503
612
  */
504
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
505
- /** @description JSON ref to value from where patch should be applied. */
613
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
614
+ /**
615
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
616
+ *
617
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
618
+ *
619
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
620
+ */
506
621
  mutatorRef?: string[][];
622
+ /**
623
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
624
+ *
625
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
626
+ */
507
627
  mutatedRef?: string[][];
508
628
  };
509
629
  }[];
510
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
630
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
511
631
  to: {
512
632
  /**
513
633
  * Format: uuid
@@ -529,8 +649,19 @@ export interface components {
529
649
  id?: string;
530
650
  /** @description Kind of the resource. */
531
651
  kind: string;
532
- /** @description JSON ref to value from where patch should be applied. */
652
+ /**
653
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
654
+ *
655
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
656
+ *
657
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
658
+ */
533
659
  mutatorRef?: string[][];
660
+ /**
661
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
662
+ *
663
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
664
+ */
534
665
  mutatedRef?: string[][];
535
666
  }[];
536
667
  /** @description The to of the matchselector. */
@@ -542,8 +673,19 @@ export interface components {
542
673
  id?: string;
543
674
  /** @description Kind of the resource. */
544
675
  kind: string;
545
- /** @description JSON ref to value from where patch should be applied. */
676
+ /**
677
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
678
+ *
679
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
680
+ *
681
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
682
+ */
546
683
  mutatorRef?: string[][];
684
+ /**
685
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
686
+ *
687
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
688
+ */
547
689
  mutatedRef?: string[][];
548
690
  }[];
549
691
  };
@@ -578,7 +720,7 @@ export interface components {
578
720
  kind: string;
579
721
  };
580
722
  };
581
- /** @description Patch configuration for the selector */
723
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
582
724
  patch?: {
583
725
  /**
584
726
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -587,22 +729,45 @@ export interface components {
587
729
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
588
730
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
589
731
  * remove: Removes a value.
732
+ * replace: Replaces the value at the target location.
590
733
  * copy: Copies a value from one location to another.
591
734
  * move: Moves a value from one location to another.
592
735
  * test: Tests that a value at the target location is equal to a specified value.
593
736
  * @enum {string}
594
737
  */
595
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
596
- /** @description JSON ref to value from where patch should be applied. */
738
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
739
+ /**
740
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
741
+ *
742
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
743
+ *
744
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
745
+ */
597
746
  mutatorRef?: string[][];
747
+ /**
748
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
749
+ *
750
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
751
+ */
598
752
  mutatedRef?: string[][];
599
753
  };
600
754
  }[];
601
755
  };
602
756
  }[];
603
757
  };
604
- /** @description JSON ref to value from where patch should be applied. */
758
+ /**
759
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
760
+ *
761
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
762
+ *
763
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
764
+ */
605
765
  MutatorRef: string[][];
766
+ /**
767
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
768
+ *
769
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
770
+ */
606
771
  MutatedRef: string[][];
607
772
  /**
608
773
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -611,13 +776,14 @@ export interface components {
611
776
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
612
777
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
613
778
  * remove: Removes a value.
779
+ * replace: Replaces the value at the target location.
614
780
  * copy: Copies a value from one location to another.
615
781
  * move: Moves a value from one location to another.
616
782
  * test: Tests that a value at the target location is equal to a specified value.
617
783
  * @enum {string}
618
784
  */
619
- RelationshipDefinitionSelectorsPatchStrategy: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
620
- /** @description Patch configuration for the selector */
785
+ RelationshipDefinitionSelectorsPatchStrategy: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
786
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
621
787
  RelationshipDefinitionSelectorsPatch: {
622
788
  /**
623
789
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -626,14 +792,26 @@ export interface components {
626
792
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
627
793
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
628
794
  * remove: Removes a value.
795
+ * replace: Replaces the value at the target location.
629
796
  * copy: Copies a value from one location to another.
630
797
  * move: Moves a value from one location to another.
631
798
  * test: Tests that a value at the target location is equal to a specified value.
632
799
  * @enum {string}
633
800
  */
634
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
635
- /** @description JSON ref to value from where patch should be applied. */
801
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
802
+ /**
803
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
804
+ *
805
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
806
+ *
807
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
808
+ */
636
809
  mutatorRef?: string[][];
810
+ /**
811
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
812
+ *
813
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
814
+ */
637
815
  mutatedRef?: string[][];
638
816
  };
639
817
  /** @description Match selector item for binding between nodes */
@@ -645,8 +823,19 @@ export interface components {
645
823
  id?: string;
646
824
  /** @description Kind of the resource. */
647
825
  kind: string;
648
- /** @description JSON ref to value from where patch should be applied. */
826
+ /**
827
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
828
+ *
829
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
830
+ *
831
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
832
+ */
649
833
  mutatorRef?: string[][];
834
+ /**
835
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
836
+ *
837
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
838
+ */
650
839
  mutatedRef?: string[][];
651
840
  };
652
841
  /** @description Match configuration for selector */
@@ -662,8 +851,19 @@ export interface components {
662
851
  id?: string;
663
852
  /** @description Kind of the resource. */
664
853
  kind: string;
665
- /** @description JSON ref to value from where patch should be applied. */
854
+ /**
855
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
856
+ *
857
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
858
+ *
859
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
860
+ */
666
861
  mutatorRef?: string[][];
862
+ /**
863
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
864
+ *
865
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
866
+ */
667
867
  mutatedRef?: string[][];
668
868
  }[];
669
869
  /** @description The to of the matchselector. */
@@ -675,8 +875,19 @@ export interface components {
675
875
  id?: string;
676
876
  /** @description Kind of the resource. */
677
877
  kind: string;
678
- /** @description JSON ref to value from where patch should be applied. */
878
+ /**
879
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
880
+ *
881
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
882
+ *
883
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
884
+ */
679
885
  mutatorRef?: string[][];
886
+ /**
887
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
888
+ *
889
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
890
+ */
680
891
  mutatedRef?: string[][];
681
892
  }[];
682
893
  };
@@ -702,8 +913,19 @@ export interface components {
702
913
  id?: string;
703
914
  /** @description Kind of the resource. */
704
915
  kind: string;
705
- /** @description JSON ref to value from where patch should be applied. */
916
+ /**
917
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
918
+ *
919
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
920
+ *
921
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
922
+ */
706
923
  mutatorRef?: string[][];
924
+ /**
925
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
926
+ *
927
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
928
+ */
707
929
  mutatedRef?: string[][];
708
930
  }[];
709
931
  /** @description The to of the matchselector. */
@@ -715,8 +937,19 @@ export interface components {
715
937
  id?: string;
716
938
  /** @description Kind of the resource. */
717
939
  kind: string;
718
- /** @description JSON ref to value from where patch should be applied. */
940
+ /**
941
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
942
+ *
943
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
944
+ *
945
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
946
+ */
719
947
  mutatorRef?: string[][];
948
+ /**
949
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
950
+ *
951
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
952
+ */
720
953
  mutatedRef?: string[][];
721
954
  }[];
722
955
  };
@@ -751,7 +984,7 @@ export interface components {
751
984
  kind: string;
752
985
  };
753
986
  };
754
- /** @description Patch configuration for the selector */
987
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
755
988
  patch?: {
756
989
  /**
757
990
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -760,20 +993,32 @@ export interface components {
760
993
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
761
994
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
762
995
  * remove: Removes a value.
996
+ * replace: Replaces the value at the target location.
763
997
  * copy: Copies a value from one location to another.
764
998
  * move: Moves a value from one location to another.
765
999
  * test: Tests that a value at the target location is equal to a specified value.
766
1000
  * @enum {string}
767
1001
  */
768
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
769
- /** @description JSON ref to value from where patch should be applied. */
1002
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1003
+ /**
1004
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1005
+ *
1006
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1007
+ *
1008
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1009
+ */
770
1010
  mutatorRef?: string[][];
1011
+ /**
1012
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1013
+ *
1014
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1015
+ */
771
1016
  mutatedRef?: string[][];
772
1017
  };
773
1018
  };
774
1019
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
775
1020
  Selector: {
776
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1021
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
777
1022
  from: {
778
1023
  /**
779
1024
  * Format: uuid
@@ -795,8 +1040,19 @@ export interface components {
795
1040
  id?: string;
796
1041
  /** @description Kind of the resource. */
797
1042
  kind: string;
798
- /** @description JSON ref to value from where patch should be applied. */
1043
+ /**
1044
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1045
+ *
1046
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1047
+ *
1048
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1049
+ */
799
1050
  mutatorRef?: string[][];
1051
+ /**
1052
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1053
+ *
1054
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1055
+ */
800
1056
  mutatedRef?: string[][];
801
1057
  }[];
802
1058
  /** @description The to of the matchselector. */
@@ -808,8 +1064,19 @@ export interface components {
808
1064
  id?: string;
809
1065
  /** @description Kind of the resource. */
810
1066
  kind: string;
811
- /** @description JSON ref to value from where patch should be applied. */
1067
+ /**
1068
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1069
+ *
1070
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1071
+ *
1072
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1073
+ */
812
1074
  mutatorRef?: string[][];
1075
+ /**
1076
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1077
+ *
1078
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1079
+ */
813
1080
  mutatedRef?: string[][];
814
1081
  }[];
815
1082
  };
@@ -844,7 +1111,7 @@ export interface components {
844
1111
  kind: string;
845
1112
  };
846
1113
  };
847
- /** @description Patch configuration for the selector */
1114
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
848
1115
  patch?: {
849
1116
  /**
850
1117
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -853,18 +1120,30 @@ export interface components {
853
1120
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
854
1121
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
855
1122
  * remove: Removes a value.
1123
+ * replace: Replaces the value at the target location.
856
1124
  * copy: Copies a value from one location to another.
857
1125
  * move: Moves a value from one location to another.
858
1126
  * test: Tests that a value at the target location is equal to a specified value.
859
1127
  * @enum {string}
860
1128
  */
861
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
862
- /** @description JSON ref to value from where patch should be applied. */
1129
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1130
+ /**
1131
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1132
+ *
1133
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1134
+ *
1135
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1136
+ */
863
1137
  mutatorRef?: string[][];
1138
+ /**
1139
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1140
+ *
1141
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1142
+ */
864
1143
  mutatedRef?: string[][];
865
1144
  };
866
1145
  }[];
867
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1146
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
868
1147
  to: {
869
1148
  /**
870
1149
  * Format: uuid
@@ -886,8 +1165,19 @@ export interface components {
886
1165
  id?: string;
887
1166
  /** @description Kind of the resource. */
888
1167
  kind: string;
889
- /** @description JSON ref to value from where patch should be applied. */
1168
+ /**
1169
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1170
+ *
1171
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1172
+ *
1173
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1174
+ */
890
1175
  mutatorRef?: string[][];
1176
+ /**
1177
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1178
+ *
1179
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1180
+ */
891
1181
  mutatedRef?: string[][];
892
1182
  }[];
893
1183
  /** @description The to of the matchselector. */
@@ -899,8 +1189,19 @@ export interface components {
899
1189
  id?: string;
900
1190
  /** @description Kind of the resource. */
901
1191
  kind: string;
902
- /** @description JSON ref to value from where patch should be applied. */
1192
+ /**
1193
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1194
+ *
1195
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1196
+ *
1197
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1198
+ */
903
1199
  mutatorRef?: string[][];
1200
+ /**
1201
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1202
+ *
1203
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1204
+ */
904
1205
  mutatedRef?: string[][];
905
1206
  }[];
906
1207
  };
@@ -935,7 +1236,7 @@ export interface components {
935
1236
  kind: string;
936
1237
  };
937
1238
  };
938
- /** @description Patch configuration for the selector */
1239
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
939
1240
  patch?: {
940
1241
  /**
941
1242
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -944,14 +1245,26 @@ export interface components {
944
1245
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
945
1246
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
946
1247
  * remove: Removes a value.
1248
+ * replace: Replaces the value at the target location.
947
1249
  * copy: Copies a value from one location to another.
948
1250
  * move: Moves a value from one location to another.
949
1251
  * test: Tests that a value at the target location is equal to a specified value.
950
1252
  * @enum {string}
951
1253
  */
952
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
953
- /** @description JSON ref to value from where patch should be applied. */
1254
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1255
+ /**
1256
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1257
+ *
1258
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1259
+ *
1260
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1261
+ */
954
1262
  mutatorRef?: string[][];
1263
+ /**
1264
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1265
+ *
1266
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1267
+ */
955
1268
  mutatedRef?: string[][];
956
1269
  };
957
1270
  }[];
@@ -960,7 +1273,7 @@ export interface components {
960
1273
  SelectorSetItem: {
961
1274
  /** @description Selectors used to define relationships which are allowed. */
962
1275
  allow: {
963
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1276
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
964
1277
  from: {
965
1278
  /**
966
1279
  * Format: uuid
@@ -982,8 +1295,19 @@ export interface components {
982
1295
  id?: string;
983
1296
  /** @description Kind of the resource. */
984
1297
  kind: string;
985
- /** @description JSON ref to value from where patch should be applied. */
1298
+ /**
1299
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1300
+ *
1301
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1302
+ *
1303
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1304
+ */
986
1305
  mutatorRef?: string[][];
1306
+ /**
1307
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1308
+ *
1309
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1310
+ */
987
1311
  mutatedRef?: string[][];
988
1312
  }[];
989
1313
  /** @description The to of the matchselector. */
@@ -995,8 +1319,19 @@ export interface components {
995
1319
  id?: string;
996
1320
  /** @description Kind of the resource. */
997
1321
  kind: string;
998
- /** @description JSON ref to value from where patch should be applied. */
1322
+ /**
1323
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1324
+ *
1325
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1326
+ *
1327
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1328
+ */
999
1329
  mutatorRef?: string[][];
1330
+ /**
1331
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1332
+ *
1333
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1334
+ */
1000
1335
  mutatedRef?: string[][];
1001
1336
  }[];
1002
1337
  };
@@ -1031,7 +1366,7 @@ export interface components {
1031
1366
  kind: string;
1032
1367
  };
1033
1368
  };
1034
- /** @description Patch configuration for the selector */
1369
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1035
1370
  patch?: {
1036
1371
  /**
1037
1372
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1040,18 +1375,30 @@ export interface components {
1040
1375
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1041
1376
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1042
1377
  * remove: Removes a value.
1378
+ * replace: Replaces the value at the target location.
1043
1379
  * copy: Copies a value from one location to another.
1044
1380
  * move: Moves a value from one location to another.
1045
1381
  * test: Tests that a value at the target location is equal to a specified value.
1046
1382
  * @enum {string}
1047
1383
  */
1048
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1049
- /** @description JSON ref to value from where patch should be applied. */
1384
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1385
+ /**
1386
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1387
+ *
1388
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1389
+ *
1390
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1391
+ */
1050
1392
  mutatorRef?: string[][];
1393
+ /**
1394
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1395
+ *
1396
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1397
+ */
1051
1398
  mutatedRef?: string[][];
1052
1399
  };
1053
1400
  }[];
1054
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1401
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
1055
1402
  to: {
1056
1403
  /**
1057
1404
  * Format: uuid
@@ -1073,8 +1420,19 @@ export interface components {
1073
1420
  id?: string;
1074
1421
  /** @description Kind of the resource. */
1075
1422
  kind: string;
1076
- /** @description JSON ref to value from where patch should be applied. */
1423
+ /**
1424
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1425
+ *
1426
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1427
+ *
1428
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1429
+ */
1077
1430
  mutatorRef?: string[][];
1431
+ /**
1432
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1433
+ *
1434
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1435
+ */
1078
1436
  mutatedRef?: string[][];
1079
1437
  }[];
1080
1438
  /** @description The to of the matchselector. */
@@ -1086,8 +1444,19 @@ export interface components {
1086
1444
  id?: string;
1087
1445
  /** @description Kind of the resource. */
1088
1446
  kind: string;
1089
- /** @description JSON ref to value from where patch should be applied. */
1447
+ /**
1448
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1449
+ *
1450
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1451
+ *
1452
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1453
+ */
1090
1454
  mutatorRef?: string[][];
1455
+ /**
1456
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1457
+ *
1458
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1459
+ */
1091
1460
  mutatedRef?: string[][];
1092
1461
  }[];
1093
1462
  };
@@ -1122,7 +1491,7 @@ export interface components {
1122
1491
  kind: string;
1123
1492
  };
1124
1493
  };
1125
- /** @description Patch configuration for the selector */
1494
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1126
1495
  patch?: {
1127
1496
  /**
1128
1497
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1131,21 +1500,33 @@ export interface components {
1131
1500
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1132
1501
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1133
1502
  * remove: Removes a value.
1503
+ * replace: Replaces the value at the target location.
1134
1504
  * copy: Copies a value from one location to another.
1135
1505
  * move: Moves a value from one location to another.
1136
1506
  * test: Tests that a value at the target location is equal to a specified value.
1137
1507
  * @enum {string}
1138
1508
  */
1139
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1140
- /** @description JSON ref to value from where patch should be applied. */
1509
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1510
+ /**
1511
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1512
+ *
1513
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1514
+ *
1515
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1516
+ */
1141
1517
  mutatorRef?: string[][];
1518
+ /**
1519
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1520
+ *
1521
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1522
+ */
1142
1523
  mutatedRef?: string[][];
1143
1524
  };
1144
1525
  }[];
1145
1526
  };
1146
1527
  /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1147
1528
  deny?: {
1148
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1529
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
1149
1530
  from: {
1150
1531
  /**
1151
1532
  * Format: uuid
@@ -1167,8 +1548,19 @@ export interface components {
1167
1548
  id?: string;
1168
1549
  /** @description Kind of the resource. */
1169
1550
  kind: string;
1170
- /** @description JSON ref to value from where patch should be applied. */
1551
+ /**
1552
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1553
+ *
1554
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1555
+ *
1556
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1557
+ */
1171
1558
  mutatorRef?: string[][];
1559
+ /**
1560
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1561
+ *
1562
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1563
+ */
1172
1564
  mutatedRef?: string[][];
1173
1565
  }[];
1174
1566
  /** @description The to of the matchselector. */
@@ -1180,8 +1572,19 @@ export interface components {
1180
1572
  id?: string;
1181
1573
  /** @description Kind of the resource. */
1182
1574
  kind: string;
1183
- /** @description JSON ref to value from where patch should be applied. */
1575
+ /**
1576
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1577
+ *
1578
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1579
+ *
1580
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1581
+ */
1184
1582
  mutatorRef?: string[][];
1583
+ /**
1584
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1585
+ *
1586
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1587
+ */
1185
1588
  mutatedRef?: string[][];
1186
1589
  }[];
1187
1590
  };
@@ -1216,7 +1619,7 @@ export interface components {
1216
1619
  kind: string;
1217
1620
  };
1218
1621
  };
1219
- /** @description Patch configuration for the selector */
1622
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1220
1623
  patch?: {
1221
1624
  /**
1222
1625
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1225,18 +1628,30 @@ export interface components {
1225
1628
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1226
1629
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1227
1630
  * remove: Removes a value.
1631
+ * replace: Replaces the value at the target location.
1228
1632
  * copy: Copies a value from one location to another.
1229
1633
  * move: Moves a value from one location to another.
1230
1634
  * test: Tests that a value at the target location is equal to a specified value.
1231
1635
  * @enum {string}
1232
1636
  */
1233
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1234
- /** @description JSON ref to value from where patch should be applied. */
1637
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1638
+ /**
1639
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1640
+ *
1641
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1642
+ *
1643
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1644
+ */
1235
1645
  mutatorRef?: string[][];
1646
+ /**
1647
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1648
+ *
1649
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1650
+ */
1236
1651
  mutatedRef?: string[][];
1237
1652
  };
1238
1653
  }[];
1239
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1654
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
1240
1655
  to: {
1241
1656
  /**
1242
1657
  * Format: uuid
@@ -1258,8 +1673,19 @@ export interface components {
1258
1673
  id?: string;
1259
1674
  /** @description Kind of the resource. */
1260
1675
  kind: string;
1261
- /** @description JSON ref to value from where patch should be applied. */
1676
+ /**
1677
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1678
+ *
1679
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1680
+ *
1681
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1682
+ */
1262
1683
  mutatorRef?: string[][];
1684
+ /**
1685
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1686
+ *
1687
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1688
+ */
1263
1689
  mutatedRef?: string[][];
1264
1690
  }[];
1265
1691
  /** @description The to of the matchselector. */
@@ -1271,8 +1697,19 @@ export interface components {
1271
1697
  id?: string;
1272
1698
  /** @description Kind of the resource. */
1273
1699
  kind: string;
1274
- /** @description JSON ref to value from where patch should be applied. */
1700
+ /**
1701
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1702
+ *
1703
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1704
+ *
1705
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1706
+ */
1275
1707
  mutatorRef?: string[][];
1708
+ /**
1709
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1710
+ *
1711
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1712
+ */
1276
1713
  mutatedRef?: string[][];
1277
1714
  }[];
1278
1715
  };
@@ -1307,7 +1744,7 @@ export interface components {
1307
1744
  kind: string;
1308
1745
  };
1309
1746
  };
1310
- /** @description Patch configuration for the selector */
1747
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1311
1748
  patch?: {
1312
1749
  /**
1313
1750
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1316,14 +1753,26 @@ export interface components {
1316
1753
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1317
1754
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1318
1755
  * remove: Removes a value.
1756
+ * replace: Replaces the value at the target location.
1319
1757
  * copy: Copies a value from one location to another.
1320
1758
  * move: Moves a value from one location to another.
1321
1759
  * test: Tests that a value at the target location is equal to a specified value.
1322
1760
  * @enum {string}
1323
1761
  */
1324
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1325
- /** @description JSON ref to value from where patch should be applied. */
1762
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1763
+ /**
1764
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1765
+ *
1766
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1767
+ *
1768
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1769
+ */
1326
1770
  mutatorRef?: string[][];
1771
+ /**
1772
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1773
+ *
1774
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1775
+ */
1327
1776
  mutatedRef?: string[][];
1328
1777
  };
1329
1778
  }[];
@@ -1333,7 +1782,7 @@ export interface components {
1333
1782
  SelectorSet: {
1334
1783
  /** @description Selectors used to define relationships which are allowed. */
1335
1784
  allow: {
1336
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1785
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
1337
1786
  from: {
1338
1787
  /**
1339
1788
  * Format: uuid
@@ -1355,8 +1804,19 @@ export interface components {
1355
1804
  id?: string;
1356
1805
  /** @description Kind of the resource. */
1357
1806
  kind: string;
1358
- /** @description JSON ref to value from where patch should be applied. */
1807
+ /**
1808
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1809
+ *
1810
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1811
+ *
1812
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1813
+ */
1359
1814
  mutatorRef?: string[][];
1815
+ /**
1816
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1817
+ *
1818
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1819
+ */
1360
1820
  mutatedRef?: string[][];
1361
1821
  }[];
1362
1822
  /** @description The to of the matchselector. */
@@ -1368,8 +1828,19 @@ export interface components {
1368
1828
  id?: string;
1369
1829
  /** @description Kind of the resource. */
1370
1830
  kind: string;
1371
- /** @description JSON ref to value from where patch should be applied. */
1831
+ /**
1832
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1833
+ *
1834
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1835
+ *
1836
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1837
+ */
1372
1838
  mutatorRef?: string[][];
1839
+ /**
1840
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1841
+ *
1842
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1843
+ */
1373
1844
  mutatedRef?: string[][];
1374
1845
  }[];
1375
1846
  };
@@ -1404,7 +1875,7 @@ export interface components {
1404
1875
  kind: string;
1405
1876
  };
1406
1877
  };
1407
- /** @description Patch configuration for the selector */
1878
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1408
1879
  patch?: {
1409
1880
  /**
1410
1881
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1413,18 +1884,30 @@ export interface components {
1413
1884
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1414
1885
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1415
1886
  * remove: Removes a value.
1887
+ * replace: Replaces the value at the target location.
1416
1888
  * copy: Copies a value from one location to another.
1417
1889
  * move: Moves a value from one location to another.
1418
1890
  * test: Tests that a value at the target location is equal to a specified value.
1419
1891
  * @enum {string}
1420
1892
  */
1421
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1422
- /** @description JSON ref to value from where patch should be applied. */
1893
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1894
+ /**
1895
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1896
+ *
1897
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1898
+ *
1899
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1900
+ */
1423
1901
  mutatorRef?: string[][];
1902
+ /**
1903
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1904
+ *
1905
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1906
+ */
1424
1907
  mutatedRef?: string[][];
1425
1908
  };
1426
1909
  }[];
1427
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1910
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
1428
1911
  to: {
1429
1912
  /**
1430
1913
  * Format: uuid
@@ -1446,8 +1929,19 @@ export interface components {
1446
1929
  id?: string;
1447
1930
  /** @description Kind of the resource. */
1448
1931
  kind: string;
1449
- /** @description JSON ref to value from where patch should be applied. */
1932
+ /**
1933
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1934
+ *
1935
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1936
+ *
1937
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1938
+ */
1450
1939
  mutatorRef?: string[][];
1940
+ /**
1941
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1942
+ *
1943
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1944
+ */
1451
1945
  mutatedRef?: string[][];
1452
1946
  }[];
1453
1947
  /** @description The to of the matchselector. */
@@ -1459,8 +1953,19 @@ export interface components {
1459
1953
  id?: string;
1460
1954
  /** @description Kind of the resource. */
1461
1955
  kind: string;
1462
- /** @description JSON ref to value from where patch should be applied. */
1956
+ /**
1957
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
1958
+ *
1959
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
1960
+ *
1961
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
1962
+ */
1463
1963
  mutatorRef?: string[][];
1964
+ /**
1965
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
1966
+ *
1967
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
1968
+ */
1464
1969
  mutatedRef?: string[][];
1465
1970
  }[];
1466
1971
  };
@@ -1495,7 +2000,7 @@ export interface components {
1495
2000
  kind: string;
1496
2001
  };
1497
2002
  };
1498
- /** @description Patch configuration for the selector */
2003
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1499
2004
  patch?: {
1500
2005
  /**
1501
2006
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1504,21 +2009,33 @@ export interface components {
1504
2009
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1505
2010
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1506
2011
  * remove: Removes a value.
2012
+ * replace: Replaces the value at the target location.
1507
2013
  * copy: Copies a value from one location to another.
1508
2014
  * move: Moves a value from one location to another.
1509
2015
  * test: Tests that a value at the target location is equal to a specified value.
1510
2016
  * @enum {string}
1511
2017
  */
1512
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1513
- /** @description JSON ref to value from where patch should be applied. */
2018
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
2019
+ /**
2020
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2021
+ *
2022
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2023
+ *
2024
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2025
+ */
1514
2026
  mutatorRef?: string[][];
2027
+ /**
2028
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2029
+ *
2030
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2031
+ */
1515
2032
  mutatedRef?: string[][];
1516
2033
  };
1517
2034
  }[];
1518
2035
  };
1519
2036
  /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1520
2037
  deny?: {
1521
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
2038
+ /** @description Originator side of the selector. For kind=hierarchical, from is the child. Each from item relates to each to item in the same selector (1:many). */
1522
2039
  from: {
1523
2040
  /**
1524
2041
  * Format: uuid
@@ -1540,8 +2057,19 @@ export interface components {
1540
2057
  id?: string;
1541
2058
  /** @description Kind of the resource. */
1542
2059
  kind: string;
1543
- /** @description JSON ref to value from where patch should be applied. */
2060
+ /**
2061
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2062
+ *
2063
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2064
+ *
2065
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2066
+ */
1544
2067
  mutatorRef?: string[][];
2068
+ /**
2069
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2070
+ *
2071
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2072
+ */
1545
2073
  mutatedRef?: string[][];
1546
2074
  }[];
1547
2075
  /** @description The to of the matchselector. */
@@ -1553,8 +2081,19 @@ export interface components {
1553
2081
  id?: string;
1554
2082
  /** @description Kind of the resource. */
1555
2083
  kind: string;
1556
- /** @description JSON ref to value from where patch should be applied. */
2084
+ /**
2085
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2086
+ *
2087
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2088
+ *
2089
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2090
+ */
1557
2091
  mutatorRef?: string[][];
2092
+ /**
2093
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2094
+ *
2095
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2096
+ */
1558
2097
  mutatedRef?: string[][];
1559
2098
  }[];
1560
2099
  };
@@ -1589,7 +2128,7 @@ export interface components {
1589
2128
  kind: string;
1590
2129
  };
1591
2130
  };
1592
- /** @description Patch configuration for the selector */
2131
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1593
2132
  patch?: {
1594
2133
  /**
1595
2134
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1598,18 +2137,30 @@ export interface components {
1598
2137
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1599
2138
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1600
2139
  * remove: Removes a value.
2140
+ * replace: Replaces the value at the target location.
1601
2141
  * copy: Copies a value from one location to another.
1602
2142
  * move: Moves a value from one location to another.
1603
2143
  * test: Tests that a value at the target location is equal to a specified value.
1604
2144
  * @enum {string}
1605
2145
  */
1606
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1607
- /** @description JSON ref to value from where patch should be applied. */
2146
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
2147
+ /**
2148
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2149
+ *
2150
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2151
+ *
2152
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2153
+ */
1608
2154
  mutatorRef?: string[][];
2155
+ /**
2156
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2157
+ *
2158
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2159
+ */
1609
2160
  mutatedRef?: string[][];
1610
2161
  };
1611
2162
  }[];
1612
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
2163
+ /** @description Destination side of the selector. For kind=hierarchical, to is the parent. */
1613
2164
  to: {
1614
2165
  /**
1615
2166
  * Format: uuid
@@ -1631,8 +2182,19 @@ export interface components {
1631
2182
  id?: string;
1632
2183
  /** @description Kind of the resource. */
1633
2184
  kind: string;
1634
- /** @description JSON ref to value from where patch should be applied. */
2185
+ /**
2186
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2187
+ *
2188
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2189
+ *
2190
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2191
+ */
1635
2192
  mutatorRef?: string[][];
2193
+ /**
2194
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2195
+ *
2196
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2197
+ */
1636
2198
  mutatedRef?: string[][];
1637
2199
  }[];
1638
2200
  /** @description The to of the matchselector. */
@@ -1644,8 +2206,19 @@ export interface components {
1644
2206
  id?: string;
1645
2207
  /** @description Kind of the resource. */
1646
2208
  kind: string;
1647
- /** @description JSON ref to value from where patch should be applied. */
2209
+ /**
2210
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2211
+ *
2212
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2213
+ *
2214
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2215
+ */
1648
2216
  mutatorRef?: string[][];
2217
+ /**
2218
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2219
+ *
2220
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2221
+ */
1649
2222
  mutatedRef?: string[][];
1650
2223
  }[];
1651
2224
  };
@@ -1680,7 +2253,7 @@ export interface components {
1680
2253
  kind: string;
1681
2254
  };
1682
2255
  };
1683
- /** @description Patch configuration for the selector */
2256
+ /** @description Patch configuration for a matched selector. mutatorRef is the value source; mutatedRef is the value sink. Sequence lengths must match, and the two sequences pair across the related selector items - the source paths on one item feed the sink paths on the related item of the other side, index by index. Omit this object when the relationship only matches. */
1684
2257
  patch?: {
1685
2258
  /**
1686
2259
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1689,14 +2262,26 @@ export interface components {
1689
2262
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1690
2263
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1691
2264
  * remove: Removes a value.
2265
+ * replace: Replaces the value at the target location.
1692
2266
  * copy: Copies a value from one location to another.
1693
2267
  * move: Moves a value from one location to another.
1694
2268
  * test: Tests that a value at the target location is equal to a specified value.
1695
2269
  * @enum {string}
1696
2270
  */
1697
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1698
- /** @description JSON ref to value from where patch should be applied. */
2271
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
2272
+ /**
2273
+ * @description Source of a patch: nested JSON path segments of the value to read. Pair with mutatedRef; sequences must be the same length. Index i of mutatorRef is copied onto index i of mutatedRef.
2274
+ *
2275
+ * The pairing spans the two related selector items: a mutatorRef on one side (commonly the `from` item) supplies values to the mutatedRef on the related item of the other side, entry by entry, by index. Each path resolves relative to its own selector item's component document.
2276
+ *
2277
+ * Example: mutatorRef [[config, url], [config, name]] patches onto mutatedRef [[configPatch, value], [name]]. Paths are relative to the Meshery component document (configuration, displayName, component.kind), not raw Kubernetes YAML. "_" may mark only the first array position in a path.
2278
+ */
1699
2279
  mutatorRef?: string[][];
2280
+ /**
2281
+ * @description Sink of a patch: nested JSON path segments (JSONPath) of the field to write. Pair with mutatorRef; sequences must be the same length. The mutatorRef it pairs with lives on the related selector item of the other side, and each path resolves relative to its own selector item's component document.
2282
+ *
2283
+ * mutatedRef currently does not support patching an array value itself. Omit patch entirely when the relationship only matches (tagsets, annotation).
2284
+ */
1700
2285
  mutatedRef?: string[][];
1701
2286
  };
1702
2287
  }[];