@meshery/schemas 1.3.44 → 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.
Files changed (35) hide show
  1. package/dist/cloudApi.d.mts +882 -4
  2. package/dist/cloudApi.d.ts +882 -4
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +1424 -3
  6. package/dist/constructs/v1beta1/pattern/PatternSchema.js +49 -1
  7. package/dist/constructs/v1beta1/pattern/PatternSchema.mjs +49 -1
  8. package/dist/constructs/v1beta2/design/Design.d.ts +1557 -47
  9. package/dist/constructs/v1beta2/design/DesignSchema.js +137 -45
  10. package/dist/constructs/v1beta2/design/DesignSchema.mjs +137 -45
  11. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +34 -17
  12. package/dist/constructs/v1beta2/relationship/RelationshipSchema.js +34 -17
  13. package/dist/constructs/v1beta2/relationship/RelationshipSchema.mjs +34 -17
  14. package/dist/constructs/v1beta3/design/Design.d.ts +371 -7
  15. package/dist/constructs/v1beta3/design/DesignSchema.js +14 -5
  16. package/dist/constructs/v1beta3/design/DesignSchema.mjs +14 -5
  17. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +685 -100
  18. package/dist/constructs/v1beta3/relationship/RelationshipSchema.js +468 -18
  19. package/dist/constructs/v1beta3/relationship/RelationshipSchema.mjs +468 -18
  20. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +436 -0
  21. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.js +1 -1
  22. package/dist/constructs/v1beta3/subscription/SubscriptionSchema.mjs +1 -1
  23. package/dist/index.d.mts +74 -37
  24. package/dist/index.d.ts +74 -37
  25. package/dist/index.js +226 -69
  26. package/dist/index.mjs +226 -69
  27. package/dist/mesheryApi.d.mts +235 -3
  28. package/dist/mesheryApi.d.ts +235 -3
  29. package/dist/mesheryApi.js +1 -1
  30. package/dist/mesheryApi.mjs +1 -1
  31. package/dist/permissions.d.mts +71 -1
  32. package/dist/permissions.d.ts +71 -1
  33. package/dist/permissions.js +1 -1
  34. package/dist/permissions.mjs +1 -1
  35. package/package.json +2 -2
@@ -1527,12 +1527,13 @@ export interface components {
1527
1527
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1528
1528
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1529
1529
  * remove: Removes a value.
1530
+ * replace: Replaces the value at the target location.
1530
1531
  * copy: Copies a value from one location to another.
1531
1532
  * move: Moves a value from one location to another.
1532
1533
  * test: Tests that a value at the target location is equal to a specified value.
1533
1534
  * @enum {string}
1534
1535
  */
1535
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1536
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1536
1537
  /** @description JSON ref to value from where patch should be applied. */
1537
1538
  mutatorRef?: string[][];
1538
1539
  mutatedRef?: string[][];
@@ -1618,12 +1619,13 @@ export interface components {
1618
1619
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1619
1620
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1620
1621
  * remove: Removes a value.
1622
+ * replace: Replaces the value at the target location.
1621
1623
  * copy: Copies a value from one location to another.
1622
1624
  * move: Moves a value from one location to another.
1623
1625
  * test: Tests that a value at the target location is equal to a specified value.
1624
1626
  * @enum {string}
1625
1627
  */
1626
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1628
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1627
1629
  /** @description JSON ref to value from where patch should be applied. */
1628
1630
  mutatorRef?: string[][];
1629
1631
  mutatedRef?: string[][];
@@ -1712,12 +1714,13 @@ export interface components {
1712
1714
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1713
1715
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1714
1716
  * remove: Removes a value.
1717
+ * replace: Replaces the value at the target location.
1715
1718
  * copy: Copies a value from one location to another.
1716
1719
  * move: Moves a value from one location to another.
1717
1720
  * test: Tests that a value at the target location is equal to a specified value.
1718
1721
  * @enum {string}
1719
1722
  */
1720
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1723
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1721
1724
  /** @description JSON ref to value from where patch should be applied. */
1722
1725
  mutatorRef?: string[][];
1723
1726
  mutatedRef?: string[][];
@@ -1803,12 +1806,13 @@ export interface components {
1803
1806
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1804
1807
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1805
1808
  * remove: Removes a value.
1809
+ * replace: Replaces the value at the target location.
1806
1810
  * copy: Copies a value from one location to another.
1807
1811
  * move: Moves a value from one location to another.
1808
1812
  * test: Tests that a value at the target location is equal to a specified value.
1809
1813
  * @enum {string}
1810
1814
  */
1811
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1815
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
1812
1816
  /** @description JSON ref to value from where patch should be applied. */
1813
1817
  mutatorRef?: string[][];
1814
1818
  mutatedRef?: string[][];
@@ -2986,12 +2990,13 @@ export interface components {
2986
2990
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
2987
2991
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
2988
2992
  * remove: Removes a value.
2993
+ * replace: Replaces the value at the target location.
2989
2994
  * copy: Copies a value from one location to another.
2990
2995
  * move: Moves a value from one location to another.
2991
2996
  * test: Tests that a value at the target location is equal to a specified value.
2992
2997
  * @enum {string}
2993
2998
  */
2994
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
2999
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
2995
3000
  /** @description JSON ref to value from where patch should be applied. */
2996
3001
  mutatorRef?: string[][];
2997
3002
  mutatedRef?: string[][];
@@ -3077,12 +3082,13 @@ export interface components {
3077
3082
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
3078
3083
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
3079
3084
  * remove: Removes a value.
3085
+ * replace: Replaces the value at the target location.
3080
3086
  * copy: Copies a value from one location to another.
3081
3087
  * move: Moves a value from one location to another.
3082
3088
  * test: Tests that a value at the target location is equal to a specified value.
3083
3089
  * @enum {string}
3084
3090
  */
3085
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
3091
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
3086
3092
  /** @description JSON ref to value from where patch should be applied. */
3087
3093
  mutatorRef?: string[][];
3088
3094
  mutatedRef?: string[][];
@@ -3171,12 +3177,13 @@ export interface components {
3171
3177
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
3172
3178
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
3173
3179
  * remove: Removes a value.
3180
+ * replace: Replaces the value at the target location.
3174
3181
  * copy: Copies a value from one location to another.
3175
3182
  * move: Moves a value from one location to another.
3176
3183
  * test: Tests that a value at the target location is equal to a specified value.
3177
3184
  * @enum {string}
3178
3185
  */
3179
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
3186
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
3180
3187
  /** @description JSON ref to value from where patch should be applied. */
3181
3188
  mutatorRef?: string[][];
3182
3189
  mutatedRef?: string[][];
@@ -3262,12 +3269,13 @@ export interface components {
3262
3269
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
3263
3270
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
3264
3271
  * remove: Removes a value.
3272
+ * replace: Replaces the value at the target location.
3265
3273
  * copy: Copies a value from one location to another.
3266
3274
  * move: Moves a value from one location to another.
3267
3275
  * test: Tests that a value at the target location is equal to a specified value.
3268
3276
  * @enum {string}
3269
3277
  */
3270
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
3278
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
3271
3279
  /** @description JSON ref to value from where patch should be applied. */
3272
3280
  mutatorRef?: string[][];
3273
3281
  mutatedRef?: string[][];
@@ -4457,12 +4465,13 @@ export interface components {
4457
4465
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4458
4466
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4459
4467
  * remove: Removes a value.
4468
+ * replace: Replaces the value at the target location.
4460
4469
  * copy: Copies a value from one location to another.
4461
4470
  * move: Moves a value from one location to another.
4462
4471
  * test: Tests that a value at the target location is equal to a specified value.
4463
4472
  * @enum {string}
4464
4473
  */
4465
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4474
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
4466
4475
  /** @description JSON ref to value from where patch should be applied. */
4467
4476
  mutatorRef?: string[][];
4468
4477
  mutatedRef?: string[][];
@@ -4548,12 +4557,13 @@ export interface components {
4548
4557
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4549
4558
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4550
4559
  * remove: Removes a value.
4560
+ * replace: Replaces the value at the target location.
4551
4561
  * copy: Copies a value from one location to another.
4552
4562
  * move: Moves a value from one location to another.
4553
4563
  * test: Tests that a value at the target location is equal to a specified value.
4554
4564
  * @enum {string}
4555
4565
  */
4556
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4566
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
4557
4567
  /** @description JSON ref to value from where patch should be applied. */
4558
4568
  mutatorRef?: string[][];
4559
4569
  mutatedRef?: string[][];
@@ -4642,12 +4652,13 @@ export interface components {
4642
4652
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4643
4653
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4644
4654
  * remove: Removes a value.
4655
+ * replace: Replaces the value at the target location.
4645
4656
  * copy: Copies a value from one location to another.
4646
4657
  * move: Moves a value from one location to another.
4647
4658
  * test: Tests that a value at the target location is equal to a specified value.
4648
4659
  * @enum {string}
4649
4660
  */
4650
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4661
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
4651
4662
  /** @description JSON ref to value from where patch should be applied. */
4652
4663
  mutatorRef?: string[][];
4653
4664
  mutatedRef?: string[][];
@@ -4733,12 +4744,13 @@ export interface components {
4733
4744
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4734
4745
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4735
4746
  * remove: Removes a value.
4747
+ * replace: Replaces the value at the target location.
4736
4748
  * copy: Copies a value from one location to another.
4737
4749
  * move: Moves a value from one location to another.
4738
4750
  * test: Tests that a value at the target location is equal to a specified value.
4739
4751
  * @enum {string}
4740
4752
  */
4741
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4753
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
4742
4754
  /** @description JSON ref to value from where patch should be applied. */
4743
4755
  mutatorRef?: string[][];
4744
4756
  mutatedRef?: string[][];
@@ -5937,12 +5949,13 @@ export interface components {
5937
5949
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
5938
5950
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
5939
5951
  * remove: Removes a value.
5952
+ * replace: Replaces the value at the target location.
5940
5953
  * copy: Copies a value from one location to another.
5941
5954
  * move: Moves a value from one location to another.
5942
5955
  * test: Tests that a value at the target location is equal to a specified value.
5943
5956
  * @enum {string}
5944
5957
  */
5945
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
5958
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
5946
5959
  /** @description JSON ref to value from where patch should be applied. */
5947
5960
  mutatorRef?: string[][];
5948
5961
  mutatedRef?: string[][];
@@ -6028,12 +6041,13 @@ export interface components {
6028
6041
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
6029
6042
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
6030
6043
  * remove: Removes a value.
6044
+ * replace: Replaces the value at the target location.
6031
6045
  * copy: Copies a value from one location to another.
6032
6046
  * move: Moves a value from one location to another.
6033
6047
  * test: Tests that a value at the target location is equal to a specified value.
6034
6048
  * @enum {string}
6035
6049
  */
6036
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
6050
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
6037
6051
  /** @description JSON ref to value from where patch should be applied. */
6038
6052
  mutatorRef?: string[][];
6039
6053
  mutatedRef?: string[][];
@@ -6122,12 +6136,13 @@ export interface components {
6122
6136
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
6123
6137
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
6124
6138
  * remove: Removes a value.
6139
+ * replace: Replaces the value at the target location.
6125
6140
  * copy: Copies a value from one location to another.
6126
6141
  * move: Moves a value from one location to another.
6127
6142
  * test: Tests that a value at the target location is equal to a specified value.
6128
6143
  * @enum {string}
6129
6144
  */
6130
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
6145
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
6131
6146
  /** @description JSON ref to value from where patch should be applied. */
6132
6147
  mutatorRef?: string[][];
6133
6148
  mutatedRef?: string[][];
@@ -6213,12 +6228,13 @@ export interface components {
6213
6228
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
6214
6229
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
6215
6230
  * remove: Removes a value.
6231
+ * replace: Replaces the value at the target location.
6216
6232
  * copy: Copies a value from one location to another.
6217
6233
  * move: Moves a value from one location to another.
6218
6234
  * test: Tests that a value at the target location is equal to a specified value.
6219
6235
  * @enum {string}
6220
6236
  */
6221
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
6237
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
6222
6238
  /** @description JSON ref to value from where patch should be applied. */
6223
6239
  mutatorRef?: string[][];
6224
6240
  mutatedRef?: string[][];
@@ -7488,12 +7504,13 @@ export interface components {
7488
7504
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
7489
7505
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
7490
7506
  * remove: Removes a value.
7507
+ * replace: Replaces the value at the target location.
7491
7508
  * copy: Copies a value from one location to another.
7492
7509
  * move: Moves a value from one location to another.
7493
7510
  * test: Tests that a value at the target location is equal to a specified value.
7494
7511
  * @enum {string}
7495
7512
  */
7496
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
7513
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
7497
7514
  /** @description JSON ref to value from where patch should be applied. */
7498
7515
  mutatorRef?: string[][];
7499
7516
  mutatedRef?: string[][];
@@ -7579,12 +7596,13 @@ export interface components {
7579
7596
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
7580
7597
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
7581
7598
  * remove: Removes a value.
7599
+ * replace: Replaces the value at the target location.
7582
7600
  * copy: Copies a value from one location to another.
7583
7601
  * move: Moves a value from one location to another.
7584
7602
  * test: Tests that a value at the target location is equal to a specified value.
7585
7603
  * @enum {string}
7586
7604
  */
7587
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
7605
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
7588
7606
  /** @description JSON ref to value from where patch should be applied. */
7589
7607
  mutatorRef?: string[][];
7590
7608
  mutatedRef?: string[][];
@@ -7673,12 +7691,13 @@ export interface components {
7673
7691
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
7674
7692
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
7675
7693
  * remove: Removes a value.
7694
+ * replace: Replaces the value at the target location.
7676
7695
  * copy: Copies a value from one location to another.
7677
7696
  * move: Moves a value from one location to another.
7678
7697
  * test: Tests that a value at the target location is equal to a specified value.
7679
7698
  * @enum {string}
7680
7699
  */
7681
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
7700
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
7682
7701
  /** @description JSON ref to value from where patch should be applied. */
7683
7702
  mutatorRef?: string[][];
7684
7703
  mutatedRef?: string[][];
@@ -7764,12 +7783,13 @@ export interface components {
7764
7783
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
7765
7784
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
7766
7785
  * remove: Removes a value.
7786
+ * replace: Replaces the value at the target location.
7767
7787
  * copy: Copies a value from one location to another.
7768
7788
  * move: Moves a value from one location to another.
7769
7789
  * test: Tests that a value at the target location is equal to a specified value.
7770
7790
  * @enum {string}
7771
7791
  */
7772
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
7792
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
7773
7793
  /** @description JSON ref to value from where patch should be applied. */
7774
7794
  mutatorRef?: string[][];
7775
7795
  mutatedRef?: string[][];
@@ -9166,12 +9186,13 @@ export interface operations {
9166
9186
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
9167
9187
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
9168
9188
  * remove: Removes a value.
9189
+ * replace: Replaces the value at the target location.
9169
9190
  * copy: Copies a value from one location to another.
9170
9191
  * move: Moves a value from one location to another.
9171
9192
  * test: Tests that a value at the target location is equal to a specified value.
9172
9193
  * @enum {string}
9173
9194
  */
9174
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
9195
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
9175
9196
  /** @description JSON ref to value from where patch should be applied. */
9176
9197
  mutatorRef?: string[][];
9177
9198
  mutatedRef?: string[][];
@@ -9257,12 +9278,13 @@ export interface operations {
9257
9278
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
9258
9279
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
9259
9280
  * remove: Removes a value.
9281
+ * replace: Replaces the value at the target location.
9260
9282
  * copy: Copies a value from one location to another.
9261
9283
  * move: Moves a value from one location to another.
9262
9284
  * test: Tests that a value at the target location is equal to a specified value.
9263
9285
  * @enum {string}
9264
9286
  */
9265
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
9287
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
9266
9288
  /** @description JSON ref to value from where patch should be applied. */
9267
9289
  mutatorRef?: string[][];
9268
9290
  mutatedRef?: string[][];
@@ -9351,12 +9373,13 @@ export interface operations {
9351
9373
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
9352
9374
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
9353
9375
  * remove: Removes a value.
9376
+ * replace: Replaces the value at the target location.
9354
9377
  * copy: Copies a value from one location to another.
9355
9378
  * move: Moves a value from one location to another.
9356
9379
  * test: Tests that a value at the target location is equal to a specified value.
9357
9380
  * @enum {string}
9358
9381
  */
9359
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
9382
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
9360
9383
  /** @description JSON ref to value from where patch should be applied. */
9361
9384
  mutatorRef?: string[][];
9362
9385
  mutatedRef?: string[][];
@@ -9442,12 +9465,13 @@ export interface operations {
9442
9465
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
9443
9466
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
9444
9467
  * remove: Removes a value.
9468
+ * replace: Replaces the value at the target location.
9445
9469
  * copy: Copies a value from one location to another.
9446
9470
  * move: Moves a value from one location to another.
9447
9471
  * test: Tests that a value at the target location is equal to a specified value.
9448
9472
  * @enum {string}
9449
9473
  */
9450
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
9474
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
9451
9475
  /** @description JSON ref to value from where patch should be applied. */
9452
9476
  mutatorRef?: string[][];
9453
9477
  mutatedRef?: string[][];
@@ -10669,12 +10693,13 @@ export interface operations {
10669
10693
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
10670
10694
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
10671
10695
  * remove: Removes a value.
10696
+ * replace: Replaces the value at the target location.
10672
10697
  * copy: Copies a value from one location to another.
10673
10698
  * move: Moves a value from one location to another.
10674
10699
  * test: Tests that a value at the target location is equal to a specified value.
10675
10700
  * @enum {string}
10676
10701
  */
10677
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
10702
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
10678
10703
  /** @description JSON ref to value from where patch should be applied. */
10679
10704
  mutatorRef?: string[][];
10680
10705
  mutatedRef?: string[][];
@@ -10760,12 +10785,13 @@ export interface operations {
10760
10785
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
10761
10786
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
10762
10787
  * remove: Removes a value.
10788
+ * replace: Replaces the value at the target location.
10763
10789
  * copy: Copies a value from one location to another.
10764
10790
  * move: Moves a value from one location to another.
10765
10791
  * test: Tests that a value at the target location is equal to a specified value.
10766
10792
  * @enum {string}
10767
10793
  */
10768
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
10794
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
10769
10795
  /** @description JSON ref to value from where patch should be applied. */
10770
10796
  mutatorRef?: string[][];
10771
10797
  mutatedRef?: string[][];
@@ -10854,12 +10880,13 @@ export interface operations {
10854
10880
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
10855
10881
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
10856
10882
  * remove: Removes a value.
10883
+ * replace: Replaces the value at the target location.
10857
10884
  * copy: Copies a value from one location to another.
10858
10885
  * move: Moves a value from one location to another.
10859
10886
  * test: Tests that a value at the target location is equal to a specified value.
10860
10887
  * @enum {string}
10861
10888
  */
10862
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
10889
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
10863
10890
  /** @description JSON ref to value from where patch should be applied. */
10864
10891
  mutatorRef?: string[][];
10865
10892
  mutatedRef?: string[][];
@@ -10945,12 +10972,13 @@ export interface operations {
10945
10972
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
10946
10973
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
10947
10974
  * remove: Removes a value.
10975
+ * replace: Replaces the value at the target location.
10948
10976
  * copy: Copies a value from one location to another.
10949
10977
  * move: Moves a value from one location to another.
10950
10978
  * test: Tests that a value at the target location is equal to a specified value.
10951
10979
  * @enum {string}
10952
10980
  */
10953
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
10981
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
10954
10982
  /** @description JSON ref to value from where patch should be applied. */
10955
10983
  mutatorRef?: string[][];
10956
10984
  mutatedRef?: string[][];
@@ -12153,12 +12181,13 @@ export interface operations {
12153
12181
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
12154
12182
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
12155
12183
  * remove: Removes a value.
12184
+ * replace: Replaces the value at the target location.
12156
12185
  * copy: Copies a value from one location to another.
12157
12186
  * move: Moves a value from one location to another.
12158
12187
  * test: Tests that a value at the target location is equal to a specified value.
12159
12188
  * @enum {string}
12160
12189
  */
12161
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
12190
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
12162
12191
  /** @description JSON ref to value from where patch should be applied. */
12163
12192
  mutatorRef?: string[][];
12164
12193
  mutatedRef?: string[][];
@@ -12244,12 +12273,13 @@ export interface operations {
12244
12273
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
12245
12274
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
12246
12275
  * remove: Removes a value.
12276
+ * replace: Replaces the value at the target location.
12247
12277
  * copy: Copies a value from one location to another.
12248
12278
  * move: Moves a value from one location to another.
12249
12279
  * test: Tests that a value at the target location is equal to a specified value.
12250
12280
  * @enum {string}
12251
12281
  */
12252
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
12282
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
12253
12283
  /** @description JSON ref to value from where patch should be applied. */
12254
12284
  mutatorRef?: string[][];
12255
12285
  mutatedRef?: string[][];
@@ -12338,12 +12368,13 @@ export interface operations {
12338
12368
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
12339
12369
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
12340
12370
  * remove: Removes a value.
12371
+ * replace: Replaces the value at the target location.
12341
12372
  * copy: Copies a value from one location to another.
12342
12373
  * move: Moves a value from one location to another.
12343
12374
  * test: Tests that a value at the target location is equal to a specified value.
12344
12375
  * @enum {string}
12345
12376
  */
12346
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
12377
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
12347
12378
  /** @description JSON ref to value from where patch should be applied. */
12348
12379
  mutatorRef?: string[][];
12349
12380
  mutatedRef?: string[][];
@@ -12429,12 +12460,13 @@ export interface operations {
12429
12460
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
12430
12461
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
12431
12462
  * remove: Removes a value.
12463
+ * replace: Replaces the value at the target location.
12432
12464
  * copy: Copies a value from one location to another.
12433
12465
  * move: Moves a value from one location to another.
12434
12466
  * test: Tests that a value at the target location is equal to a specified value.
12435
12467
  * @enum {string}
12436
12468
  */
12437
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
12469
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
12438
12470
  /** @description JSON ref to value from where patch should be applied. */
12439
12471
  mutatorRef?: string[][];
12440
12472
  mutatedRef?: string[][];
@@ -13909,12 +13941,13 @@ export interface operations {
13909
13941
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
13910
13942
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
13911
13943
  * remove: Removes a value.
13944
+ * replace: Replaces the value at the target location.
13912
13945
  * copy: Copies a value from one location to another.
13913
13946
  * move: Moves a value from one location to another.
13914
13947
  * test: Tests that a value at the target location is equal to a specified value.
13915
13948
  * @enum {string}
13916
13949
  */
13917
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
13950
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
13918
13951
  /** @description JSON ref to value from where patch should be applied. */
13919
13952
  mutatorRef?: string[][];
13920
13953
  mutatedRef?: string[][];
@@ -14000,12 +14033,13 @@ export interface operations {
14000
14033
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
14001
14034
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
14002
14035
  * remove: Removes a value.
14036
+ * replace: Replaces the value at the target location.
14003
14037
  * copy: Copies a value from one location to another.
14004
14038
  * move: Moves a value from one location to another.
14005
14039
  * test: Tests that a value at the target location is equal to a specified value.
14006
14040
  * @enum {string}
14007
14041
  */
14008
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
14042
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
14009
14043
  /** @description JSON ref to value from where patch should be applied. */
14010
14044
  mutatorRef?: string[][];
14011
14045
  mutatedRef?: string[][];
@@ -14094,12 +14128,13 @@ export interface operations {
14094
14128
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
14095
14129
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
14096
14130
  * remove: Removes a value.
14131
+ * replace: Replaces the value at the target location.
14097
14132
  * copy: Copies a value from one location to another.
14098
14133
  * move: Moves a value from one location to another.
14099
14134
  * test: Tests that a value at the target location is equal to a specified value.
14100
14135
  * @enum {string}
14101
14136
  */
14102
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
14137
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
14103
14138
  /** @description JSON ref to value from where patch should be applied. */
14104
14139
  mutatorRef?: string[][];
14105
14140
  mutatedRef?: string[][];
@@ -14185,12 +14220,13 @@ export interface operations {
14185
14220
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
14186
14221
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
14187
14222
  * remove: Removes a value.
14223
+ * replace: Replaces the value at the target location.
14188
14224
  * copy: Copies a value from one location to another.
14189
14225
  * move: Moves a value from one location to another.
14190
14226
  * test: Tests that a value at the target location is equal to a specified value.
14191
14227
  * @enum {string}
14192
14228
  */
14193
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
14229
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
14194
14230
  /** @description JSON ref to value from where patch should be applied. */
14195
14231
  mutatorRef?: string[][];
14196
14232
  mutatedRef?: string[][];
@@ -15471,12 +15507,13 @@ export interface operations {
15471
15507
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
15472
15508
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
15473
15509
  * remove: Removes a value.
15510
+ * replace: Replaces the value at the target location.
15474
15511
  * copy: Copies a value from one location to another.
15475
15512
  * move: Moves a value from one location to another.
15476
15513
  * test: Tests that a value at the target location is equal to a specified value.
15477
15514
  * @enum {string}
15478
15515
  */
15479
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
15516
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
15480
15517
  /** @description JSON ref to value from where patch should be applied. */
15481
15518
  mutatorRef?: string[][];
15482
15519
  mutatedRef?: string[][];
@@ -15562,12 +15599,13 @@ export interface operations {
15562
15599
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
15563
15600
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
15564
15601
  * remove: Removes a value.
15602
+ * replace: Replaces the value at the target location.
15565
15603
  * copy: Copies a value from one location to another.
15566
15604
  * move: Moves a value from one location to another.
15567
15605
  * test: Tests that a value at the target location is equal to a specified value.
15568
15606
  * @enum {string}
15569
15607
  */
15570
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
15608
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
15571
15609
  /** @description JSON ref to value from where patch should be applied. */
15572
15610
  mutatorRef?: string[][];
15573
15611
  mutatedRef?: string[][];
@@ -15656,12 +15694,13 @@ export interface operations {
15656
15694
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
15657
15695
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
15658
15696
  * remove: Removes a value.
15697
+ * replace: Replaces the value at the target location.
15659
15698
  * copy: Copies a value from one location to another.
15660
15699
  * move: Moves a value from one location to another.
15661
15700
  * test: Tests that a value at the target location is equal to a specified value.
15662
15701
  * @enum {string}
15663
15702
  */
15664
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
15703
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
15665
15704
  /** @description JSON ref to value from where patch should be applied. */
15666
15705
  mutatorRef?: string[][];
15667
15706
  mutatedRef?: string[][];
@@ -15747,12 +15786,13 @@ export interface operations {
15747
15786
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
15748
15787
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
15749
15788
  * remove: Removes a value.
15789
+ * replace: Replaces the value at the target location.
15750
15790
  * copy: Copies a value from one location to another.
15751
15791
  * move: Moves a value from one location to another.
15752
15792
  * test: Tests that a value at the target location is equal to a specified value.
15753
15793
  * @enum {string}
15754
15794
  */
15755
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
15795
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
15756
15796
  /** @description JSON ref to value from where patch should be applied. */
15757
15797
  mutatorRef?: string[][];
15758
15798
  mutatedRef?: string[][];
@@ -15956,15 +15996,1481 @@ export interface operations {
15956
15996
  };
15957
15997
  };
15958
15998
  responses: {
15959
- /** @description Successful Import */
15999
+ /** @description Successful import. The response body is a JSON array of the saved designs, not a message envelope. The import path saves exactly one design, so the array carries a single element and consumers read the imported design as the first element. */
15960
16000
  200: {
15961
16001
  headers: {
15962
16002
  [name: string]: unknown;
15963
16003
  };
15964
16004
  content: {
15965
16005
  "application/json": {
15966
- message?: string;
15967
- };
16006
+ catalogData?: {
16007
+ /** @description Tracks the specific content version that has been made available in the Catalog. */
16008
+ publishedVersion?: string;
16009
+ /** @description Published content is classifed by its support level. Content classes help you understand the origin and expected support level for each piece of content. It is important to note that the level of support may vary within each class, and you should exercise discretion when using community-contributed content. Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable. Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility. Content produced and supported by the respective project or organization responsible for the specific technology. This class offers a level of support from the project maintainers themselves. Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability. */
16010
+ class?: string & ("official" | "verified" | "reference architecture");
16011
+ /**
16012
+ * Model
16013
+ * @description One or more models associated with this catalog item. For designs, a list of one or more models implicated by components within the design. For models, this is self-referential.
16014
+ */
16015
+ compatibility: "kubernetes"[];
16016
+ /**
16017
+ * Caveats and Considerations
16018
+ * @description Specific stipulations to consider and known behaviors to be aware of when using this design.
16019
+ */
16020
+ patternCaveats: string;
16021
+ /**
16022
+ * Description
16023
+ * @description Purpose of the design along with its intended and unintended uses.
16024
+ */
16025
+ patternInfo: string;
16026
+ /**
16027
+ * Type
16028
+ * @description Categorization of the type of design or operational flow depicted in this design.
16029
+ * @default Deployment
16030
+ * @enum {string}
16031
+ */
16032
+ type: "Deployment" | "Observability" | "Resiliency" | "Scaling" | "Security" | "Traffic-management" | "Troubleshooting" | "Workloads";
16033
+ /** @description Contains reference to the dark and light mode snapshots of the design. */
16034
+ snapshotURL?: string[];
16035
+ };
16036
+ /** Format: date-time */
16037
+ created_at?: string;
16038
+ /** Format: uuid */
16039
+ user_id?: string;
16040
+ location?: {
16041
+ [key: string]: string;
16042
+ };
16043
+ name?: string;
16044
+ /**
16045
+ * Design Schema
16046
+ * @description Designs are your primary tool for collaborative authorship of your infrastructure, workflow, and processes.
16047
+ */
16048
+ patternFile?: {
16049
+ /**
16050
+ * Format: uuid
16051
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16052
+ */
16053
+ id: string;
16054
+ /** @description Name of the design; a descriptive, but concise title for the design document. */
16055
+ name: string;
16056
+ /**
16057
+ * @description Specifies the version of the schema to which the design conforms.
16058
+ * @example [
16059
+ * "v1",
16060
+ * "v1alpha1",
16061
+ * "v2beta3",
16062
+ * "v1.custom-suffix",
16063
+ * "models.meshery.io/v1beta1",
16064
+ * "capability.meshery.io/v1alpha1"
16065
+ * ]
16066
+ */
16067
+ schemaVersion: string;
16068
+ /**
16069
+ * @description Revision of the design as expressed by an auto-incremented, SemVer-compliant version number. May be manually set by a user or third-party system, but will always be required to be of version number higher than the previously defined version number.
16070
+ * @default v0.0.1
16071
+ */
16072
+ version: string;
16073
+ /** @description Additional metadata associated with this resource. */
16074
+ metadata?: {
16075
+ /** @description Map of resolved aliases present in the design */
16076
+ resolvedAliases?: {
16077
+ [key: string]: {
16078
+ /**
16079
+ * Format: uuid
16080
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16081
+ */
16082
+ relationshipId: string;
16083
+ /**
16084
+ * Format: uuid
16085
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16086
+ */
16087
+ aliasComponentId: string;
16088
+ /**
16089
+ * Format: uuid
16090
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16091
+ */
16092
+ immediateParentId: string;
16093
+ /** @description The immediate ref field path of the nonresolvedalias. */
16094
+ immediateRefFieldPath: string[];
16095
+ } & {
16096
+ /**
16097
+ * Format: uuid
16098
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16099
+ */
16100
+ resolvedParentId: string;
16101
+ /** @description Fully resolved field path targeted by the alias. */
16102
+ resolvedRefFieldPath: string[];
16103
+ };
16104
+ };
16105
+ } & {
16106
+ [key: string]: unknown;
16107
+ };
16108
+ /** @description A list of one or more component declarations. */
16109
+ components: {
16110
+ /**
16111
+ * Format: uuid
16112
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16113
+ */
16114
+ id: string;
16115
+ /**
16116
+ * @description Specifies the version of the schema to which the component definition conforms.
16117
+ * @default components.meshery.io/v1beta2
16118
+ * @example [
16119
+ * "v1",
16120
+ * "v1alpha1",
16121
+ * "v2beta3",
16122
+ * "v1.custom-suffix",
16123
+ * "models.meshery.io/v1beta1",
16124
+ * "capability.meshery.io/v1alpha1"
16125
+ * ]
16126
+ */
16127
+ schemaVersion: string;
16128
+ /** @description Version of the component definition. */
16129
+ version: string;
16130
+ /** @description Name of the component in human-readable format. */
16131
+ displayName: string;
16132
+ /** @description A written representation of the purpose and characteristics of the component. */
16133
+ description: string;
16134
+ /**
16135
+ * @description Format specifies the format used in the `component.schema` field. JSON is the default.
16136
+ * @default JSON
16137
+ * @enum {string}
16138
+ */
16139
+ format: "JSON" | "CUE";
16140
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
16141
+ model: {
16142
+ /**
16143
+ * Format: uuid
16144
+ * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
16145
+ */
16146
+ id: string;
16147
+ /**
16148
+ * @description Specifies the version of the schema used for the definition.
16149
+ * @default models.meshery.io/v1beta1
16150
+ * @example [
16151
+ * "v1",
16152
+ * "v1alpha1",
16153
+ * "v2beta3",
16154
+ * "v1.custom-suffix",
16155
+ * "models.meshery.io/v1beta1",
16156
+ * "capability.meshery.io/v1alpha1"
16157
+ * ]
16158
+ */
16159
+ schemaVersion: string;
16160
+ /** @description Version of the model definition. */
16161
+ version: string;
16162
+ /**
16163
+ * @description The unique name for the model within the scope of a registrant.
16164
+ * @default untitled-model
16165
+ * @example cert-manager
16166
+ */
16167
+ name: string;
16168
+ /**
16169
+ * @description Human-readable name for the model.
16170
+ * @default Untitled Model
16171
+ * @example Cert Manager
16172
+ */
16173
+ displayName: string;
16174
+ /**
16175
+ * @description Description of the model.
16176
+ * @default A new Meshery model.
16177
+ */
16178
+ description: string;
16179
+ /**
16180
+ * @description Status of model, including:
16181
+ * - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
16182
+ * - maintenance: model is unavailable for a period of time.
16183
+ * - enabled: model is available for use for all users of this Meshery Server.
16184
+ * - ignored: model is unavailable for use for all users of this Meshery Server.
16185
+ * @default enabled
16186
+ * @enum {string}
16187
+ */
16188
+ status: "ignored" | "enabled" | "duplicate";
16189
+ /** @description Meshery Connections are managed and unmanaged resources that either through discovery or manual entry are tracked by Meshery. Learn more at https://docs.meshery.io/concepts/logical/connections */
16190
+ registrant: {
16191
+ /**
16192
+ * Format: uuid
16193
+ * @description Connection ID
16194
+ */
16195
+ id: string;
16196
+ /** @description Connection Name */
16197
+ name: string;
16198
+ /**
16199
+ * Format: uuid
16200
+ * @description Associated Credential ID
16201
+ */
16202
+ credentialId?: string;
16203
+ /** @description Connection Type (platform, telemetry, collaboration) */
16204
+ type: string;
16205
+ /** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
16206
+ subType: string;
16207
+ /** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
16208
+ kind: string;
16209
+ /** @description Additional connection metadata */
16210
+ metadata?: Record<string, never>;
16211
+ /**
16212
+ * @description Connection Status
16213
+ * @enum {string}
16214
+ */
16215
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
16216
+ /**
16217
+ * Format: uuid
16218
+ * @description User ID who owns this connection
16219
+ */
16220
+ user_id?: string;
16221
+ /** Format: date-time */
16222
+ created_at?: string;
16223
+ /** Format: date-time */
16224
+ updated_at?: string;
16225
+ /**
16226
+ * Format: date-time
16227
+ * @description SQL null Timestamp to handle null values of time.
16228
+ */
16229
+ deleted_at?: string;
16230
+ /** @description Associated environments for this connection */
16231
+ environments?: {
16232
+ /**
16233
+ * Format: uuid
16234
+ * @description ID
16235
+ */
16236
+ id: string;
16237
+ /**
16238
+ * @description Specifies the version of the schema to which the environment conforms.
16239
+ * @default environments.meshery.io/v1beta1
16240
+ * @example [
16241
+ * "v1",
16242
+ * "v1alpha1",
16243
+ * "v2beta3",
16244
+ * "v1.custom-suffix",
16245
+ * "models.meshery.io/v1beta1",
16246
+ * "capability.meshery.io/v1alpha1"
16247
+ * ]
16248
+ */
16249
+ schemaVersion: string;
16250
+ /** @description Environment name */
16251
+ name: string;
16252
+ /** @description Environment description */
16253
+ description: string;
16254
+ /**
16255
+ * Format: uuid
16256
+ * @description Environment organization ID
16257
+ */
16258
+ organization_id: string;
16259
+ /**
16260
+ * Format: uuid
16261
+ * @description Environment owner
16262
+ */
16263
+ owner?: string;
16264
+ /**
16265
+ * Format: date-time
16266
+ * @description Timestamp when the resource was created.
16267
+ */
16268
+ created_at?: string;
16269
+ /** @description Additional metadata associated with the environment. */
16270
+ metadata?: Record<string, never>;
16271
+ /**
16272
+ * Format: date-time
16273
+ * @description Timestamp when the resource was updated.
16274
+ */
16275
+ updated_at?: string;
16276
+ /**
16277
+ * Format: date-time
16278
+ * @description Timestamp when the environment was soft deleted. Null while the environment remains active.
16279
+ */
16280
+ deleted_at?: string | null;
16281
+ }[];
16282
+ /**
16283
+ * @description Specifies the version of the schema used for the definition.
16284
+ * @default connections.meshery.io/v1beta1
16285
+ * @example [
16286
+ * "v1",
16287
+ * "v1alpha1",
16288
+ * "v2beta3",
16289
+ * "v1.custom-suffix",
16290
+ * "models.meshery.io/v1beta1",
16291
+ * "capability.meshery.io/v1alpha1"
16292
+ * ]
16293
+ */
16294
+ schemaVersion: string;
16295
+ };
16296
+ /**
16297
+ * Format: uuid
16298
+ * @description ID of the registrant.
16299
+ */
16300
+ registrantId: string;
16301
+ /**
16302
+ * Format: uuid
16303
+ * @description ID of the category.
16304
+ */
16305
+ categoryId: string;
16306
+ /** @description Category of the model. */
16307
+ category: {
16308
+ /**
16309
+ * Format: uuid
16310
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16311
+ */
16312
+ id: string;
16313
+ /**
16314
+ * @description The category of the model that determines the main grouping.
16315
+ * @default Uncategorized
16316
+ * @enum {string}
16317
+ */
16318
+ name: "Analytics" | "App Definition and Development" | "Cloud Native Network" | "Cloud Native Storage" | "Database" | "Machine Learning" | "Observability and Analysis" | "Orchestration & Management" | "Platform" | "Provisioning" | "Runtime" | "Security & Compliance" | "Serverless" | "Tools" | "Uncategorized";
16319
+ /** @description Additional metadata associated with the category. */
16320
+ metadata: Record<string, never>;
16321
+ };
16322
+ /**
16323
+ * SubCategory
16324
+ * @description Sub category of the model determines the secondary grouping.
16325
+ * @default Uncategorized
16326
+ * @enum {string}
16327
+ */
16328
+ subCategory: "API Gateway" | "API Integration" | "Application Definition & Image Build" | "Automation & Configuration" | "Certified Kubernetes - Distribution" | "Chaos Engineering" | "Cloud Native Storage" | "Cloud Provider" | "CNI" | "Compute" | "Container Registry" | "Container Runtime" | "Container Security" | "Container" | "Content Delivery Network" | "Continuous Integration & Delivery" | "Coordination & Service Discovery" | "Database" | "Flowchart" | "Framework" | "Installable Platform" | "Key Management" | "Key Management Service" | "Kubernetes" | "Logging" | "Machine Learning" | "Management Governance" | "Metrics" | "Monitoring" | "Networking Content Delivery" | "Operating System" | "Query" | "Remote Procedure Call" | "Scheduling & Orchestration" | "Secrets Management" | "Security Identity & Compliance" | "Service Mesh" | "Service Proxy" | "Source Version Control" | "Storage" | "Specifications" | "Streaming & Messaging" | "Tools" | "Tracing" | "Uncategorized" | "Video Conferencing";
16329
+ /** @description Metadata containing additional information associated with the model. */
16330
+ metadata?: {
16331
+ /** @description Capabilities associated with the model */
16332
+ capabilities?: {
16333
+ /**
16334
+ * @description Specifies the version of the schema to which the capability definition conforms.
16335
+ * @example [
16336
+ * "v1",
16337
+ * "v1alpha1",
16338
+ * "v2beta3",
16339
+ * "v1.custom-suffix",
16340
+ * "models.meshery.io/v1beta1",
16341
+ * "capability.meshery.io/v1alpha1"
16342
+ * ]
16343
+ */
16344
+ schemaVersion: string;
16345
+ /** @description Version of the capability definition. */
16346
+ version: string;
16347
+ /** @description Name of the capability in human-readible format. */
16348
+ displayName: string;
16349
+ /** @description A written representation of the purpose and characteristics of the capability. */
16350
+ description: string;
16351
+ /** @description Top-level categorization of the capability */
16352
+ kind: string | "action" | "mutate" | "view" | "interaction";
16353
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
16354
+ type: string;
16355
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
16356
+ subType: string;
16357
+ /** @description Key that backs the capability. */
16358
+ key: string;
16359
+ /** @description State of the entity in which the capability is applicable. */
16360
+ entityState: ("declaration" | "instance")[];
16361
+ /**
16362
+ * @description Status of the capability
16363
+ * @default enabled
16364
+ * @enum {string}
16365
+ */
16366
+ status: "enabled" | "disabled";
16367
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
16368
+ metadata?: {
16369
+ [key: string]: unknown;
16370
+ };
16371
+ }[];
16372
+ /**
16373
+ * @description Indicates whether the model and its entities should be treated as deployable entities or as logical representations.
16374
+ * @default false
16375
+ */
16376
+ isAnnotation: boolean;
16377
+ /**
16378
+ * @description Primary color associated with the model.
16379
+ * @default #00b39f
16380
+ */
16381
+ primaryColor: string;
16382
+ /**
16383
+ * @description Secondary color associated with the model.
16384
+ * @default #00D3A9
16385
+ */
16386
+ secondaryColor: string;
16387
+ /**
16388
+ * @description SVG representation of the model in white color.
16389
+ * @default <svg width="32" height="32" viewBox="0 0 32 32" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M16.405 8.732v6.57l5.694-3.297-5.694-3.273Zm0 7.942v6.602l5.747-3.285-5.747-3.317Z" fill="#fff"/><path d="M15.586 15.256v-6.47l-5.622 3.225 5.622 3.245ZM4.307 23.252a13.809 13.809 0 0 0 4.362 4.39v-6.914l-4.362 2.524Zm11.279-.008v-6.52L9.95 19.985l5.636 3.258Z" fill="#fff" fill-opacity=".8"/><path d="m9.49 27.23 5.707-3.263-5.707-3.3v6.563Z" fill="#fff"/><path d="M22.54 27.265v-6.553l-5.699 3.259 5.7 3.294Zm5.58-4.773a13.697 13.697 0 0 0 1.612-5.895l-5.934 3.397 4.323 2.498Z" fill="#fff" fill-opacity=".8"/><path d="m23.362 19.298 5.728-3.276-5.728-3.291v6.567Z" fill="#fff"/><path d="M22.541 11.315V4.8l-5.673 3.253 5.673 3.262Zm0 7.955v-6.574l-5.685 3.292 5.685 3.281Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 12.684v6.622l5.728-3.316-5.728-3.306Z" fill="#fff"/><path d="M15.586 2.25a13.69 13.69 0 0 0-6.037 1.595l6.037 3.463V2.25Z" fill="#fff" fill-opacity=".8"/><path d="M9.49 4.756v6.583l5.732-3.288L9.49 4.756Z" fill="#fff"/><path d="M8.669 4.356a13.83 13.83 0 0 0-4.362 4.39l4.362 2.518V4.356Z" fill="#fff" fill-opacity=".8"/><path d="M22.504 3.88a13.695 13.695 0 0 0-6.099-1.63v5.123l6.1-3.493ZM2.25 16.483c.071 2.12.634 4.196 1.644 6.062l4.418-2.559-6.062-3.503Zm1.644-7.028a13.68 13.68 0 0 0-1.644 6.036l6.068-3.482-4.424-2.554Z" fill="#fff"/><path d="M9.539 28.147a13.673 13.673 0 0 0 6.047 1.603v-5.062L9.54 28.147Z" fill="#fff" fill-opacity=".8"/><path d="M27.697 8.768a13.83 13.83 0 0 0-4.335-4.383v6.889l4.335-2.506ZM23.362 27.62a13.851 13.851 0 0 0 4.351-4.417l-4.351-2.514v6.93Z" fill="#fff"/><path d="M29.75 15.452a13.659 13.659 0 0 0-1.63-5.979l-4.381 2.53 6.011 3.45Z" fill="#fff" fill-opacity=".8"/><path d="M16.405 29.75a13.673 13.673 0 0 0 6.036-1.595l-6.036-3.498v5.093Z" fill="#fff"/><path d="M8.669 19.247v-6.494L3.03 15.986l5.639 3.261Z" fill="#fff" fill-opacity=".8"/></svg>
16390
+ */
16391
+ svgWhite: string;
16392
+ /**
16393
+ * @description SVG representation of the model in colored format.
16394
+ * @default <svg xmlns="http://www.w3.org/2000/svg" id="Layer_1" data-name="Layer 1" viewBox="0 0 134.95 135.02"><defs><style>.cls-1{fill:#00d3a9}.cls-2{fill:#00b39f}</style></defs><title>meshery-logo-light</title><polygon points="69.49 31.82 69.49 64.07 97.44 47.89 69.49 31.82" class="cls-1"/><polygon points="69.49 70.81 69.49 103.22 97.7 87.09 69.49 70.81" class="cls-1"/><polygon points="65.47 63.85 65.47 32.09 37.87 47.92 65.47 63.85" class="cls-2"/><path d="M10.1,103.1a67.79,67.79,0,0,0,21.41,21.55V90.71Z" class="cls-2"/><polygon points="65.47 103.06 65.47 71.05 37.8 87.07 65.47 103.06" class="cls-2"/><polygon points="35.54 122.63 63.56 106.61 35.54 90.41 35.54 122.63" class="cls-1"/><polygon points="99.61 122.8 99.61 90.63 71.63 106.63 99.61 122.8" class="cls-2"/><path d="M127,99.37a67.22,67.22,0,0,0,7.91-28.94L105.78,87.11Z" class="cls-2"/><polygon points="103.64 83.69 131.76 67.61 103.64 51.45 103.64 83.69" class="cls-1"/><polygon points="99.61 44.5 99.61 12.52 71.76 28.49 99.61 44.5" class="cls-2"/><polygon points="99.61 83.55 99.61 51.28 71.7 67.44 99.61 83.55" class="cls-2"/><polygon points="67.48 135.02 67.49 135.02 67.48 135.02 67.48 135.02" class="cls-2"/><polygon points="35.54 51.22 35.54 83.73 63.66 67.45 35.54 51.22" class="cls-1"/><path d="M65.47,0A67.2,67.2,0,0,0,35.83,7.83l29.64,17Z" class="cls-2"/><polygon points="35.54 12.3 35.54 44.62 63.68 28.48 35.54 12.3" class="cls-1"/><path d="M31.51,10.34A67.89,67.89,0,0,0,10.1,31.89L31.51,44.25Z" class="cls-2"/><path d="M99.43,8A67.23,67.23,0,0,0,69.49,0V25.15Z" class="cls-1"/><path d="M0,69.87A67.27,67.27,0,0,0,8.07,99.63L29.76,87.07Z" class="cls-1"/><path d="M8.07,35.37A67.16,67.16,0,0,0,0,65L29.79,47.91Z" class="cls-1"/><path d="M35.78,127.13A67.13,67.13,0,0,0,65.47,135V110.15Z" class="cls-2"/><path d="M124.92,32a67.9,67.9,0,0,0-21.28-21.52V44.3Z" class="cls-1"/><path d="M103.64,124.54A68,68,0,0,0,125,102.86L103.64,90.52Z" class="cls-1"/><path d="M135,64.81a67.06,67.06,0,0,0-8-29.35L105.49,47.88Z" class="cls-2"/><path d="M69.49,135a67.12,67.12,0,0,0,29.63-7.83L69.49,110Z" class="cls-1"/><polygon points="31.51 83.44 31.51 51.56 3.83 67.43 31.51 83.44" class="cls-2"/></svg>
16395
+ */
16396
+ svgColor: string;
16397
+ /** @description SVG representation of the complete model. */
16398
+ svgComplete?: string;
16399
+ /**
16400
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
16401
+ * @enum {string}
16402
+ */
16403
+ shape?: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
16404
+ } & {
16405
+ [key: string]: unknown;
16406
+ };
16407
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
16408
+ model: {
16409
+ /** @description Version of the model as defined by the registrant. */
16410
+ version: string;
16411
+ };
16412
+ /** @description The relationships of the model. */
16413
+ relationships: unknown[];
16414
+ /** @description The components of the model. */
16415
+ components: unknown[];
16416
+ /**
16417
+ * @description Number of components associated with the model.
16418
+ * @default 0
16419
+ */
16420
+ componentsCount: number;
16421
+ /**
16422
+ * @description Number of relationships associated with the model.
16423
+ * @default 0
16424
+ */
16425
+ relationshipsCount: number;
16426
+ /**
16427
+ * Format: date-time
16428
+ * @description Timestamp when the resource was created.
16429
+ */
16430
+ created_at?: string;
16431
+ /**
16432
+ * Format: date-time
16433
+ * @description Timestamp when the resource was updated.
16434
+ */
16435
+ updated_at?: string;
16436
+ };
16437
+ /** @description Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
16438
+ modelReference: {
16439
+ /**
16440
+ * Format: uuid
16441
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16442
+ */
16443
+ id: string;
16444
+ /**
16445
+ * @description The unique name for the model within the scope of a registrant.
16446
+ * @example cert-manager
16447
+ */
16448
+ name: string;
16449
+ /** @description Version of the model definition. */
16450
+ version: string;
16451
+ /**
16452
+ * @description Human-readable name for the model.
16453
+ * @example Cert Manager
16454
+ */
16455
+ displayName: string;
16456
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
16457
+ model: {
16458
+ /** @description Version of the model as defined by the registrant. */
16459
+ version: string;
16460
+ };
16461
+ registrant: {
16462
+ /** @description Kind of the registrant. */
16463
+ kind: string;
16464
+ };
16465
+ };
16466
+ /**
16467
+ * Format: uuid
16468
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16469
+ */
16470
+ model_id?: string;
16471
+ /** @description Visualization styles for a component */
16472
+ styles?: ({
16473
+ /** @description Primary color of the component used for UI representation. */
16474
+ primaryColor: string;
16475
+ /** @description Secondary color of the entity used for UI representation. */
16476
+ secondaryColor?: string;
16477
+ /** @description White SVG of the entity used for UI representation on dark background. */
16478
+ svgWhite: string;
16479
+ /** @description Colored SVG of the entity used for UI representation on light background. */
16480
+ svgColor: string;
16481
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
16482
+ svgComplete: string;
16483
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
16484
+ color?: string;
16485
+ /** @description The opacity of the label text, including its outline. */
16486
+ textOpacity?: number;
16487
+ /** @description A comma-separated list of font names to use on the label text. */
16488
+ fontFamily?: string;
16489
+ /** @description The size of the label text. */
16490
+ fontSize?: string;
16491
+ /** @description A CSS font style to be applied to the label text. */
16492
+ fontStyle?: string;
16493
+ /** @description A CSS font weight to be applied to the label text. */
16494
+ fontWeight?: string;
16495
+ /**
16496
+ * @description A transformation to apply to the label text
16497
+ * @enum {string}
16498
+ */
16499
+ textTransform?: "none" | "uppercase" | "lowercase";
16500
+ /** @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children. */
16501
+ opacity?: number;
16502
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
16503
+ zIndex?: number;
16504
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
16505
+ label?: string;
16506
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
16507
+ animation?: Record<string, never>;
16508
+ } & {
16509
+ [key: string]: unknown;
16510
+ }) & {
16511
+ /**
16512
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
16513
+ * @enum {string}
16514
+ */
16515
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
16516
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
16517
+ position?: {
16518
+ /** @description The x-coordinate of the node. */
16519
+ x: number;
16520
+ /** @description The y-coordinate of the node. */
16521
+ y: number;
16522
+ };
16523
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
16524
+ bodyText?: string;
16525
+ /**
16526
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
16527
+ * @enum {string}
16528
+ */
16529
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
16530
+ /** @description The maximum width for wrapping text in the node. */
16531
+ bodyTextMaxWidth?: string;
16532
+ /** @description The opacity of the node's body text, including its outline. */
16533
+ bodyTextOpacity?: number;
16534
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
16535
+ bodyTextBackgroundColor?: string;
16536
+ /** @description The size of the node's body text. */
16537
+ bodyTextFontSize?: number;
16538
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
16539
+ bodyTextColor?: string;
16540
+ /** @description A CSS font weight to be applied to the node's body text. */
16541
+ bodyTextFontWeight?: string;
16542
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
16543
+ bodyTextHorizontalAlign?: string;
16544
+ /** @description A CSS text decoration to be applied to the node's body text. */
16545
+ bodyTextDecoration?: string;
16546
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
16547
+ bodyTextVerticalAlign?: string;
16548
+ /** @description The width of the node's body or the width of an edge's line. */
16549
+ width?: number;
16550
+ /** @description The height of the node's body */
16551
+ height?: number;
16552
+ /**
16553
+ * Format: uri
16554
+ * @description The URL that points to the image to show in the node.
16555
+ */
16556
+ backgroundImage?: string;
16557
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
16558
+ backgroundColor?: string;
16559
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
16560
+ backgroundBlacken?: number;
16561
+ /** @description The opacity level of the node's background colour */
16562
+ backgroundOpacity?: number;
16563
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
16564
+ backgroundPositionX?: string;
16565
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
16566
+ backgroundPositionY?: string;
16567
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
16568
+ backgroundOffsetX?: string;
16569
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
16570
+ backgroundOffsetY?: string;
16571
+ /**
16572
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
16573
+ * @enum {string}
16574
+ */
16575
+ backgroundFit?: "none" | "contain" | "cover";
16576
+ /**
16577
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
16578
+ * @enum {string}
16579
+ */
16580
+ backgroundClip?: "none" | "node" | "node-border";
16581
+ /**
16582
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
16583
+ * @enum {string}
16584
+ */
16585
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
16586
+ /**
16587
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
16588
+ * @enum {string}
16589
+ */
16590
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
16591
+ /** @description The size of the node's border. */
16592
+ borderWidth?: number;
16593
+ /**
16594
+ * @description The style of the node's border
16595
+ * @enum {string}
16596
+ */
16597
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
16598
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
16599
+ borderColor?: string;
16600
+ /** @description The opacity of the node's border */
16601
+ borderOpacity?: number;
16602
+ /** @description The amount of padding around all sides of the node. */
16603
+ padding?: number;
16604
+ /**
16605
+ * @description The horizontal alignment of a node's label
16606
+ * @enum {string}
16607
+ */
16608
+ textHalign?: "left" | "center" | "right";
16609
+ /**
16610
+ * @description The vertical alignment of a node's label
16611
+ * @enum {string}
16612
+ */
16613
+ textValign?: "top" | "center" | "bottom";
16614
+ /**
16615
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
16616
+ * @default no
16617
+ * @enum {string}
16618
+ */
16619
+ ghost: "yes" | "no";
16620
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
16621
+ activeBgColor?: string;
16622
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
16623
+ activeBgOpacity?: string;
16624
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
16625
+ activeBgSize?: string;
16626
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
16627
+ selectionBoxColor?: string;
16628
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
16629
+ selectionBoxBorderWidth?: number;
16630
+ /** @description The opacity of the selection box. Selector needs to be *core* */
16631
+ selectionBoxOpacity?: number;
16632
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
16633
+ outsideTextureBgColor?: string;
16634
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
16635
+ outsideTextureBgOpacity?: number;
16636
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
16637
+ shapePolygonPoints?: string;
16638
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
16639
+ menuBackgroundColor?: string;
16640
+ /** @description The opacity of the background of the component menu. */
16641
+ menuBackgroundOpacity?: number;
16642
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
16643
+ menuForgroundColor?: string;
16644
+ };
16645
+ /**
16646
+ * @description Meshery manages components in accordance with their specific capabilities. This field explicitly identifies those capabilities largely by what actions a given component supports; e.g. metric-scrape, sub-interface, and so on. This field is extensible. ComponentDefinitions may define a broad array of capabilities, which are in-turn dynamically interpretted by Meshery for full lifecycle management.
16647
+ * @default [
16648
+ * {
16649
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16650
+ * "version": "0.7.0",
16651
+ * "displayName": "Performance Test",
16652
+ * "description": "Initiate a performance test. Meshery will execute the load generation, collect metrics, and present the results.",
16653
+ * "kind": "action",
16654
+ * "type": "operator",
16655
+ * "subType": "perf-test",
16656
+ * "key": "",
16657
+ * "entityState": [
16658
+ * "instance"
16659
+ * ],
16660
+ * "status": "enabled",
16661
+ * "metadata": null
16662
+ * },
16663
+ * {
16664
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16665
+ * "version": "0.7.0",
16666
+ * "displayName": "Workload Configuration",
16667
+ * "description": "Configure the workload specific setting of a component",
16668
+ * "kind": "mutate",
16669
+ * "type": "configuration",
16670
+ * "subType": "config",
16671
+ * "key": "",
16672
+ * "entityState": [
16673
+ * "declaration"
16674
+ * ],
16675
+ * "status": "enabled",
16676
+ * "metadata": null
16677
+ * },
16678
+ * {
16679
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16680
+ * "version": "0.7.0",
16681
+ * "displayName": "Labels and Annotations Configuration",
16682
+ * "description": "Configure Labels And Annotations for the component",
16683
+ * "kind": "mutate",
16684
+ * "type": "configuration",
16685
+ * "subType": "labels-and-annotations",
16686
+ * "key": "",
16687
+ * "entityState": [
16688
+ * "declaration"
16689
+ * ],
16690
+ * "status": "enabled",
16691
+ * "metadata": null
16692
+ * },
16693
+ * {
16694
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16695
+ * "version": "0.7.0",
16696
+ * "displayName": "Relationships",
16697
+ * "description": "View relationships for the component",
16698
+ * "kind": "view",
16699
+ * "type": "configuration",
16700
+ * "subType": "relationship",
16701
+ * "key": "",
16702
+ * "entityState": [
16703
+ * "declaration",
16704
+ * "instance"
16705
+ * ],
16706
+ * "status": "enabled",
16707
+ * "metadata": null
16708
+ * },
16709
+ * {
16710
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16711
+ * "version": "0.7.0",
16712
+ * "displayName": "Json Schema",
16713
+ * "description": "View Component Definition ",
16714
+ * "kind": "view",
16715
+ * "type": "configuration",
16716
+ * "subType": "definition",
16717
+ * "key": "",
16718
+ * "entityState": [
16719
+ * "declaration",
16720
+ * "instance"
16721
+ * ],
16722
+ * "status": "enabled",
16723
+ * "metadata": null
16724
+ * },
16725
+ * {
16726
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16727
+ * "version": "0.7.0",
16728
+ * "displayName": "Styling",
16729
+ * "description": "Configure the visual styles for the component",
16730
+ * "kind": "mutate",
16731
+ * "type": "style",
16732
+ * "subType": "",
16733
+ * "key": "",
16734
+ * "entityState": [
16735
+ * "declaration"
16736
+ * ],
16737
+ * "status": "enabled",
16738
+ * "metadata": null
16739
+ * },
16740
+ * {
16741
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16742
+ * "version": "0.7.0",
16743
+ * "displayName": "Change Shape",
16744
+ * "description": "Change the shape of the component",
16745
+ * "kind": "mutate",
16746
+ * "type": "style",
16747
+ * "subType": "shape",
16748
+ * "key": "",
16749
+ * "entityState": [
16750
+ * "declaration"
16751
+ * ],
16752
+ * "status": "enabled",
16753
+ * "metadata": null
16754
+ * },
16755
+ * {
16756
+ * "schemaVersion": "capability.meshery.io/v1beta1",
16757
+ * "version": "0.7.0",
16758
+ * "displayName": "Compound Drag And Drop",
16759
+ * "description": "Drag and Drop a component into a parent component in graph view",
16760
+ * "kind": "interaction",
16761
+ * "type": "graph",
16762
+ * "subType": "compoundDnd",
16763
+ * "key": "",
16764
+ * "entityState": [
16765
+ * "declaration"
16766
+ * ],
16767
+ * "status": "enabled",
16768
+ * "metadata": null
16769
+ * }
16770
+ * ]
16771
+ */
16772
+ capabilities: {
16773
+ /**
16774
+ * @description Specifies the version of the schema to which the capability definition conforms.
16775
+ * @example [
16776
+ * "v1",
16777
+ * "v1alpha1",
16778
+ * "v2beta3",
16779
+ * "v1.custom-suffix",
16780
+ * "models.meshery.io/v1beta1",
16781
+ * "capability.meshery.io/v1alpha1"
16782
+ * ]
16783
+ */
16784
+ schemaVersion: string;
16785
+ /** @description Version of the capability definition. */
16786
+ version: string;
16787
+ /** @description Name of the capability in human-readible format. */
16788
+ displayName: string;
16789
+ /** @description A written representation of the purpose and characteristics of the capability. */
16790
+ description: string;
16791
+ /** @description Top-level categorization of the capability */
16792
+ kind: string | "action" | "mutate" | "view" | "interaction";
16793
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
16794
+ type: string;
16795
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
16796
+ subType: string;
16797
+ /** @description Key that backs the capability. */
16798
+ key: string;
16799
+ /** @description State of the entity in which the capability is applicable. */
16800
+ entityState: ("declaration" | "instance")[];
16801
+ /**
16802
+ * @description Status of the capability
16803
+ * @default enabled
16804
+ * @enum {string}
16805
+ */
16806
+ status: "enabled" | "disabled";
16807
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
16808
+ metadata?: {
16809
+ [key: string]: unknown;
16810
+ };
16811
+ }[];
16812
+ /**
16813
+ * @description Status of component, including:
16814
+ * - duplicate: this component is a duplicate of another. The component that is to be the canonical reference and that is duplicated by other components should not be assigned the 'duplicate' status.
16815
+ * - maintenance: model is unavailable for a period of time.
16816
+ * - enabled: model is available for use for all users of this Meshery Server.
16817
+ * - ignored: model is unavailable for use for all users of this Meshery Server.
16818
+ * @default enabled
16819
+ * @enum {string}
16820
+ */
16821
+ status: "ignored" | "enabled" | "duplicate" | "resolved" | "open";
16822
+ /** @description Metadata contains additional information associated with the component. */
16823
+ metadata: {
16824
+ /** @description Genealogy represents the various representational states of the component. */
16825
+ genealogy: string;
16826
+ /**
16827
+ * @description Identifies whether the component is semantically meaningful or not; identifies whether the component should be treated as deployable entity or is for purposes of logical representation.
16828
+ * @default false
16829
+ */
16830
+ isAnnotation: boolean;
16831
+ /** @description Identifies whether the component is scoped to namespace or cluster wide. */
16832
+ isNamespaced: boolean;
16833
+ /** @description 'published' controls whether the component should be registered in Meshery Registry. When the same 'published' property in Models, is set to 'false', the Model property takes precedence with all Entities in the Model not being registered. */
16834
+ published: boolean;
16835
+ /** @description InstanceDetails contains information about the instance of the component. */
16836
+ instanceDetails: Record<string, never>;
16837
+ /** @description Defines the UI schema for rendering the component's configuration. For more details, visit: https://rjsf-team.github.io/react-jsonschema-form/docs/api-reference/uiSchema/ . */
16838
+ configurationUISchema: string;
16839
+ } & {
16840
+ [key: string]: unknown;
16841
+ };
16842
+ /** @description The configuration of the component. The configuration is based on the schema defined within the component definition(component.schema). */
16843
+ configuration: Record<string, never>;
16844
+ /** @description Data related to the third-party capability that a ComponentDefinition wraps; this payload is treated as a hermetically sealed, opaque object. */
16845
+ component: {
16846
+ /** @description Version of the component produced by the registrant. Example: APIVersion of a Kubernetes Pod. */
16847
+ version: string;
16848
+ /** @description The unique identifier (name) assigned by the registrant to this component. Example: A Kubernetes Pod is of kind 'Pod'. */
16849
+ kind: string;
16850
+ /** @description JSON schema of the object as defined by the registrant. */
16851
+ schema: string;
16852
+ };
16853
+ /**
16854
+ * Format: date-time
16855
+ * @description Timestamp when the resource was created.
16856
+ */
16857
+ created_at?: string;
16858
+ /**
16859
+ * Format: date-time
16860
+ * @description Timestamp when the resource was updated.
16861
+ */
16862
+ updated_at?: string;
16863
+ }[];
16864
+ /** @description Design-level preferences */
16865
+ preferences?: {
16866
+ /** @description Map of available layers, where keys are layer names. */
16867
+ layers: Record<string, never>;
16868
+ };
16869
+ /** @description List of relationships between components */
16870
+ relationships: {
16871
+ /**
16872
+ * Format: uuid
16873
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
16874
+ */
16875
+ id: string;
16876
+ /**
16877
+ * @description Specifies the version of the schema used for the relationship definition.
16878
+ * @example [
16879
+ * "v1",
16880
+ * "v1alpha1",
16881
+ * "v2beta3",
16882
+ * "v1.custom-suffix",
16883
+ * "models.meshery.io/v1beta1",
16884
+ * "capability.meshery.io/v1alpha1"
16885
+ * ]
16886
+ */
16887
+ schemaVersion: string;
16888
+ /** @description Specifies the version of the relationship definition. */
16889
+ version: string;
16890
+ /**
16891
+ * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
16892
+ * @enum {string}
16893
+ */
16894
+ kind: "hierarchical" | "edge" | "sibling";
16895
+ /** @description Classification of relationships. Used to group relationships similar in nature. */
16896
+ type: string;
16897
+ /** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
16898
+ subType: string;
16899
+ /**
16900
+ * @description Status of the relationship.
16901
+ * @enum {string}
16902
+ */
16903
+ status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
16904
+ /** @description Capabilities associated with the relationship. */
16905
+ capabilities?: {
16906
+ /**
16907
+ * @description Specifies the version of the schema to which the capability definition conforms.
16908
+ * @example [
16909
+ * "v1",
16910
+ * "v1alpha1",
16911
+ * "v2beta3",
16912
+ * "v1.custom-suffix",
16913
+ * "models.meshery.io/v1beta1",
16914
+ * "capability.meshery.io/v1alpha1"
16915
+ * ]
16916
+ */
16917
+ schemaVersion: string;
16918
+ /** @description Version of the capability definition. */
16919
+ version: string;
16920
+ /** @description Name of the capability in human-readible format. */
16921
+ displayName: string;
16922
+ /** @description A written representation of the purpose and characteristics of the capability. */
16923
+ description: string;
16924
+ /** @description Top-level categorization of the capability */
16925
+ kind: string | "action" | "mutate" | "view" | "interaction";
16926
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
16927
+ type: string;
16928
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
16929
+ subType: string;
16930
+ /** @description Key that backs the capability. */
16931
+ key: string;
16932
+ /** @description State of the entity in which the capability is applicable. */
16933
+ entityState: ("declaration" | "instance")[];
16934
+ /**
16935
+ * @description Status of the capability
16936
+ * @default enabled
16937
+ * @enum {string}
16938
+ */
16939
+ status: "enabled" | "disabled";
16940
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
16941
+ metadata?: {
16942
+ [key: string]: unknown;
16943
+ };
16944
+ }[];
16945
+ /** @description Metadata contains additional information associated with the Relationship. */
16946
+ metadata?: {
16947
+ /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
16948
+ description?: string;
16949
+ /** @description Visualization styles for a relationship */
16950
+ styles?: {
16951
+ /** @description Primary color of the component used for UI representation. */
16952
+ primaryColor: string;
16953
+ /** @description Secondary color of the entity used for UI representation. */
16954
+ secondaryColor?: string;
16955
+ /** @description White SVG of the entity used for UI representation on dark background. */
16956
+ svgWhite: string;
16957
+ /** @description Colored SVG of the entity used for UI representation on light background. */
16958
+ svgColor: string;
16959
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
16960
+ svgComplete?: string;
16961
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
16962
+ color?: string;
16963
+ /**
16964
+ * Format: float
16965
+ * @description The opacity of the label text, including its outline.
16966
+ */
16967
+ textOpacity?: number;
16968
+ /** @description A comma-separated list of font names to use on the label text. */
16969
+ fontFamily?: string;
16970
+ /** @description The size of the label text. */
16971
+ fontSize?: string;
16972
+ /** @description A CSS font style to be applied to the label text. */
16973
+ fontStyle?: string;
16974
+ /** @description A CSS font weight to be applied to the label text. */
16975
+ fontWeight?: string;
16976
+ /**
16977
+ * @description A transformation to apply to the label text
16978
+ * @enum {string}
16979
+ */
16980
+ textTransform?: "none" | "uppercase" | "lowercase";
16981
+ /**
16982
+ * Format: float
16983
+ * @description The opacity of the element, ranging from 0 to 1. Note that the opacity of a compound node parent affects the effective opacity of its children.See https://js.cytoscape.org/#style/visibility
16984
+ */
16985
+ opacity?: number;
16986
+ /** @description An integer value that affects the relative draw order of elements. In general, an element with a higher z-index will be drawn on top of an element with a lower z-index. Note that edges are under nodes despite z-index. */
16987
+ zIndex?: number;
16988
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
16989
+ label?: string;
16990
+ /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
16991
+ edgeAnimation?: string;
16992
+ /**
16993
+ * @description The curving method used to separate two or more edges between two nodes; may be haystack (very fast, bundled straight edges for which loops and compounds are unsupported), straight (straight edges with all arrows supported), bezier (bundled curved edges), unbundled-bezier (curved edges for use with manual control points), segments (a series of straight lines), taxi (right-angled lines, hierarchically bundled). Note that haystack edges work best with ellipse, rectangle, or similar nodes. Smaller node shapes, like triangle, will not be as aesthetically pleasing. Also note that edge endpoint arrows are unsupported for haystack edges.
16994
+ * @enum {string}
16995
+ */
16996
+ curveStyle?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
16997
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
16998
+ lineColor?: string;
16999
+ /**
17000
+ * @description The style of the edge's line.
17001
+ * @enum {string}
17002
+ */
17003
+ lineStyle?: "solid" | "dotted" | "dashed";
17004
+ /**
17005
+ * @description The cap style of the edge's line; may be butt (default), round, or square. The cap may or may not be visible, depending on the shape of the node and the relative size of the node and edge. Caps other than butt extend beyond the specified endpoint of the edge.
17006
+ * @enum {string}
17007
+ */
17008
+ lineCap?: "butt" | "round" | "square";
17009
+ /**
17010
+ * Format: float
17011
+ * @description The opacity of the edge's line and arrow. Useful if you wish to have a separate opacity for the edge label versus the edge line. Note that the opacity value of the edge element affects the effective opacity of its line and label subcomponents.
17012
+ */
17013
+ lineOpacity?: number;
17014
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
17015
+ targetArrowColor?: string;
17016
+ /**
17017
+ * @description The shape of the edge's source arrow
17018
+ * @enum {string}
17019
+ */
17020
+ targetArrowShape?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
17021
+ /**
17022
+ * @description The fill state of the edge's source arrow
17023
+ * @enum {string}
17024
+ */
17025
+ targetArrowFill?: "filled" | "hollow";
17026
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
17027
+ midTargetArrowColor?: string;
17028
+ /**
17029
+ * @description The shape of the edge's source arrow
17030
+ * @enum {string}
17031
+ */
17032
+ midTargetArrowShape?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
17033
+ /**
17034
+ * @description The fill state of the edge's source arrow
17035
+ * @enum {string}
17036
+ */
17037
+ midTargetArrowFill?: "filled" | "hollow";
17038
+ /**
17039
+ * Format: float
17040
+ * @description Scaling for the arrow size.
17041
+ */
17042
+ arrowScale?: number;
17043
+ /** @description The text to display for an edge's source label. Can give a path, e.g. data(id) will label with the elements id */
17044
+ sourceLabel?: string;
17045
+ /** @description The text to display for an edge's target label. Can give a path, e.g. data(id) will label with the elements id */
17046
+ targetLabel?: string;
17047
+ };
17048
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
17049
+ isAnnotation?: boolean;
17050
+ } & {
17051
+ [key: string]: unknown;
17052
+ };
17053
+ /** @description Model Reference to the specific registered model to which the component belongs and from which model version, category, and other properties may be referenced. Learn more at https://docs.meshery.io/concepts/models */
17054
+ model: {
17055
+ /**
17056
+ * Format: uuid
17057
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17058
+ */
17059
+ id: string;
17060
+ /**
17061
+ * @description The unique name for the model within the scope of a registrant.
17062
+ * @example cert-manager
17063
+ */
17064
+ name: string;
17065
+ /** @description Version of the model definition. */
17066
+ version: string;
17067
+ /**
17068
+ * @description Human-readable name for the model.
17069
+ * @example Cert Manager
17070
+ */
17071
+ displayName: string;
17072
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
17073
+ model: {
17074
+ /** @description Version of the model as defined by the registrant. */
17075
+ version: string;
17076
+ };
17077
+ registrant: {
17078
+ /** @description Kind of the registrant. */
17079
+ kind: string;
17080
+ };
17081
+ };
17082
+ /**
17083
+ * Format: uuid
17084
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17085
+ */
17086
+ model_id?: string;
17087
+ /** @description Optional. Assigns the policy to be used for the evaluation of the relationship. Deprecation Notice: In the future, this property is either to be removed or to it is to be an array of optional policy $refs. */
17088
+ evaluationQuery?: string;
17089
+ /** @description Selectors are organized as an array, with each item containing a distinct set of selectors that share a common functionality. This structure allows for flexibility in defining relationships, even when different components are involved. */
17090
+ selectors?: {
17091
+ /** @description Selectors used to define relationships which are allowed. */
17092
+ allow: {
17093
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
17094
+ from: {
17095
+ /**
17096
+ * Format: uuid
17097
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17098
+ */
17099
+ id?: string;
17100
+ /** @description Kind of the resource. */
17101
+ kind?: string;
17102
+ /** @description Match configuration for selector */
17103
+ match?: {
17104
+ /** @description The refs of the matchselector. */
17105
+ refs?: string[][];
17106
+ /** @description The from of the matchselector. */
17107
+ from?: {
17108
+ /**
17109
+ * Format: uuid
17110
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17111
+ */
17112
+ id?: string;
17113
+ /** @description Kind of the resource. */
17114
+ kind: string;
17115
+ /** @description JSON ref to value from where patch should be applied. */
17116
+ mutatorRef?: string[][];
17117
+ mutatedRef?: string[][];
17118
+ }[];
17119
+ /** @description The to of the matchselector. */
17120
+ to?: {
17121
+ /**
17122
+ * Format: uuid
17123
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17124
+ */
17125
+ id?: string;
17126
+ /** @description Kind of the resource. */
17127
+ kind: string;
17128
+ /** @description JSON ref to value from where patch should be applied. */
17129
+ mutatorRef?: string[][];
17130
+ mutatedRef?: string[][];
17131
+ }[];
17132
+ };
17133
+ /** @description Match strategy matrix for the selector */
17134
+ matchStrategyMatrix?: string[][];
17135
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
17136
+ model?: {
17137
+ /**
17138
+ * Format: uuid
17139
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17140
+ */
17141
+ id: string;
17142
+ /**
17143
+ * @description The unique name for the model within the scope of a registrant.
17144
+ * @example cert-manager
17145
+ */
17146
+ name: string;
17147
+ /** @description Version of the model definition. */
17148
+ version: string;
17149
+ /**
17150
+ * @description Human-readable name for the model.
17151
+ * @example Cert Manager
17152
+ */
17153
+ displayName: string;
17154
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
17155
+ model: {
17156
+ /** @description Version of the model as defined by the registrant. */
17157
+ version: string;
17158
+ };
17159
+ registrant: {
17160
+ /** @description Kind of the registrant. */
17161
+ kind: string;
17162
+ };
17163
+ };
17164
+ /** @description Patch configuration for the selector */
17165
+ patch?: {
17166
+ /**
17167
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
17168
+ *
17169
+ * add: Inserts a value into an array or adds a member to an object.
17170
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17171
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17172
+ * remove: Removes a value.
17173
+ * replace: Replaces the value at the target location.
17174
+ * copy: Copies a value from one location to another.
17175
+ * move: Moves a value from one location to another.
17176
+ * test: Tests that a value at the target location is equal to a specified value.
17177
+ * @enum {string}
17178
+ */
17179
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17180
+ /** @description JSON ref to value from where patch should be applied. */
17181
+ mutatorRef?: string[][];
17182
+ mutatedRef?: string[][];
17183
+ };
17184
+ }[];
17185
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
17186
+ to: {
17187
+ /**
17188
+ * Format: uuid
17189
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17190
+ */
17191
+ id?: string;
17192
+ /** @description Kind of the resource. */
17193
+ kind?: string;
17194
+ /** @description Match configuration for selector */
17195
+ match?: {
17196
+ /** @description The refs of the matchselector. */
17197
+ refs?: string[][];
17198
+ /** @description The from of the matchselector. */
17199
+ from?: {
17200
+ /**
17201
+ * Format: uuid
17202
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17203
+ */
17204
+ id?: string;
17205
+ /** @description Kind of the resource. */
17206
+ kind: string;
17207
+ /** @description JSON ref to value from where patch should be applied. */
17208
+ mutatorRef?: string[][];
17209
+ mutatedRef?: string[][];
17210
+ }[];
17211
+ /** @description The to of the matchselector. */
17212
+ to?: {
17213
+ /**
17214
+ * Format: uuid
17215
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17216
+ */
17217
+ id?: string;
17218
+ /** @description Kind of the resource. */
17219
+ kind: string;
17220
+ /** @description JSON ref to value from where patch should be applied. */
17221
+ mutatorRef?: string[][];
17222
+ mutatedRef?: string[][];
17223
+ }[];
17224
+ };
17225
+ /** @description Match strategy matrix for the selector */
17226
+ matchStrategyMatrix?: string[][];
17227
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
17228
+ model?: {
17229
+ /**
17230
+ * Format: uuid
17231
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17232
+ */
17233
+ id: string;
17234
+ /**
17235
+ * @description The unique name for the model within the scope of a registrant.
17236
+ * @example cert-manager
17237
+ */
17238
+ name: string;
17239
+ /** @description Version of the model definition. */
17240
+ version: string;
17241
+ /**
17242
+ * @description Human-readable name for the model.
17243
+ * @example Cert Manager
17244
+ */
17245
+ displayName: string;
17246
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
17247
+ model: {
17248
+ /** @description Version of the model as defined by the registrant. */
17249
+ version: string;
17250
+ };
17251
+ registrant: {
17252
+ /** @description Kind of the registrant. */
17253
+ kind: string;
17254
+ };
17255
+ };
17256
+ /** @description Patch configuration for the selector */
17257
+ patch?: {
17258
+ /**
17259
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
17260
+ *
17261
+ * add: Inserts a value into an array or adds a member to an object.
17262
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17263
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17264
+ * remove: Removes a value.
17265
+ * replace: Replaces the value at the target location.
17266
+ * copy: Copies a value from one location to another.
17267
+ * move: Moves a value from one location to another.
17268
+ * test: Tests that a value at the target location is equal to a specified value.
17269
+ * @enum {string}
17270
+ */
17271
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17272
+ /** @description JSON ref to value from where patch should be applied. */
17273
+ mutatorRef?: string[][];
17274
+ mutatedRef?: string[][];
17275
+ };
17276
+ }[];
17277
+ };
17278
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
17279
+ deny?: {
17280
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
17281
+ from: {
17282
+ /**
17283
+ * Format: uuid
17284
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17285
+ */
17286
+ id?: string;
17287
+ /** @description Kind of the resource. */
17288
+ kind?: string;
17289
+ /** @description Match configuration for selector */
17290
+ match?: {
17291
+ /** @description The refs of the matchselector. */
17292
+ refs?: string[][];
17293
+ /** @description The from of the matchselector. */
17294
+ from?: {
17295
+ /**
17296
+ * Format: uuid
17297
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17298
+ */
17299
+ id?: string;
17300
+ /** @description Kind of the resource. */
17301
+ kind: string;
17302
+ /** @description JSON ref to value from where patch should be applied. */
17303
+ mutatorRef?: string[][];
17304
+ mutatedRef?: string[][];
17305
+ }[];
17306
+ /** @description The to of the matchselector. */
17307
+ to?: {
17308
+ /**
17309
+ * Format: uuid
17310
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17311
+ */
17312
+ id?: string;
17313
+ /** @description Kind of the resource. */
17314
+ kind: string;
17315
+ /** @description JSON ref to value from where patch should be applied. */
17316
+ mutatorRef?: string[][];
17317
+ mutatedRef?: string[][];
17318
+ }[];
17319
+ };
17320
+ /** @description Match strategy matrix for the selector */
17321
+ matchStrategyMatrix?: string[][];
17322
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
17323
+ model?: {
17324
+ /**
17325
+ * Format: uuid
17326
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17327
+ */
17328
+ id: string;
17329
+ /**
17330
+ * @description The unique name for the model within the scope of a registrant.
17331
+ * @example cert-manager
17332
+ */
17333
+ name: string;
17334
+ /** @description Version of the model definition. */
17335
+ version: string;
17336
+ /**
17337
+ * @description Human-readable name for the model.
17338
+ * @example Cert Manager
17339
+ */
17340
+ displayName: string;
17341
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
17342
+ model: {
17343
+ /** @description Version of the model as defined by the registrant. */
17344
+ version: string;
17345
+ };
17346
+ registrant: {
17347
+ /** @description Kind of the registrant. */
17348
+ kind: string;
17349
+ };
17350
+ };
17351
+ /** @description Patch configuration for the selector */
17352
+ patch?: {
17353
+ /**
17354
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
17355
+ *
17356
+ * add: Inserts a value into an array or adds a member to an object.
17357
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17358
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17359
+ * remove: Removes a value.
17360
+ * replace: Replaces the value at the target location.
17361
+ * copy: Copies a value from one location to another.
17362
+ * move: Moves a value from one location to another.
17363
+ * test: Tests that a value at the target location is equal to a specified value.
17364
+ * @enum {string}
17365
+ */
17366
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17367
+ /** @description JSON ref to value from where patch should be applied. */
17368
+ mutatorRef?: string[][];
17369
+ mutatedRef?: string[][];
17370
+ };
17371
+ }[];
17372
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
17373
+ to: {
17374
+ /**
17375
+ * Format: uuid
17376
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17377
+ */
17378
+ id?: string;
17379
+ /** @description Kind of the resource. */
17380
+ kind?: string;
17381
+ /** @description Match configuration for selector */
17382
+ match?: {
17383
+ /** @description The refs of the matchselector. */
17384
+ refs?: string[][];
17385
+ /** @description The from of the matchselector. */
17386
+ from?: {
17387
+ /**
17388
+ * Format: uuid
17389
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17390
+ */
17391
+ id?: string;
17392
+ /** @description Kind of the resource. */
17393
+ kind: string;
17394
+ /** @description JSON ref to value from where patch should be applied. */
17395
+ mutatorRef?: string[][];
17396
+ mutatedRef?: string[][];
17397
+ }[];
17398
+ /** @description The to of the matchselector. */
17399
+ to?: {
17400
+ /**
17401
+ * Format: uuid
17402
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17403
+ */
17404
+ id?: string;
17405
+ /** @description Kind of the resource. */
17406
+ kind: string;
17407
+ /** @description JSON ref to value from where patch should be applied. */
17408
+ mutatorRef?: string[][];
17409
+ mutatedRef?: string[][];
17410
+ }[];
17411
+ };
17412
+ /** @description Match strategy matrix for the selector */
17413
+ matchStrategyMatrix?: string[][];
17414
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
17415
+ model?: {
17416
+ /**
17417
+ * Format: uuid
17418
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
17419
+ */
17420
+ id: string;
17421
+ /**
17422
+ * @description The unique name for the model within the scope of a registrant.
17423
+ * @example cert-manager
17424
+ */
17425
+ name: string;
17426
+ /** @description Version of the model definition. */
17427
+ version: string;
17428
+ /**
17429
+ * @description Human-readable name for the model.
17430
+ * @example Cert Manager
17431
+ */
17432
+ displayName: string;
17433
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
17434
+ model: {
17435
+ /** @description Version of the model as defined by the registrant. */
17436
+ version: string;
17437
+ };
17438
+ registrant: {
17439
+ /** @description Kind of the registrant. */
17440
+ kind: string;
17441
+ };
17442
+ };
17443
+ /** @description Patch configuration for the selector */
17444
+ patch?: {
17445
+ /**
17446
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
17447
+ *
17448
+ * add: Inserts a value into an array or adds a member to an object.
17449
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17450
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17451
+ * remove: Removes a value.
17452
+ * replace: Replaces the value at the target location.
17453
+ * copy: Copies a value from one location to another.
17454
+ * move: Moves a value from one location to another.
17455
+ * test: Tests that a value at the target location is equal to a specified value.
17456
+ * @enum {string}
17457
+ */
17458
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17459
+ /** @description JSON ref to value from where patch should be applied. */
17460
+ mutatorRef?: string[][];
17461
+ mutatedRef?: string[][];
17462
+ };
17463
+ }[];
17464
+ };
17465
+ }[];
17466
+ }[];
17467
+ };
17468
+ /** Format: date-time */
17469
+ updated_at?: string;
17470
+ /** Format: uuid */
17471
+ id?: string;
17472
+ visibility?: string;
17473
+ }[];
15968
17474
  };
15969
17475
  };
15970
17476
  /** @description Invalid request format */
@@ -17203,12 +18709,13 @@ export interface operations {
17203
18709
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17204
18710
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17205
18711
  * remove: Removes a value.
18712
+ * replace: Replaces the value at the target location.
17206
18713
  * copy: Copies a value from one location to another.
17207
18714
  * move: Moves a value from one location to another.
17208
18715
  * test: Tests that a value at the target location is equal to a specified value.
17209
18716
  * @enum {string}
17210
18717
  */
17211
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
18718
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17212
18719
  /** @description JSON ref to value from where patch should be applied. */
17213
18720
  mutatorRef?: string[][];
17214
18721
  mutatedRef?: string[][];
@@ -17294,12 +18801,13 @@ export interface operations {
17294
18801
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17295
18802
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17296
18803
  * remove: Removes a value.
18804
+ * replace: Replaces the value at the target location.
17297
18805
  * copy: Copies a value from one location to another.
17298
18806
  * move: Moves a value from one location to another.
17299
18807
  * test: Tests that a value at the target location is equal to a specified value.
17300
18808
  * @enum {string}
17301
18809
  */
17302
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
18810
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17303
18811
  /** @description JSON ref to value from where patch should be applied. */
17304
18812
  mutatorRef?: string[][];
17305
18813
  mutatedRef?: string[][];
@@ -17388,12 +18896,13 @@ export interface operations {
17388
18896
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17389
18897
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17390
18898
  * remove: Removes a value.
18899
+ * replace: Replaces the value at the target location.
17391
18900
  * copy: Copies a value from one location to another.
17392
18901
  * move: Moves a value from one location to another.
17393
18902
  * test: Tests that a value at the target location is equal to a specified value.
17394
18903
  * @enum {string}
17395
18904
  */
17396
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
18905
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17397
18906
  /** @description JSON ref to value from where patch should be applied. */
17398
18907
  mutatorRef?: string[][];
17399
18908
  mutatedRef?: string[][];
@@ -17479,12 +18988,13 @@ export interface operations {
17479
18988
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
17480
18989
  * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
17481
18990
  * remove: Removes a value.
18991
+ * replace: Replaces the value at the target location.
17482
18992
  * copy: Copies a value from one location to another.
17483
18993
  * move: Moves a value from one location to another.
17484
18994
  * test: Tests that a value at the target location is equal to a specified value.
17485
18995
  * @enum {string}
17486
18996
  */
17487
- patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
18997
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "replace" | "copy" | "move" | "test";
17488
18998
  /** @description JSON ref to value from where patch should be applied. */
17489
18999
  mutatorRef?: string[][];
17490
19000
  mutatedRef?: string[][];