@meshery/schemas 1.2.22 → 1.3.0

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 (88) hide show
  1. package/dist/cloudApi.d.mts +1719 -1518
  2. package/dist/cloudApi.d.ts +1719 -1518
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6648 -6029
  10. package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
  11. package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
  12. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
  13. package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
  14. package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
  15. package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
  16. package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
  17. package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
  18. package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
  19. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
  20. package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
  21. package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
  22. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
  23. package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
  24. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
  25. package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
  26. package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
  27. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
  28. package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
  29. package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
  30. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
  31. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
  32. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
  33. package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
  34. package/dist/constructs/v1beta1/system/System.d.ts +434 -0
  35. package/dist/constructs/v1beta1/system/System.js +1 -0
  36. package/dist/constructs/v1beta1/system/System.mjs +0 -0
  37. package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
  38. package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
  39. package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
  40. package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
  41. package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
  42. package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
  43. package/dist/constructs/v1beta1/view/View.d.ts +833 -664
  44. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
  45. package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
  46. package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
  47. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
  48. package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
  49. package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
  50. package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
  51. package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
  52. package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
  53. package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
  54. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
  55. package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
  56. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
  57. package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
  58. package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
  59. package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
  60. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
  61. package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
  62. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
  63. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
  64. package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
  65. package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
  66. package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
  67. package/dist/constructs/v1beta2/view/View.d.ts +838 -669
  68. package/dist/constructs/v1beta3/academy/Academy.d.ts +7836 -7218
  69. package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
  70. package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
  71. package/dist/constructs/v1beta3/design/Design.d.ts +5727 -5305
  72. package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
  73. package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
  74. package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
  75. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
  76. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
  77. package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
  78. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
  79. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
  80. package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
  81. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
  82. package/dist/index.d.mts +5480 -5022
  83. package/dist/index.d.ts +5480 -5022
  84. package/dist/mesheryApi.d.mts +1314 -522
  85. package/dist/mesheryApi.d.ts +1314 -522
  86. package/dist/mesheryApi.js +1 -1
  87. package/dist/mesheryApi.mjs +1 -1
  88. package/package.json +1 -2
@@ -3,354 +3,600 @@
3
3
  * Do not make direct changes to the file.
4
4
  */
5
5
 
6
- export interface paths {}
7
-
6
+ export type paths = Record<string, never>;
7
+ export type webhooks = Record<string, never>;
8
8
  export interface components {
9
- schemas: {
10
- /** @description Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships. */
11
- RelationshipDefinition: {
12
- /**
13
- * Format: uuid
14
- * @description Uniquely identifies the entity
15
- */
16
- id: string;
17
- /**
18
- * @description Specifies the version of the schema used for the relationship definition.
19
- * @example [
20
- * "v1",
21
- * "v1alpha1",
22
- * "v2beta3",
23
- * "v1.custom-suffix",
24
- * "models.meshery.io/v1beta1",
25
- * "capability.meshery.io/v1alpha1"
26
- * ]
27
- */
28
- schemaVersion: string;
29
- /** @description Specifies the version of the relationship definition. */
30
- version: string;
31
- /**
32
- * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
33
- * @enum {string}
34
- */
35
- kind: "hierarchical" | "edge" | "sibling";
36
- /** @description Classification of relationships. Used to group relationships similar in nature. */
37
- type: string;
38
- /** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
39
- subType: string;
40
- /**
41
- * @description Status of the relationship.
42
- * @enum {string}
43
- */
44
- status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
45
- /** @description Capabilities associated with the relationship. */
46
- capabilities?: {
47
- /**
48
- * @description Specifies the version of the schema to which the capability definition conforms.
49
- * @example [
50
- * "v1",
51
- * "v1alpha1",
52
- * "v2beta3",
53
- * "v1.custom-suffix",
54
- * "models.meshery.io/v1beta1",
55
- * "capability.meshery.io/v1alpha1"
56
- * ]
57
- */
58
- schemaVersion: string;
59
- /** @description Version of the capability definition. */
60
- version: string;
61
- /** @description Name of the capability in human-readible format. */
62
- displayName: string;
63
- /** @description A written representation of the purpose and characteristics of the capability. */
64
- description: string;
65
- /** @description Top-level categorization of the capability */
66
- kind: string;
67
- /** @description Classification of capabilities. Used to group capabilities similar in nature. */
68
- type: string;
69
- /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
70
- subType: string;
71
- /** @description Key that backs the capability. */
72
- key: string;
73
- /** @description State of the entity in which the capability is applicable. */
74
- entityState: ("declaration" | "instance")[];
75
- /**
76
- * @description Status of the capability
77
- * @default enabled
78
- * @enum {string}
79
- */
80
- status: "enabled" | "disabled";
81
- /** @description Metadata contains additional information associated with the capability. Extension point. */
82
- metadata?: { [key: string]: unknown };
83
- }[];
84
- /** @description Metadata contains additional information associated with the Relationship. */
85
- metadata?: {
86
- /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
87
- description?: string;
88
- /** @description Visualization styles for a relationship */
89
- styles?: {
90
- /** @description Primary color of the component used for UI representation. */
91
- primaryColor: string;
92
- /** @description Secondary color of the entity used for UI representation. */
93
- secondaryColor?: string;
94
- /** @description White SVG of the entity used for UI representation on dark background. */
95
- svgWhite: string;
96
- /** @description Colored SVG of the entity used for UI representation on light background. */
97
- svgColor: string;
98
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
99
- svgComplete?: string;
100
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
101
- color?: string;
102
- /**
103
- * Format: float
104
- * @description The opacity of the label text, including its outline.
105
- */
106
- "text-opacity"?: number;
107
- /** @description A comma-separated list of font names to use on the label text. */
108
- "font-family"?: string;
109
- /** @description The size of the label text. */
110
- "font-size"?: string;
111
- /** @description A CSS font style to be applied to the label text. */
112
- "font-style"?: string;
113
- /** @description A CSS font weight to be applied to the label text. */
114
- "font-weight"?: string;
115
- /**
116
- * @description A transformation to apply to the label text
117
- * @enum {string}
118
- */
119
- "text-transform"?: "none" | "uppercase" | "lowercase";
120
- /**
121
- * Format: float
122
- * @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
123
- */
124
- opacity?: number;
125
- /** @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. */
126
- "z-index"?: number;
127
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
128
- label?: string;
129
- /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
130
- "edge-animation"?: string;
131
- /**
132
- * @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.
133
- * @enum {string}
134
- */
135
- "curve-style"?:
136
- | "haystack"
137
- | "straight"
138
- | "bezier"
139
- | "unbundled-bezier"
140
- | "segments"
141
- | "taxi";
142
- /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
143
- "line-color"?: string;
144
- /**
145
- * @description The style of the edge's line.
146
- * @enum {string}
147
- */
148
- "line-style"?: "solid" | "dotted" | "dashed";
149
- /**
150
- * @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.
151
- * @enum {string}
152
- */
153
- "line-cap"?: "butt" | "round" | "square";
154
- /**
155
- * Format: float
156
- * @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.
157
- */
158
- "line-opacity"?: number;
159
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
160
- "target-arrow-color"?: string;
161
- /**
162
- * @description The shape of the edge's source arrow
163
- * @enum {string}
164
- */
165
- "target-arrow-shape"?:
166
- | "triangle"
167
- | "triangle-tee"
168
- | "circle-triangle"
169
- | "triangle-cross"
170
- | "triangle-backcurve"
171
- | "vee"
172
- | "tee"
173
- | "square"
174
- | "circle"
175
- | "diamond"
176
- | "chevron"
177
- | "none";
178
- /**
179
- * @description The fill state of the edge's source arrow
180
- * @enum {string}
181
- */
182
- "target-arrow-fill"?: "filled" | "hollow";
183
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
184
- "mid-target-arrow-color"?: string;
185
- /**
186
- * @description The shape of the edge's source arrow
187
- * @enum {string}
188
- */
189
- "mid-target-arrow-shape"?:
190
- | "triangle"
191
- | "triangle-tee"
192
- | "circle-triangle"
193
- | "triangle-cross"
194
- | "triangle-backcurve"
195
- | "vee"
196
- | "tee"
197
- | "square"
198
- | "circle"
199
- | "diamond"
200
- | "chevron"
201
- | "none";
202
- /**
203
- * @description The fill state of the edge's source arrow
204
- * @enum {string}
205
- */
206
- "mid-target-arrow-fill"?: "filled" | "hollow";
207
- /**
208
- * Format: float
209
- * @description Scaling for the arrow size.
210
- */
211
- "arrow-scale"?: number;
212
- /** @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 */
213
- "source-label"?: string;
214
- /** @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 */
215
- "target-label"?: string;
216
- };
217
- /** @description Indicates whether the relationship should be treated as a logical representation only */
218
- isAnnotation?: boolean;
219
- } & { [key: string]: unknown };
220
- /** @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 */
221
- model: {
222
- /**
223
- * Format: uuid
224
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
225
- */
226
- id: string;
227
- /** @description The unique name for the model within the scope of a registrant. */
228
- name: string;
229
- /** @description Version of the model definition. */
230
- version: string;
231
- /** @description Human-readable name for the model. */
232
- displayName: string;
233
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
234
- model: {
235
- /** @description Version of the model as defined by the registrant. */
236
- version: string;
237
- };
238
- registrant: {
239
- /** @description Kind of the registrant. */
240
- kind: string;
241
- };
242
- };
243
- /**
244
- * Format: uuid
245
- * @description Foreign key reference to the model
246
- */
247
- modelId?: string;
248
- /** @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. */
249
- evaluationQuery?: string;
250
- /** @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. */
251
- selectors?: {
252
- /** @description Selectors used to define relationships which are allowed. */
253
- allow: {
254
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
255
- from: {
9
+ schemas: {
10
+ /** @description Relationships define the nature of interaction between interconnected components in Meshery. The combination of relationship properties kind, type, and subtype characterize various genealogical relations among and between components. Relationships have selectors, selector sets, metadata, and optional parameters. Learn more at https://docs.meshery.io/concepts/logical/relationships. */
11
+ RelationshipDefinition: {
256
12
  /**
257
13
  * Format: uuid
258
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
14
+ * @description Uniquely identifies the entity
259
15
  */
260
- id?: string;
261
- kind?: string;
262
- /** @description Match configuration for selector */
263
- match?: {
264
- refs?: string[][];
265
- from?: {
16
+ id: string;
17
+ /**
18
+ * @description Specifies the version of the schema used for the relationship definition.
19
+ * @example [
20
+ * "v1",
21
+ * "v1alpha1",
22
+ * "v2beta3",
23
+ * "v1.custom-suffix",
24
+ * "models.meshery.io/v1beta1",
25
+ * "capability.meshery.io/v1alpha1"
26
+ * ]
27
+ */
28
+ schemaVersion: string;
29
+ /** @description Specifies the version of the relationship definition. */
30
+ version: string;
31
+ /**
32
+ * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
33
+ * @enum {string}
34
+ */
35
+ kind: "hierarchical" | "edge" | "sibling";
36
+ /** @description Classification of relationships. Used to group relationships similar in nature. */
37
+ type: string;
38
+ /** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
39
+ subType: string;
40
+ /**
41
+ * @description Status of the relationship.
42
+ * @enum {string}
43
+ */
44
+ status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
45
+ /** @description Capabilities associated with the relationship. */
46
+ capabilities?: {
266
47
  /**
267
- * Format: uuid
268
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
48
+ * @description Specifies the version of the schema to which the capability definition conforms.
49
+ * @example [
50
+ * "v1",
51
+ * "v1alpha1",
52
+ * "v2beta3",
53
+ * "v1.custom-suffix",
54
+ * "models.meshery.io/v1beta1",
55
+ * "capability.meshery.io/v1alpha1"
56
+ * ]
269
57
  */
270
- id?: string;
271
- kind: string;
272
- /** @description JSON ref to value from where patch should be applied. */
273
- mutatorRef?: string[][];
274
- mutatedRef?: string[][];
275
- }[];
276
- to?: {
58
+ schemaVersion: string;
59
+ /** @description Version of the capability definition. */
60
+ version: string;
61
+ /** @description Name of the capability in human-readible format. */
62
+ displayName: string;
63
+ /** @description A written representation of the purpose and characteristics of the capability. */
64
+ description: string;
65
+ /** @description Top-level categorization of the capability */
66
+ kind: string | "action" | "mutate" | "view" | "interaction";
67
+ /** @description Classification of capabilities. Used to group capabilities similar in nature. */
68
+ type: string;
69
+ /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
70
+ subType: string;
71
+ /** @description Key that backs the capability. */
72
+ key: string;
73
+ /** @description State of the entity in which the capability is applicable. */
74
+ entityState: ("declaration" | "instance")[];
75
+ /**
76
+ * @description Status of the capability
77
+ * @default enabled
78
+ * @enum {string}
79
+ */
80
+ status: "enabled" | "disabled";
81
+ /** @description Metadata contains additional information associated with the capability. Extension point. */
82
+ metadata?: {
83
+ [key: string]: unknown;
84
+ };
85
+ }[];
86
+ /** @description Metadata contains additional information associated with the Relationship. */
87
+ metadata?: {
88
+ /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
89
+ description?: string;
90
+ /** @description Visualization styles for a relationship */
91
+ styles?: {
92
+ /** @description Primary color of the component used for UI representation. */
93
+ primaryColor: string;
94
+ /** @description Secondary color of the entity used for UI representation. */
95
+ secondaryColor?: string;
96
+ /** @description White SVG of the entity used for UI representation on dark background. */
97
+ svgWhite: string;
98
+ /** @description Colored SVG of the entity used for UI representation on light background. */
99
+ svgColor: string;
100
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
101
+ svgComplete?: string;
102
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
103
+ color?: string;
104
+ /**
105
+ * Format: float
106
+ * @description The opacity of the label text, including its outline.
107
+ */
108
+ "text-opacity"?: number;
109
+ /** @description A comma-separated list of font names to use on the label text. */
110
+ "font-family"?: string;
111
+ /** @description The size of the label text. */
112
+ "font-size"?: string;
113
+ /** @description A CSS font style to be applied to the label text. */
114
+ "font-style"?: string;
115
+ /** @description A CSS font weight to be applied to the label text. */
116
+ "font-weight"?: string;
117
+ /**
118
+ * @description A transformation to apply to the label text
119
+ * @enum {string}
120
+ */
121
+ "text-transform"?: "none" | "uppercase" | "lowercase";
122
+ /**
123
+ * Format: float
124
+ * @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
125
+ */
126
+ opacity?: number;
127
+ /** @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. */
128
+ "z-index"?: number;
129
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
130
+ label?: string;
131
+ /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
132
+ "edge-animation"?: string;
133
+ /**
134
+ * @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.
135
+ * @enum {string}
136
+ */
137
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
138
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
139
+ "line-color"?: string;
140
+ /**
141
+ * @description The style of the edge's line.
142
+ * @enum {string}
143
+ */
144
+ "line-style"?: "solid" | "dotted" | "dashed";
145
+ /**
146
+ * @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.
147
+ * @enum {string}
148
+ */
149
+ "line-cap"?: "butt" | "round" | "square";
150
+ /**
151
+ * Format: float
152
+ * @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.
153
+ */
154
+ "line-opacity"?: number;
155
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
156
+ "target-arrow-color"?: string;
157
+ /**
158
+ * @description The shape of the edge's source arrow
159
+ * @enum {string}
160
+ */
161
+ "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
162
+ /**
163
+ * @description The fill state of the edge's source arrow
164
+ * @enum {string}
165
+ */
166
+ "target-arrow-fill"?: "filled" | "hollow";
167
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
168
+ "mid-target-arrow-color"?: string;
169
+ /**
170
+ * @description The shape of the edge's source arrow
171
+ * @enum {string}
172
+ */
173
+ "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
174
+ /**
175
+ * @description The fill state of the edge's source arrow
176
+ * @enum {string}
177
+ */
178
+ "mid-target-arrow-fill"?: "filled" | "hollow";
179
+ /**
180
+ * Format: float
181
+ * @description Scaling for the arrow size.
182
+ */
183
+ "arrow-scale"?: number;
184
+ /** @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 */
185
+ "source-label"?: string;
186
+ /** @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 */
187
+ "target-label"?: string;
188
+ };
189
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
190
+ isAnnotation?: boolean;
191
+ } & {
192
+ [key: string]: unknown;
193
+ };
194
+ /** @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 */
195
+ model: {
277
196
  /**
278
197
  * Format: uuid
279
198
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
280
199
  */
281
- id?: string;
282
- kind: string;
283
- /** @description JSON ref to value from where patch should be applied. */
284
- mutatorRef?: string[][];
285
- mutatedRef?: string[][];
286
- }[];
287
- };
288
- /** @description Match strategy matrix for the selector */
289
- match_strategy_matrix?: string[][];
290
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
291
- model?: {
292
- /**
293
- * Format: uuid
294
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
295
- */
296
- id: string;
297
- /** @description The unique name for the model within the scope of a registrant. */
298
- name: string;
299
- /** @description Version of the model definition. */
300
- version: string;
301
- /** @description Human-readable name for the model. */
302
- displayName: string;
303
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
304
- model: {
305
- /** @description Version of the model as defined by the registrant. */
200
+ id: string;
201
+ /**
202
+ * @description The unique name for the model within the scope of a registrant.
203
+ * @example cert-manager
204
+ */
205
+ name: string;
206
+ /** @description Version of the model definition. */
306
207
  version: string;
307
- };
308
- registrant: {
309
- /** @description Kind of the registrant. */
310
- kind: string;
311
- };
312
- };
313
- /** @description Patch configuration for the selector */
314
- patch?: {
315
- /**
316
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
317
- *
318
- * add: Inserts a value into an array or adds a member to an object.
319
- * replace: Replaces a value.
320
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
321
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
322
- * remove: Removes a value.
323
- * copy: Copies a value from one location to another.
324
- * move: Moves a value from one location to another.
325
- * test: Tests that a value at the target location is equal to a specified value.
326
- *
327
- * @enum {string}
328
- */
329
- patchStrategy?:
330
- | "merge"
331
- | "strategic"
332
- | "add"
333
- | "remove"
334
- | "copy"
335
- | "move"
336
- | "test";
337
- /** @description JSON ref to value from where patch should be applied. */
338
- mutatorRef?: string[][];
339
- mutatedRef?: string[][];
208
+ /**
209
+ * @description Human-readable name for the model.
210
+ * @example Cert Manager
211
+ */
212
+ displayName: string;
213
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
214
+ model: {
215
+ /** @description Version of the model as defined by the registrant. */
216
+ version: string;
217
+ };
218
+ registrant: {
219
+ /** @description Kind of the registrant. */
220
+ kind: string;
221
+ };
340
222
  };
341
- }[];
342
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
343
- to: {
223
+ /**
224
+ * Format: uuid
225
+ * @description Foreign key reference to the model
226
+ */
227
+ modelId?: string;
228
+ /** @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. */
229
+ evaluationQuery?: string;
230
+ /** @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. */
231
+ selectors?: {
232
+ /** @description Selectors used to define relationships which are allowed. */
233
+ allow: {
234
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
235
+ from: {
236
+ /**
237
+ * Format: uuid
238
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
239
+ */
240
+ id?: string;
241
+ kind?: string;
242
+ /** @description Match configuration for selector */
243
+ match?: {
244
+ refs?: string[][];
245
+ from?: {
246
+ /**
247
+ * Format: uuid
248
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
249
+ */
250
+ id?: string;
251
+ kind: string;
252
+ /** @description JSON ref to value from where patch should be applied. */
253
+ mutatorRef?: string[][];
254
+ mutatedRef?: string[][];
255
+ }[];
256
+ to?: {
257
+ /**
258
+ * Format: uuid
259
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
260
+ */
261
+ id?: string;
262
+ kind: string;
263
+ /** @description JSON ref to value from where patch should be applied. */
264
+ mutatorRef?: string[][];
265
+ mutatedRef?: string[][];
266
+ }[];
267
+ };
268
+ /** @description Match strategy matrix for the selector */
269
+ match_strategy_matrix?: string[][];
270
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
271
+ model?: {
272
+ /**
273
+ * Format: uuid
274
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
275
+ */
276
+ id: string;
277
+ /**
278
+ * @description The unique name for the model within the scope of a registrant.
279
+ * @example cert-manager
280
+ */
281
+ name: string;
282
+ /** @description Version of the model definition. */
283
+ version: string;
284
+ /**
285
+ * @description Human-readable name for the model.
286
+ * @example Cert Manager
287
+ */
288
+ displayName: string;
289
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
290
+ model: {
291
+ /** @description Version of the model as defined by the registrant. */
292
+ version: string;
293
+ };
294
+ registrant: {
295
+ /** @description Kind of the registrant. */
296
+ kind: string;
297
+ };
298
+ };
299
+ /** @description Patch configuration for the selector */
300
+ patch?: {
301
+ /**
302
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
303
+ *
304
+ * add: Inserts a value into an array or adds a member to an object.
305
+ * replace: Replaces a value.
306
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
307
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
308
+ * remove: Removes a value.
309
+ * copy: Copies a value from one location to another.
310
+ * move: Moves a value from one location to another.
311
+ * test: Tests that a value at the target location is equal to a specified value.
312
+ * @enum {string}
313
+ */
314
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
315
+ /** @description JSON ref to value from where patch should be applied. */
316
+ mutatorRef?: string[][];
317
+ mutatedRef?: string[][];
318
+ };
319
+ }[];
320
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
321
+ to: {
322
+ /**
323
+ * Format: uuid
324
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
325
+ */
326
+ id?: string;
327
+ kind?: string;
328
+ /** @description Match configuration for selector */
329
+ match?: {
330
+ refs?: string[][];
331
+ from?: {
332
+ /**
333
+ * Format: uuid
334
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
335
+ */
336
+ id?: string;
337
+ kind: string;
338
+ /** @description JSON ref to value from where patch should be applied. */
339
+ mutatorRef?: string[][];
340
+ mutatedRef?: string[][];
341
+ }[];
342
+ to?: {
343
+ /**
344
+ * Format: uuid
345
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
346
+ */
347
+ id?: string;
348
+ kind: string;
349
+ /** @description JSON ref to value from where patch should be applied. */
350
+ mutatorRef?: string[][];
351
+ mutatedRef?: string[][];
352
+ }[];
353
+ };
354
+ /** @description Match strategy matrix for the selector */
355
+ match_strategy_matrix?: string[][];
356
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
357
+ model?: {
358
+ /**
359
+ * Format: uuid
360
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
361
+ */
362
+ id: string;
363
+ /**
364
+ * @description The unique name for the model within the scope of a registrant.
365
+ * @example cert-manager
366
+ */
367
+ name: string;
368
+ /** @description Version of the model definition. */
369
+ version: string;
370
+ /**
371
+ * @description Human-readable name for the model.
372
+ * @example Cert Manager
373
+ */
374
+ displayName: string;
375
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
376
+ model: {
377
+ /** @description Version of the model as defined by the registrant. */
378
+ version: string;
379
+ };
380
+ registrant: {
381
+ /** @description Kind of the registrant. */
382
+ kind: string;
383
+ };
384
+ };
385
+ /** @description Patch configuration for the selector */
386
+ patch?: {
387
+ /**
388
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
389
+ *
390
+ * add: Inserts a value into an array or adds a member to an object.
391
+ * replace: Replaces a value.
392
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
393
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
394
+ * remove: Removes a value.
395
+ * copy: Copies a value from one location to another.
396
+ * move: Moves a value from one location to another.
397
+ * test: Tests that a value at the target location is equal to a specified value.
398
+ * @enum {string}
399
+ */
400
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
401
+ /** @description JSON ref to value from where patch should be applied. */
402
+ mutatorRef?: string[][];
403
+ mutatedRef?: string[][];
404
+ };
405
+ }[];
406
+ };
407
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
408
+ deny?: {
409
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
410
+ from: {
411
+ /**
412
+ * Format: uuid
413
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
414
+ */
415
+ id?: string;
416
+ kind?: string;
417
+ /** @description Match configuration for selector */
418
+ match?: {
419
+ refs?: string[][];
420
+ from?: {
421
+ /**
422
+ * Format: uuid
423
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
424
+ */
425
+ id?: string;
426
+ kind: string;
427
+ /** @description JSON ref to value from where patch should be applied. */
428
+ mutatorRef?: string[][];
429
+ mutatedRef?: string[][];
430
+ }[];
431
+ to?: {
432
+ /**
433
+ * Format: uuid
434
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
435
+ */
436
+ id?: string;
437
+ kind: string;
438
+ /** @description JSON ref to value from where patch should be applied. */
439
+ mutatorRef?: string[][];
440
+ mutatedRef?: string[][];
441
+ }[];
442
+ };
443
+ /** @description Match strategy matrix for the selector */
444
+ match_strategy_matrix?: string[][];
445
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
446
+ model?: {
447
+ /**
448
+ * Format: uuid
449
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
450
+ */
451
+ id: string;
452
+ /**
453
+ * @description The unique name for the model within the scope of a registrant.
454
+ * @example cert-manager
455
+ */
456
+ name: string;
457
+ /** @description Version of the model definition. */
458
+ version: string;
459
+ /**
460
+ * @description Human-readable name for the model.
461
+ * @example Cert Manager
462
+ */
463
+ displayName: string;
464
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
465
+ model: {
466
+ /** @description Version of the model as defined by the registrant. */
467
+ version: string;
468
+ };
469
+ registrant: {
470
+ /** @description Kind of the registrant. */
471
+ kind: string;
472
+ };
473
+ };
474
+ /** @description Patch configuration for the selector */
475
+ patch?: {
476
+ /**
477
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
478
+ *
479
+ * add: Inserts a value into an array or adds a member to an object.
480
+ * replace: Replaces a value.
481
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
482
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
483
+ * remove: Removes a value.
484
+ * copy: Copies a value from one location to another.
485
+ * move: Moves a value from one location to another.
486
+ * test: Tests that a value at the target location is equal to a specified value.
487
+ * @enum {string}
488
+ */
489
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
490
+ /** @description JSON ref to value from where patch should be applied. */
491
+ mutatorRef?: string[][];
492
+ mutatedRef?: string[][];
493
+ };
494
+ }[];
495
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
496
+ to: {
497
+ /**
498
+ * Format: uuid
499
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
500
+ */
501
+ id?: string;
502
+ kind?: string;
503
+ /** @description Match configuration for selector */
504
+ match?: {
505
+ refs?: string[][];
506
+ from?: {
507
+ /**
508
+ * Format: uuid
509
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
510
+ */
511
+ id?: string;
512
+ kind: string;
513
+ /** @description JSON ref to value from where patch should be applied. */
514
+ mutatorRef?: string[][];
515
+ mutatedRef?: string[][];
516
+ }[];
517
+ to?: {
518
+ /**
519
+ * Format: uuid
520
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
521
+ */
522
+ id?: string;
523
+ kind: string;
524
+ /** @description JSON ref to value from where patch should be applied. */
525
+ mutatorRef?: string[][];
526
+ mutatedRef?: string[][];
527
+ }[];
528
+ };
529
+ /** @description Match strategy matrix for the selector */
530
+ match_strategy_matrix?: string[][];
531
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
532
+ model?: {
533
+ /**
534
+ * Format: uuid
535
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
536
+ */
537
+ id: string;
538
+ /**
539
+ * @description The unique name for the model within the scope of a registrant.
540
+ * @example cert-manager
541
+ */
542
+ name: string;
543
+ /** @description Version of the model definition. */
544
+ version: string;
545
+ /**
546
+ * @description Human-readable name for the model.
547
+ * @example Cert Manager
548
+ */
549
+ displayName: string;
550
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
551
+ model: {
552
+ /** @description Version of the model as defined by the registrant. */
553
+ version: string;
554
+ };
555
+ registrant: {
556
+ /** @description Kind of the registrant. */
557
+ kind: string;
558
+ };
559
+ };
560
+ /** @description Patch configuration for the selector */
561
+ patch?: {
562
+ /**
563
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
564
+ *
565
+ * add: Inserts a value into an array or adds a member to an object.
566
+ * replace: Replaces a value.
567
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
568
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
569
+ * remove: Removes a value.
570
+ * copy: Copies a value from one location to another.
571
+ * move: Moves a value from one location to another.
572
+ * test: Tests that a value at the target location is equal to a specified value.
573
+ * @enum {string}
574
+ */
575
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
576
+ /** @description JSON ref to value from where patch should be applied. */
577
+ mutatorRef?: string[][];
578
+ mutatedRef?: string[][];
579
+ };
580
+ }[];
581
+ };
582
+ }[];
583
+ };
584
+ /** @description Match selector item for binding between nodes */
585
+ MatchSelectorItem: {
344
586
  /**
345
587
  * Format: uuid
346
588
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
347
589
  */
348
590
  id?: string;
349
- kind?: string;
350
- /** @description Match configuration for selector */
351
- match?: {
352
- refs?: string[][];
353
- from?: {
591
+ kind: string;
592
+ /** @description JSON ref to value from where patch should be applied. */
593
+ mutatorRef?: string[][];
594
+ mutatedRef?: string[][];
595
+ };
596
+ /** @description Match configuration for selector */
597
+ MatchSelector: {
598
+ refs?: string[][];
599
+ from?: {
354
600
  /**
355
601
  * Format: uuid
356
602
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -360,8 +606,8 @@ export interface components {
360
606
  /** @description JSON ref to value from where patch should be applied. */
361
607
  mutatorRef?: string[][];
362
608
  mutatedRef?: string[][];
363
- }[];
364
- to?: {
609
+ }[];
610
+ to?: {
365
611
  /**
366
612
  * Format: uuid
367
613
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -371,67 +617,30 @@ export interface components {
371
617
  /** @description JSON ref to value from where patch should be applied. */
372
618
  mutatorRef?: string[][];
373
619
  mutatedRef?: string[][];
374
- }[];
375
- };
376
- /** @description Match strategy matrix for the selector */
377
- match_strategy_matrix?: string[][];
378
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
379
- model?: {
380
- /**
381
- * Format: uuid
382
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
383
- */
384
- id: string;
385
- /** @description The unique name for the model within the scope of a registrant. */
386
- name: string;
387
- /** @description Version of the model definition. */
388
- version: string;
389
- /** @description Human-readable name for the model. */
390
- displayName: string;
391
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
392
- model: {
393
- /** @description Version of the model as defined by the registrant. */
394
- version: string;
395
- };
396
- registrant: {
397
- /** @description Kind of the registrant. */
398
- kind: string;
399
- };
400
- };
401
- /** @description Patch configuration for the selector */
402
- patch?: {
403
- /**
404
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
405
- *
406
- * add: Inserts a value into an array or adds a member to an object.
407
- * replace: Replaces a value.
408
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
409
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
410
- * remove: Removes a value.
411
- * copy: Copies a value from one location to another.
412
- * move: Moves a value from one location to another.
413
- * test: Tests that a value at the target location is equal to a specified value.
414
- *
415
- * @enum {string}
416
- */
417
- patchStrategy?:
418
- | "merge"
419
- | "strategic"
420
- | "add"
421
- | "remove"
422
- | "copy"
423
- | "move"
424
- | "test";
425
- /** @description JSON ref to value from where patch should be applied. */
426
- mutatorRef?: string[][];
427
- mutatedRef?: string[][];
428
- };
429
- }[];
620
+ }[];
621
+ };
622
+ /** @description Patch configuration for the selector */
623
+ RelationshipDefinition_Selectors_Patch: {
624
+ /**
625
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
626
+ *
627
+ * add: Inserts a value into an array or adds a member to an object.
628
+ * replace: Replaces a value.
629
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
630
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
631
+ * remove: Removes a value.
632
+ * copy: Copies a value from one location to another.
633
+ * move: Moves a value from one location to another.
634
+ * test: Tests that a value at the target location is equal to a specified value.
635
+ * @enum {string}
636
+ */
637
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
638
+ /** @description JSON ref to value from where patch should be applied. */
639
+ mutatorRef?: string[][];
640
+ mutatedRef?: string[][];
430
641
  };
431
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
432
- deny?: {
433
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
434
- from: {
642
+ /** @description Optional fields that are a part of the selector. Absence of a field has an implied * meaning. */
643
+ SelectorItem: {
435
644
  /**
436
645
  * Format: uuid
437
646
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -440,1498 +649,1176 @@ export interface components {
440
649
  kind?: string;
441
650
  /** @description Match configuration for selector */
442
651
  match?: {
443
- refs?: string[][];
444
- from?: {
652
+ refs?: string[][];
653
+ from?: {
654
+ /**
655
+ * Format: uuid
656
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
657
+ */
658
+ id?: string;
659
+ kind: string;
660
+ /** @description JSON ref to value from where patch should be applied. */
661
+ mutatorRef?: string[][];
662
+ mutatedRef?: string[][];
663
+ }[];
664
+ to?: {
665
+ /**
666
+ * Format: uuid
667
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
668
+ */
669
+ id?: string;
670
+ kind: string;
671
+ /** @description JSON ref to value from where patch should be applied. */
672
+ mutatorRef?: string[][];
673
+ mutatedRef?: string[][];
674
+ }[];
675
+ };
676
+ /** @description Match strategy matrix for the selector */
677
+ match_strategy_matrix?: string[][];
678
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
679
+ model?: {
445
680
  /**
446
681
  * Format: uuid
447
682
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
448
683
  */
449
- id?: string;
450
- kind: string;
451
- /** @description JSON ref to value from where patch should be applied. */
452
- mutatorRef?: string[][];
453
- mutatedRef?: string[][];
454
- }[];
455
- to?: {
684
+ id: string;
456
685
  /**
457
- * Format: uuid
458
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
686
+ * @description The unique name for the model within the scope of a registrant.
687
+ * @example cert-manager
459
688
  */
460
- id?: string;
461
- kind: string;
462
- /** @description JSON ref to value from where patch should be applied. */
463
- mutatorRef?: string[][];
464
- mutatedRef?: string[][];
465
- }[];
466
- };
467
- /** @description Match strategy matrix for the selector */
468
- match_strategy_matrix?: string[][];
469
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
470
- model?: {
471
- /**
472
- * Format: uuid
473
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
474
- */
475
- id: string;
476
- /** @description The unique name for the model within the scope of a registrant. */
477
- name: string;
478
- /** @description Version of the model definition. */
479
- version: string;
480
- /** @description Human-readable name for the model. */
481
- displayName: string;
482
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
483
- model: {
484
- /** @description Version of the model as defined by the registrant. */
689
+ name: string;
690
+ /** @description Version of the model definition. */
485
691
  version: string;
486
- };
487
- registrant: {
488
- /** @description Kind of the registrant. */
489
- kind: string;
490
- };
692
+ /**
693
+ * @description Human-readable name for the model.
694
+ * @example Cert Manager
695
+ */
696
+ displayName: string;
697
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
698
+ model: {
699
+ /** @description Version of the model as defined by the registrant. */
700
+ version: string;
701
+ };
702
+ registrant: {
703
+ /** @description Kind of the registrant. */
704
+ kind: string;
705
+ };
491
706
  };
492
707
  /** @description Patch configuration for the selector */
493
708
  patch?: {
494
- /**
495
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
496
- *
497
- * add: Inserts a value into an array or adds a member to an object.
498
- * replace: Replaces a value.
499
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
500
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
501
- * remove: Removes a value.
502
- * copy: Copies a value from one location to another.
503
- * move: Moves a value from one location to another.
504
- * test: Tests that a value at the target location is equal to a specified value.
505
- *
506
- * @enum {string}
507
- */
508
- patchStrategy?:
509
- | "merge"
510
- | "strategic"
511
- | "add"
512
- | "remove"
513
- | "copy"
514
- | "move"
515
- | "test";
516
- /** @description JSON ref to value from where patch should be applied. */
517
- mutatorRef?: string[][];
518
- mutatedRef?: string[][];
709
+ /**
710
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
711
+ *
712
+ * add: Inserts a value into an array or adds a member to an object.
713
+ * replace: Replaces a value.
714
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
715
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
716
+ * remove: Removes a value.
717
+ * copy: Copies a value from one location to another.
718
+ * move: Moves a value from one location to another.
719
+ * test: Tests that a value at the target location is equal to a specified value.
720
+ * @enum {string}
721
+ */
722
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
723
+ /** @description JSON ref to value from where patch should be applied. */
724
+ mutatorRef?: string[][];
725
+ mutatedRef?: string[][];
519
726
  };
520
- }[];
521
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
522
- to: {
523
- /**
524
- * Format: uuid
525
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
526
- */
527
- id?: string;
528
- kind?: string;
529
- /** @description Match configuration for selector */
530
- match?: {
531
- refs?: string[][];
532
- from?: {
727
+ };
728
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
729
+ Selector: {
730
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
731
+ from: {
533
732
  /**
534
733
  * Format: uuid
535
734
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
536
735
  */
537
736
  id?: string;
538
- kind: string;
539
- /** @description JSON ref to value from where patch should be applied. */
540
- mutatorRef?: string[][];
541
- mutatedRef?: string[][];
542
- }[];
543
- to?: {
737
+ kind?: string;
738
+ /** @description Match configuration for selector */
739
+ match?: {
740
+ refs?: string[][];
741
+ from?: {
742
+ /**
743
+ * Format: uuid
744
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
745
+ */
746
+ id?: string;
747
+ kind: string;
748
+ /** @description JSON ref to value from where patch should be applied. */
749
+ mutatorRef?: string[][];
750
+ mutatedRef?: string[][];
751
+ }[];
752
+ to?: {
753
+ /**
754
+ * Format: uuid
755
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
756
+ */
757
+ id?: string;
758
+ kind: string;
759
+ /** @description JSON ref to value from where patch should be applied. */
760
+ mutatorRef?: string[][];
761
+ mutatedRef?: string[][];
762
+ }[];
763
+ };
764
+ /** @description Match strategy matrix for the selector */
765
+ match_strategy_matrix?: string[][];
766
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
767
+ model?: {
768
+ /**
769
+ * Format: uuid
770
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
771
+ */
772
+ id: string;
773
+ /**
774
+ * @description The unique name for the model within the scope of a registrant.
775
+ * @example cert-manager
776
+ */
777
+ name: string;
778
+ /** @description Version of the model definition. */
779
+ version: string;
780
+ /**
781
+ * @description Human-readable name for the model.
782
+ * @example Cert Manager
783
+ */
784
+ displayName: string;
785
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
786
+ model: {
787
+ /** @description Version of the model as defined by the registrant. */
788
+ version: string;
789
+ };
790
+ registrant: {
791
+ /** @description Kind of the registrant. */
792
+ kind: string;
793
+ };
794
+ };
795
+ /** @description Patch configuration for the selector */
796
+ patch?: {
797
+ /**
798
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
799
+ *
800
+ * add: Inserts a value into an array or adds a member to an object.
801
+ * replace: Replaces a value.
802
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
803
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
804
+ * remove: Removes a value.
805
+ * copy: Copies a value from one location to another.
806
+ * move: Moves a value from one location to another.
807
+ * test: Tests that a value at the target location is equal to a specified value.
808
+ * @enum {string}
809
+ */
810
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
811
+ /** @description JSON ref to value from where patch should be applied. */
812
+ mutatorRef?: string[][];
813
+ mutatedRef?: string[][];
814
+ };
815
+ }[];
816
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
817
+ to: {
544
818
  /**
545
819
  * Format: uuid
546
820
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
547
821
  */
548
822
  id?: string;
549
- kind: string;
550
- /** @description JSON ref to value from where patch should be applied. */
551
- mutatorRef?: string[][];
552
- mutatedRef?: string[][];
553
- }[];
554
- };
555
- /** @description Match strategy matrix for the selector */
556
- match_strategy_matrix?: string[][];
557
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
558
- model?: {
559
- /**
560
- * Format: uuid
561
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
562
- */
563
- id: string;
564
- /** @description The unique name for the model within the scope of a registrant. */
565
- name: string;
566
- /** @description Version of the model definition. */
567
- version: string;
568
- /** @description Human-readable name for the model. */
569
- displayName: string;
570
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
571
- model: {
572
- /** @description Version of the model as defined by the registrant. */
573
- version: string;
574
- };
575
- registrant: {
576
- /** @description Kind of the registrant. */
577
- kind: string;
578
- };
823
+ kind?: string;
824
+ /** @description Match configuration for selector */
825
+ match?: {
826
+ refs?: string[][];
827
+ from?: {
828
+ /**
829
+ * Format: uuid
830
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
831
+ */
832
+ id?: string;
833
+ kind: string;
834
+ /** @description JSON ref to value from where patch should be applied. */
835
+ mutatorRef?: string[][];
836
+ mutatedRef?: string[][];
837
+ }[];
838
+ to?: {
839
+ /**
840
+ * Format: uuid
841
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
842
+ */
843
+ id?: string;
844
+ kind: string;
845
+ /** @description JSON ref to value from where patch should be applied. */
846
+ mutatorRef?: string[][];
847
+ mutatedRef?: string[][];
848
+ }[];
849
+ };
850
+ /** @description Match strategy matrix for the selector */
851
+ match_strategy_matrix?: string[][];
852
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
853
+ model?: {
854
+ /**
855
+ * Format: uuid
856
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
857
+ */
858
+ id: string;
859
+ /**
860
+ * @description The unique name for the model within the scope of a registrant.
861
+ * @example cert-manager
862
+ */
863
+ name: string;
864
+ /** @description Version of the model definition. */
865
+ version: string;
866
+ /**
867
+ * @description Human-readable name for the model.
868
+ * @example Cert Manager
869
+ */
870
+ displayName: string;
871
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
872
+ model: {
873
+ /** @description Version of the model as defined by the registrant. */
874
+ version: string;
875
+ };
876
+ registrant: {
877
+ /** @description Kind of the registrant. */
878
+ kind: string;
879
+ };
880
+ };
881
+ /** @description Patch configuration for the selector */
882
+ patch?: {
883
+ /**
884
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
885
+ *
886
+ * add: Inserts a value into an array or adds a member to an object.
887
+ * replace: Replaces a value.
888
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
889
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
890
+ * remove: Removes a value.
891
+ * copy: Copies a value from one location to another.
892
+ * move: Moves a value from one location to another.
893
+ * test: Tests that a value at the target location is equal to a specified value.
894
+ * @enum {string}
895
+ */
896
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
897
+ /** @description JSON ref to value from where patch should be applied. */
898
+ mutatorRef?: string[][];
899
+ mutatedRef?: string[][];
900
+ };
901
+ }[];
902
+ };
903
+ /** @description Optional selectors used to match Components. Absence of a selector means that it is applied to all Components. */
904
+ SelectorSetItem: {
905
+ /** @description Selectors used to define relationships which are allowed. */
906
+ allow: {
907
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
908
+ from: {
909
+ /**
910
+ * Format: uuid
911
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
912
+ */
913
+ id?: string;
914
+ kind?: string;
915
+ /** @description Match configuration for selector */
916
+ match?: {
917
+ refs?: string[][];
918
+ from?: {
919
+ /**
920
+ * Format: uuid
921
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
922
+ */
923
+ id?: string;
924
+ kind: string;
925
+ /** @description JSON ref to value from where patch should be applied. */
926
+ mutatorRef?: string[][];
927
+ mutatedRef?: string[][];
928
+ }[];
929
+ to?: {
930
+ /**
931
+ * Format: uuid
932
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
933
+ */
934
+ id?: string;
935
+ kind: string;
936
+ /** @description JSON ref to value from where patch should be applied. */
937
+ mutatorRef?: string[][];
938
+ mutatedRef?: string[][];
939
+ }[];
940
+ };
941
+ /** @description Match strategy matrix for the selector */
942
+ match_strategy_matrix?: string[][];
943
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
944
+ model?: {
945
+ /**
946
+ * Format: uuid
947
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
948
+ */
949
+ id: string;
950
+ /**
951
+ * @description The unique name for the model within the scope of a registrant.
952
+ * @example cert-manager
953
+ */
954
+ name: string;
955
+ /** @description Version of the model definition. */
956
+ version: string;
957
+ /**
958
+ * @description Human-readable name for the model.
959
+ * @example Cert Manager
960
+ */
961
+ displayName: string;
962
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
963
+ model: {
964
+ /** @description Version of the model as defined by the registrant. */
965
+ version: string;
966
+ };
967
+ registrant: {
968
+ /** @description Kind of the registrant. */
969
+ kind: string;
970
+ };
971
+ };
972
+ /** @description Patch configuration for the selector */
973
+ patch?: {
974
+ /**
975
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
976
+ *
977
+ * add: Inserts a value into an array or adds a member to an object.
978
+ * replace: Replaces a value.
979
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
980
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
981
+ * remove: Removes a value.
982
+ * copy: Copies a value from one location to another.
983
+ * move: Moves a value from one location to another.
984
+ * test: Tests that a value at the target location is equal to a specified value.
985
+ * @enum {string}
986
+ */
987
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
988
+ /** @description JSON ref to value from where patch should be applied. */
989
+ mutatorRef?: string[][];
990
+ mutatedRef?: string[][];
991
+ };
992
+ }[];
993
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
994
+ to: {
995
+ /**
996
+ * Format: uuid
997
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
998
+ */
999
+ id?: string;
1000
+ kind?: string;
1001
+ /** @description Match configuration for selector */
1002
+ match?: {
1003
+ refs?: string[][];
1004
+ from?: {
1005
+ /**
1006
+ * Format: uuid
1007
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1008
+ */
1009
+ id?: string;
1010
+ kind: string;
1011
+ /** @description JSON ref to value from where patch should be applied. */
1012
+ mutatorRef?: string[][];
1013
+ mutatedRef?: string[][];
1014
+ }[];
1015
+ to?: {
1016
+ /**
1017
+ * Format: uuid
1018
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1019
+ */
1020
+ id?: string;
1021
+ kind: string;
1022
+ /** @description JSON ref to value from where patch should be applied. */
1023
+ mutatorRef?: string[][];
1024
+ mutatedRef?: string[][];
1025
+ }[];
1026
+ };
1027
+ /** @description Match strategy matrix for the selector */
1028
+ match_strategy_matrix?: string[][];
1029
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1030
+ model?: {
1031
+ /**
1032
+ * Format: uuid
1033
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1034
+ */
1035
+ id: string;
1036
+ /**
1037
+ * @description The unique name for the model within the scope of a registrant.
1038
+ * @example cert-manager
1039
+ */
1040
+ name: string;
1041
+ /** @description Version of the model definition. */
1042
+ version: string;
1043
+ /**
1044
+ * @description Human-readable name for the model.
1045
+ * @example Cert Manager
1046
+ */
1047
+ displayName: string;
1048
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1049
+ model: {
1050
+ /** @description Version of the model as defined by the registrant. */
1051
+ version: string;
1052
+ };
1053
+ registrant: {
1054
+ /** @description Kind of the registrant. */
1055
+ kind: string;
1056
+ };
1057
+ };
1058
+ /** @description Patch configuration for the selector */
1059
+ patch?: {
1060
+ /**
1061
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1062
+ *
1063
+ * add: Inserts a value into an array or adds a member to an object.
1064
+ * replace: Replaces a value.
1065
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1066
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1067
+ * remove: Removes a value.
1068
+ * copy: Copies a value from one location to another.
1069
+ * move: Moves a value from one location to another.
1070
+ * test: Tests that a value at the target location is equal to a specified value.
1071
+ * @enum {string}
1072
+ */
1073
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1074
+ /** @description JSON ref to value from where patch should be applied. */
1075
+ mutatorRef?: string[][];
1076
+ mutatedRef?: string[][];
1077
+ };
1078
+ }[];
579
1079
  };
580
- /** @description Patch configuration for the selector */
581
- patch?: {
582
- /**
583
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
584
- *
585
- * add: Inserts a value into an array or adds a member to an object.
586
- * replace: Replaces a value.
587
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
588
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
589
- * remove: Removes a value.
590
- * copy: Copies a value from one location to another.
591
- * move: Moves a value from one location to another.
592
- * test: Tests that a value at the target location is equal to a specified value.
593
- *
594
- * @enum {string}
595
- */
596
- patchStrategy?:
597
- | "merge"
598
- | "strategic"
599
- | "add"
600
- | "remove"
601
- | "copy"
602
- | "move"
603
- | "test";
604
- /** @description JSON ref to value from where patch should be applied. */
605
- mutatorRef?: string[][];
606
- mutatedRef?: string[][];
1080
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1081
+ deny?: {
1082
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1083
+ from: {
1084
+ /**
1085
+ * Format: uuid
1086
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1087
+ */
1088
+ id?: string;
1089
+ kind?: string;
1090
+ /** @description Match configuration for selector */
1091
+ match?: {
1092
+ refs?: string[][];
1093
+ from?: {
1094
+ /**
1095
+ * Format: uuid
1096
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1097
+ */
1098
+ id?: string;
1099
+ kind: string;
1100
+ /** @description JSON ref to value from where patch should be applied. */
1101
+ mutatorRef?: string[][];
1102
+ mutatedRef?: string[][];
1103
+ }[];
1104
+ to?: {
1105
+ /**
1106
+ * Format: uuid
1107
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1108
+ */
1109
+ id?: string;
1110
+ kind: string;
1111
+ /** @description JSON ref to value from where patch should be applied. */
1112
+ mutatorRef?: string[][];
1113
+ mutatedRef?: string[][];
1114
+ }[];
1115
+ };
1116
+ /** @description Match strategy matrix for the selector */
1117
+ match_strategy_matrix?: string[][];
1118
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1119
+ model?: {
1120
+ /**
1121
+ * Format: uuid
1122
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1123
+ */
1124
+ id: string;
1125
+ /**
1126
+ * @description The unique name for the model within the scope of a registrant.
1127
+ * @example cert-manager
1128
+ */
1129
+ name: string;
1130
+ /** @description Version of the model definition. */
1131
+ version: string;
1132
+ /**
1133
+ * @description Human-readable name for the model.
1134
+ * @example Cert Manager
1135
+ */
1136
+ displayName: string;
1137
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1138
+ model: {
1139
+ /** @description Version of the model as defined by the registrant. */
1140
+ version: string;
1141
+ };
1142
+ registrant: {
1143
+ /** @description Kind of the registrant. */
1144
+ kind: string;
1145
+ };
1146
+ };
1147
+ /** @description Patch configuration for the selector */
1148
+ patch?: {
1149
+ /**
1150
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1151
+ *
1152
+ * add: Inserts a value into an array or adds a member to an object.
1153
+ * replace: Replaces a value.
1154
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1155
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1156
+ * remove: Removes a value.
1157
+ * copy: Copies a value from one location to another.
1158
+ * move: Moves a value from one location to another.
1159
+ * test: Tests that a value at the target location is equal to a specified value.
1160
+ * @enum {string}
1161
+ */
1162
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1163
+ /** @description JSON ref to value from where patch should be applied. */
1164
+ mutatorRef?: string[][];
1165
+ mutatedRef?: string[][];
1166
+ };
1167
+ }[];
1168
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1169
+ to: {
1170
+ /**
1171
+ * Format: uuid
1172
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1173
+ */
1174
+ id?: string;
1175
+ kind?: string;
1176
+ /** @description Match configuration for selector */
1177
+ match?: {
1178
+ refs?: string[][];
1179
+ from?: {
1180
+ /**
1181
+ * Format: uuid
1182
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1183
+ */
1184
+ id?: string;
1185
+ kind: string;
1186
+ /** @description JSON ref to value from where patch should be applied. */
1187
+ mutatorRef?: string[][];
1188
+ mutatedRef?: string[][];
1189
+ }[];
1190
+ to?: {
1191
+ /**
1192
+ * Format: uuid
1193
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1194
+ */
1195
+ id?: string;
1196
+ kind: string;
1197
+ /** @description JSON ref to value from where patch should be applied. */
1198
+ mutatorRef?: string[][];
1199
+ mutatedRef?: string[][];
1200
+ }[];
1201
+ };
1202
+ /** @description Match strategy matrix for the selector */
1203
+ match_strategy_matrix?: string[][];
1204
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1205
+ model?: {
1206
+ /**
1207
+ * Format: uuid
1208
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1209
+ */
1210
+ id: string;
1211
+ /**
1212
+ * @description The unique name for the model within the scope of a registrant.
1213
+ * @example cert-manager
1214
+ */
1215
+ name: string;
1216
+ /** @description Version of the model definition. */
1217
+ version: string;
1218
+ /**
1219
+ * @description Human-readable name for the model.
1220
+ * @example Cert Manager
1221
+ */
1222
+ displayName: string;
1223
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1224
+ model: {
1225
+ /** @description Version of the model as defined by the registrant. */
1226
+ version: string;
1227
+ };
1228
+ registrant: {
1229
+ /** @description Kind of the registrant. */
1230
+ kind: string;
1231
+ };
1232
+ };
1233
+ /** @description Patch configuration for the selector */
1234
+ patch?: {
1235
+ /**
1236
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1237
+ *
1238
+ * add: Inserts a value into an array or adds a member to an object.
1239
+ * replace: Replaces a value.
1240
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1241
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1242
+ * remove: Removes a value.
1243
+ * copy: Copies a value from one location to another.
1244
+ * move: Moves a value from one location to another.
1245
+ * test: Tests that a value at the target location is equal to a specified value.
1246
+ * @enum {string}
1247
+ */
1248
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1249
+ /** @description JSON ref to value from where patch should be applied. */
1250
+ mutatorRef?: string[][];
1251
+ mutatedRef?: string[][];
1252
+ };
1253
+ }[];
607
1254
  };
608
- }[];
609
1255
  };
610
- }[];
611
- };
612
- /** @description Match selector item for binding between nodes */
613
- MatchSelectorItem: {
614
- /**
615
- * Format: uuid
616
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
617
- */
618
- id?: string;
619
- kind: string;
620
- /** @description JSON ref to value from where patch should be applied. */
621
- mutatorRef?: string[][];
622
- mutatedRef?: string[][];
623
- };
624
- /** @description Match configuration for selector */
625
- MatchSelector: {
626
- refs?: string[][];
627
- from?: {
628
- /**
629
- * Format: uuid
630
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
631
- */
632
- id?: string;
633
- kind: string;
634
- /** @description JSON ref to value from where patch should be applied. */
635
- mutatorRef?: string[][];
636
- mutatedRef?: string[][];
637
- }[];
638
- to?: {
639
- /**
640
- * Format: uuid
641
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
642
- */
643
- id?: string;
644
- kind: string;
645
- /** @description JSON ref to value from where patch should be applied. */
646
- mutatorRef?: string[][];
647
- mutatedRef?: string[][];
648
- }[];
649
- };
650
- /** @description Patch configuration for the selector */
651
- RelationshipDefinition_Selectors_Patch: {
652
- /**
653
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
654
- *
655
- * add: Inserts a value into an array or adds a member to an object.
656
- * replace: Replaces a value.
657
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
658
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
659
- * remove: Removes a value.
660
- * copy: Copies a value from one location to another.
661
- * move: Moves a value from one location to another.
662
- * test: Tests that a value at the target location is equal to a specified value.
663
- *
664
- * @enum {string}
665
- */
666
- patchStrategy?:
667
- | "merge"
668
- | "strategic"
669
- | "add"
670
- | "remove"
671
- | "copy"
672
- | "move"
673
- | "test";
674
- /** @description JSON ref to value from where patch should be applied. */
675
- mutatorRef?: string[][];
676
- mutatedRef?: string[][];
677
- };
678
- /** @description Optional fields that are a part of the selector. Absence of a field has an implied * meaning. */
679
- SelectorItem: {
680
- /**
681
- * Format: uuid
682
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
683
- */
684
- id?: string;
685
- kind?: string;
686
- /** @description Match configuration for selector */
687
- match?: {
688
- refs?: string[][];
689
- from?: {
690
- /**
691
- * Format: uuid
692
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
693
- */
694
- id?: string;
695
- kind: string;
696
- /** @description JSON ref to value from where patch should be applied. */
697
- mutatorRef?: string[][];
698
- mutatedRef?: string[][];
699
- }[];
700
- to?: {
701
- /**
702
- * Format: uuid
703
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
704
- */
705
- id?: string;
706
- kind: string;
707
- /** @description JSON ref to value from where patch should be applied. */
708
- mutatorRef?: string[][];
709
- mutatedRef?: string[][];
710
- }[];
711
- };
712
- /** @description Match strategy matrix for the selector */
713
- match_strategy_matrix?: string[][];
714
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
715
- model?: {
716
- /**
717
- * Format: uuid
718
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
719
- */
720
- id: string;
721
- /** @description The unique name for the model within the scope of a registrant. */
722
- name: string;
723
- /** @description Version of the model definition. */
724
- version: string;
725
- /** @description Human-readable name for the model. */
726
- displayName: string;
727
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
728
- model: {
729
- /** @description Version of the model as defined by the registrant. */
730
- version: string;
731
- };
732
- registrant: {
733
- /** @description Kind of the registrant. */
734
- kind: string;
735
- };
736
- };
737
- /** @description Patch configuration for the selector */
738
- patch?: {
739
- /**
740
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
741
- *
742
- * add: Inserts a value into an array or adds a member to an object.
743
- * replace: Replaces a value.
744
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
745
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
746
- * remove: Removes a value.
747
- * copy: Copies a value from one location to another.
748
- * move: Moves a value from one location to another.
749
- * test: Tests that a value at the target location is equal to a specified value.
750
- *
751
- * @enum {string}
752
- */
753
- patchStrategy?:
754
- | "merge"
755
- | "strategic"
756
- | "add"
757
- | "remove"
758
- | "copy"
759
- | "move"
760
- | "test";
761
- /** @description JSON ref to value from where patch should be applied. */
762
- mutatorRef?: string[][];
763
- mutatedRef?: string[][];
764
- };
765
- };
766
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
767
- Selector: {
768
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
769
- from: {
770
- /**
771
- * Format: uuid
772
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
773
- */
774
- id?: string;
775
- kind?: string;
776
- /** @description Match configuration for selector */
777
- match?: {
778
- refs?: string[][];
779
- from?: {
780
- /**
781
- * Format: uuid
782
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
783
- */
784
- id?: string;
785
- kind: string;
786
- /** @description JSON ref to value from where patch should be applied. */
787
- mutatorRef?: string[][];
788
- mutatedRef?: string[][];
789
- }[];
790
- to?: {
791
- /**
792
- * Format: uuid
793
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
794
- */
795
- id?: string;
796
- kind: string;
797
- /** @description JSON ref to value from where patch should be applied. */
798
- mutatorRef?: string[][];
799
- mutatedRef?: string[][];
800
- }[];
801
- };
802
- /** @description Match strategy matrix for the selector */
803
- match_strategy_matrix?: string[][];
804
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
805
- model?: {
806
- /**
807
- * Format: uuid
808
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
809
- */
810
- id: string;
811
- /** @description The unique name for the model within the scope of a registrant. */
812
- name: string;
813
- /** @description Version of the model definition. */
814
- version: string;
815
- /** @description Human-readable name for the model. */
816
- displayName: string;
817
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
818
- model: {
819
- /** @description Version of the model as defined by the registrant. */
820
- version: string;
821
- };
822
- registrant: {
823
- /** @description Kind of the registrant. */
824
- kind: string;
825
- };
826
- };
827
- /** @description Patch configuration for the selector */
828
- patch?: {
829
- /**
830
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
831
- *
832
- * add: Inserts a value into an array or adds a member to an object.
833
- * replace: Replaces a value.
834
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
835
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
836
- * remove: Removes a value.
837
- * copy: Copies a value from one location to another.
838
- * move: Moves a value from one location to another.
839
- * test: Tests that a value at the target location is equal to a specified value.
840
- *
841
- * @enum {string}
842
- */
843
- patchStrategy?:
844
- | "merge"
845
- | "strategic"
846
- | "add"
847
- | "remove"
848
- | "copy"
849
- | "move"
850
- | "test";
851
- /** @description JSON ref to value from where patch should be applied. */
852
- mutatorRef?: string[][];
853
- mutatedRef?: string[][];
854
- };
855
- }[];
856
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
857
- to: {
858
- /**
859
- * Format: uuid
860
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
861
- */
862
- id?: string;
863
- kind?: string;
864
- /** @description Match configuration for selector */
865
- match?: {
866
- refs?: string[][];
867
- from?: {
868
- /**
869
- * Format: uuid
870
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
871
- */
872
- id?: string;
873
- kind: string;
874
- /** @description JSON ref to value from where patch should be applied. */
875
- mutatorRef?: string[][];
876
- mutatedRef?: string[][];
877
- }[];
878
- to?: {
879
- /**
880
- * Format: uuid
881
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
882
- */
883
- id?: string;
884
- kind: string;
885
- /** @description JSON ref to value from where patch should be applied. */
886
- mutatorRef?: string[][];
887
- mutatedRef?: string[][];
888
- }[];
889
- };
890
- /** @description Match strategy matrix for the selector */
891
- match_strategy_matrix?: string[][];
892
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
893
- model?: {
894
- /**
895
- * Format: uuid
896
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
897
- */
898
- id: string;
899
- /** @description The unique name for the model within the scope of a registrant. */
900
- name: string;
901
- /** @description Version of the model definition. */
902
- version: string;
903
- /** @description Human-readable name for the model. */
904
- displayName: string;
905
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
906
- model: {
907
- /** @description Version of the model as defined by the registrant. */
908
- version: string;
909
- };
910
- registrant: {
911
- /** @description Kind of the registrant. */
912
- kind: string;
913
- };
914
- };
915
- /** @description Patch configuration for the selector */
916
- patch?: {
917
- /**
918
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
919
- *
920
- * add: Inserts a value into an array or adds a member to an object.
921
- * replace: Replaces a value.
922
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
923
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
924
- * remove: Removes a value.
925
- * copy: Copies a value from one location to another.
926
- * move: Moves a value from one location to another.
927
- * test: Tests that a value at the target location is equal to a specified value.
928
- *
929
- * @enum {string}
930
- */
931
- patchStrategy?:
932
- | "merge"
933
- | "strategic"
934
- | "add"
935
- | "remove"
936
- | "copy"
937
- | "move"
938
- | "test";
939
- /** @description JSON ref to value from where patch should be applied. */
940
- mutatorRef?: string[][];
941
- mutatedRef?: string[][];
942
- };
943
- }[];
944
- };
945
- /** @description Optional selectors used to match Components. Absence of a selector means that it is applied to all Components. */
946
- SelectorSetItem: {
947
- /** @description Selectors used to define relationships which are allowed. */
948
- allow: {
949
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
950
- from: {
951
- /**
952
- * Format: uuid
953
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
954
- */
955
- id?: string;
956
- kind?: string;
957
- /** @description Match configuration for selector */
958
- match?: {
959
- refs?: string[][];
960
- from?: {
961
- /**
962
- * Format: uuid
963
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
964
- */
965
- id?: string;
966
- kind: string;
967
- /** @description JSON ref to value from where patch should be applied. */
968
- mutatorRef?: string[][];
969
- mutatedRef?: string[][];
970
- }[];
971
- to?: {
972
- /**
973
- * Format: uuid
974
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
975
- */
976
- id?: string;
977
- kind: string;
978
- /** @description JSON ref to value from where patch should be applied. */
979
- mutatorRef?: string[][];
980
- mutatedRef?: string[][];
981
- }[];
982
- };
983
- /** @description Match strategy matrix for the selector */
984
- match_strategy_matrix?: string[][];
985
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
986
- model?: {
987
- /**
988
- * Format: uuid
989
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
990
- */
991
- id: string;
992
- /** @description The unique name for the model within the scope of a registrant. */
993
- name: string;
994
- /** @description Version of the model definition. */
995
- version: string;
996
- /** @description Human-readable name for the model. */
997
- displayName: string;
998
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
999
- model: {
1000
- /** @description Version of the model as defined by the registrant. */
1001
- version: string;
1256
+ /** @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. */
1257
+ SelectorSet: {
1258
+ /** @description Selectors used to define relationships which are allowed. */
1259
+ allow: {
1260
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1261
+ from: {
1262
+ /**
1263
+ * Format: uuid
1264
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1265
+ */
1266
+ id?: string;
1267
+ kind?: string;
1268
+ /** @description Match configuration for selector */
1269
+ match?: {
1270
+ refs?: string[][];
1271
+ from?: {
1272
+ /**
1273
+ * Format: uuid
1274
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1275
+ */
1276
+ id?: string;
1277
+ kind: string;
1278
+ /** @description JSON ref to value from where patch should be applied. */
1279
+ mutatorRef?: string[][];
1280
+ mutatedRef?: string[][];
1281
+ }[];
1282
+ to?: {
1283
+ /**
1284
+ * Format: uuid
1285
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1286
+ */
1287
+ id?: string;
1288
+ kind: string;
1289
+ /** @description JSON ref to value from where patch should be applied. */
1290
+ mutatorRef?: string[][];
1291
+ mutatedRef?: string[][];
1292
+ }[];
1293
+ };
1294
+ /** @description Match strategy matrix for the selector */
1295
+ match_strategy_matrix?: string[][];
1296
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1297
+ model?: {
1298
+ /**
1299
+ * Format: uuid
1300
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1301
+ */
1302
+ id: string;
1303
+ /**
1304
+ * @description The unique name for the model within the scope of a registrant.
1305
+ * @example cert-manager
1306
+ */
1307
+ name: string;
1308
+ /** @description Version of the model definition. */
1309
+ version: string;
1310
+ /**
1311
+ * @description Human-readable name for the model.
1312
+ * @example Cert Manager
1313
+ */
1314
+ displayName: string;
1315
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1316
+ model: {
1317
+ /** @description Version of the model as defined by the registrant. */
1318
+ version: string;
1319
+ };
1320
+ registrant: {
1321
+ /** @description Kind of the registrant. */
1322
+ kind: string;
1323
+ };
1324
+ };
1325
+ /** @description Patch configuration for the selector */
1326
+ patch?: {
1327
+ /**
1328
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1329
+ *
1330
+ * add: Inserts a value into an array or adds a member to an object.
1331
+ * replace: Replaces a value.
1332
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1333
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1334
+ * remove: Removes a value.
1335
+ * copy: Copies a value from one location to another.
1336
+ * move: Moves a value from one location to another.
1337
+ * test: Tests that a value at the target location is equal to a specified value.
1338
+ * @enum {string}
1339
+ */
1340
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1341
+ /** @description JSON ref to value from where patch should be applied. */
1342
+ mutatorRef?: string[][];
1343
+ mutatedRef?: string[][];
1344
+ };
1345
+ }[];
1346
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1347
+ to: {
1348
+ /**
1349
+ * Format: uuid
1350
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1351
+ */
1352
+ id?: string;
1353
+ kind?: string;
1354
+ /** @description Match configuration for selector */
1355
+ match?: {
1356
+ refs?: string[][];
1357
+ from?: {
1358
+ /**
1359
+ * Format: uuid
1360
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1361
+ */
1362
+ id?: string;
1363
+ kind: string;
1364
+ /** @description JSON ref to value from where patch should be applied. */
1365
+ mutatorRef?: string[][];
1366
+ mutatedRef?: string[][];
1367
+ }[];
1368
+ to?: {
1369
+ /**
1370
+ * Format: uuid
1371
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1372
+ */
1373
+ id?: string;
1374
+ kind: string;
1375
+ /** @description JSON ref to value from where patch should be applied. */
1376
+ mutatorRef?: string[][];
1377
+ mutatedRef?: string[][];
1378
+ }[];
1379
+ };
1380
+ /** @description Match strategy matrix for the selector */
1381
+ match_strategy_matrix?: string[][];
1382
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1383
+ model?: {
1384
+ /**
1385
+ * Format: uuid
1386
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1387
+ */
1388
+ id: string;
1389
+ /**
1390
+ * @description The unique name for the model within the scope of a registrant.
1391
+ * @example cert-manager
1392
+ */
1393
+ name: string;
1394
+ /** @description Version of the model definition. */
1395
+ version: string;
1396
+ /**
1397
+ * @description Human-readable name for the model.
1398
+ * @example Cert Manager
1399
+ */
1400
+ displayName: string;
1401
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1402
+ model: {
1403
+ /** @description Version of the model as defined by the registrant. */
1404
+ version: string;
1405
+ };
1406
+ registrant: {
1407
+ /** @description Kind of the registrant. */
1408
+ kind: string;
1409
+ };
1410
+ };
1411
+ /** @description Patch configuration for the selector */
1412
+ patch?: {
1413
+ /**
1414
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1415
+ *
1416
+ * add: Inserts a value into an array or adds a member to an object.
1417
+ * replace: Replaces a value.
1418
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1419
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1420
+ * remove: Removes a value.
1421
+ * copy: Copies a value from one location to another.
1422
+ * move: Moves a value from one location to another.
1423
+ * test: Tests that a value at the target location is equal to a specified value.
1424
+ * @enum {string}
1425
+ */
1426
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1427
+ /** @description JSON ref to value from where patch should be applied. */
1428
+ mutatorRef?: string[][];
1429
+ mutatedRef?: string[][];
1430
+ };
1431
+ }[];
1002
1432
  };
1003
- registrant: {
1004
- /** @description Kind of the registrant. */
1005
- kind: string;
1433
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1434
+ deny?: {
1435
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1436
+ from: {
1437
+ /**
1438
+ * Format: uuid
1439
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1440
+ */
1441
+ id?: string;
1442
+ kind?: string;
1443
+ /** @description Match configuration for selector */
1444
+ match?: {
1445
+ refs?: string[][];
1446
+ from?: {
1447
+ /**
1448
+ * Format: uuid
1449
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1450
+ */
1451
+ id?: string;
1452
+ kind: string;
1453
+ /** @description JSON ref to value from where patch should be applied. */
1454
+ mutatorRef?: string[][];
1455
+ mutatedRef?: string[][];
1456
+ }[];
1457
+ to?: {
1458
+ /**
1459
+ * Format: uuid
1460
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1461
+ */
1462
+ id?: string;
1463
+ kind: string;
1464
+ /** @description JSON ref to value from where patch should be applied. */
1465
+ mutatorRef?: string[][];
1466
+ mutatedRef?: string[][];
1467
+ }[];
1468
+ };
1469
+ /** @description Match strategy matrix for the selector */
1470
+ match_strategy_matrix?: string[][];
1471
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1472
+ model?: {
1473
+ /**
1474
+ * Format: uuid
1475
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1476
+ */
1477
+ id: string;
1478
+ /**
1479
+ * @description The unique name for the model within the scope of a registrant.
1480
+ * @example cert-manager
1481
+ */
1482
+ name: string;
1483
+ /** @description Version of the model definition. */
1484
+ version: string;
1485
+ /**
1486
+ * @description Human-readable name for the model.
1487
+ * @example Cert Manager
1488
+ */
1489
+ displayName: string;
1490
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1491
+ model: {
1492
+ /** @description Version of the model as defined by the registrant. */
1493
+ version: string;
1494
+ };
1495
+ registrant: {
1496
+ /** @description Kind of the registrant. */
1497
+ kind: string;
1498
+ };
1499
+ };
1500
+ /** @description Patch configuration for the selector */
1501
+ patch?: {
1502
+ /**
1503
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1504
+ *
1505
+ * add: Inserts a value into an array or adds a member to an object.
1506
+ * replace: Replaces a value.
1507
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1508
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1509
+ * remove: Removes a value.
1510
+ * copy: Copies a value from one location to another.
1511
+ * move: Moves a value from one location to another.
1512
+ * test: Tests that a value at the target location is equal to a specified value.
1513
+ * @enum {string}
1514
+ */
1515
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1516
+ /** @description JSON ref to value from where patch should be applied. */
1517
+ mutatorRef?: string[][];
1518
+ mutatedRef?: string[][];
1519
+ };
1520
+ }[];
1521
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1522
+ to: {
1523
+ /**
1524
+ * Format: uuid
1525
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1526
+ */
1527
+ id?: string;
1528
+ kind?: string;
1529
+ /** @description Match configuration for selector */
1530
+ match?: {
1531
+ refs?: string[][];
1532
+ from?: {
1533
+ /**
1534
+ * Format: uuid
1535
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1536
+ */
1537
+ id?: string;
1538
+ kind: string;
1539
+ /** @description JSON ref to value from where patch should be applied. */
1540
+ mutatorRef?: string[][];
1541
+ mutatedRef?: string[][];
1542
+ }[];
1543
+ to?: {
1544
+ /**
1545
+ * Format: uuid
1546
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1547
+ */
1548
+ id?: string;
1549
+ kind: string;
1550
+ /** @description JSON ref to value from where patch should be applied. */
1551
+ mutatorRef?: string[][];
1552
+ mutatedRef?: string[][];
1553
+ }[];
1554
+ };
1555
+ /** @description Match strategy matrix for the selector */
1556
+ match_strategy_matrix?: string[][];
1557
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1558
+ model?: {
1559
+ /**
1560
+ * Format: uuid
1561
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1562
+ */
1563
+ id: string;
1564
+ /**
1565
+ * @description The unique name for the model within the scope of a registrant.
1566
+ * @example cert-manager
1567
+ */
1568
+ name: string;
1569
+ /** @description Version of the model definition. */
1570
+ version: string;
1571
+ /**
1572
+ * @description Human-readable name for the model.
1573
+ * @example Cert Manager
1574
+ */
1575
+ displayName: string;
1576
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1577
+ model: {
1578
+ /** @description Version of the model as defined by the registrant. */
1579
+ version: string;
1580
+ };
1581
+ registrant: {
1582
+ /** @description Kind of the registrant. */
1583
+ kind: string;
1584
+ };
1585
+ };
1586
+ /** @description Patch configuration for the selector */
1587
+ patch?: {
1588
+ /**
1589
+ * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1590
+ *
1591
+ * add: Inserts a value into an array or adds a member to an object.
1592
+ * replace: Replaces a value.
1593
+ * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1594
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1595
+ * remove: Removes a value.
1596
+ * copy: Copies a value from one location to another.
1597
+ * move: Moves a value from one location to another.
1598
+ * test: Tests that a value at the target location is equal to a specified value.
1599
+ * @enum {string}
1600
+ */
1601
+ patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1602
+ /** @description JSON ref to value from where patch should be applied. */
1603
+ mutatorRef?: string[][];
1604
+ mutatedRef?: string[][];
1605
+ };
1606
+ }[];
1006
1607
  };
1007
- };
1008
- /** @description Patch configuration for the selector */
1009
- patch?: {
1010
- /**
1011
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1012
- *
1013
- * add: Inserts a value into an array or adds a member to an object.
1014
- * replace: Replaces a value.
1015
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1016
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1017
- * remove: Removes a value.
1018
- * copy: Copies a value from one location to another.
1019
- * move: Moves a value from one location to another.
1020
- * test: Tests that a value at the target location is equal to a specified value.
1021
- *
1022
- * @enum {string}
1023
- */
1024
- patchStrategy?:
1025
- | "merge"
1026
- | "strategic"
1027
- | "add"
1028
- | "remove"
1029
- | "copy"
1030
- | "move"
1031
- | "test";
1032
- /** @description JSON ref to value from where patch should be applied. */
1033
- mutatorRef?: string[][];
1034
- mutatedRef?: string[][];
1035
- };
1036
1608
  }[];
1037
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1038
- to: {
1039
- /**
1040
- * Format: uuid
1041
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1042
- */
1043
- id?: string;
1044
- kind?: string;
1045
- /** @description Match configuration for selector */
1046
- match?: {
1047
- refs?: string[][];
1048
- from?: {
1049
- /**
1050
- * Format: uuid
1051
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1052
- */
1053
- id?: string;
1054
- kind: string;
1055
- /** @description JSON ref to value from where patch should be applied. */
1056
- mutatorRef?: string[][];
1057
- mutatedRef?: string[][];
1058
- }[];
1059
- to?: {
1060
- /**
1061
- * Format: uuid
1062
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1063
- */
1064
- id?: string;
1065
- kind: string;
1066
- /** @description JSON ref to value from where patch should be applied. */
1067
- mutatorRef?: string[][];
1068
- mutatedRef?: string[][];
1069
- }[];
1070
- };
1071
- /** @description Match strategy matrix for the selector */
1072
- match_strategy_matrix?: string[][];
1073
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1074
- model?: {
1075
- /**
1076
- * Format: uuid
1077
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1078
- */
1079
- id: string;
1080
- /** @description The unique name for the model within the scope of a registrant. */
1081
- name: string;
1082
- /** @description Version of the model definition. */
1083
- version: string;
1084
- /** @description Human-readable name for the model. */
1085
- displayName: string;
1086
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1087
- model: {
1088
- /** @description Version of the model as defined by the registrant. */
1089
- version: string;
1090
- };
1091
- registrant: {
1092
- /** @description Kind of the registrant. */
1093
- kind: string;
1609
+ /** @description Metadata contains additional information associated with the Relationship. */
1610
+ Relationship_Metadata: {
1611
+ /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
1612
+ description?: string;
1613
+ /** @description Visualization styles for a relationship */
1614
+ styles?: {
1615
+ /** @description Primary color of the component used for UI representation. */
1616
+ primaryColor: string;
1617
+ /** @description Secondary color of the entity used for UI representation. */
1618
+ secondaryColor?: string;
1619
+ /** @description White SVG of the entity used for UI representation on dark background. */
1620
+ svgWhite: string;
1621
+ /** @description Colored SVG of the entity used for UI representation on light background. */
1622
+ svgColor: string;
1623
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1624
+ svgComplete?: string;
1625
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
1626
+ color?: string;
1627
+ /**
1628
+ * Format: float
1629
+ * @description The opacity of the label text, including its outline.
1630
+ */
1631
+ "text-opacity"?: number;
1632
+ /** @description A comma-separated list of font names to use on the label text. */
1633
+ "font-family"?: string;
1634
+ /** @description The size of the label text. */
1635
+ "font-size"?: string;
1636
+ /** @description A CSS font style to be applied to the label text. */
1637
+ "font-style"?: string;
1638
+ /** @description A CSS font weight to be applied to the label text. */
1639
+ "font-weight"?: string;
1640
+ /**
1641
+ * @description A transformation to apply to the label text
1642
+ * @enum {string}
1643
+ */
1644
+ "text-transform"?: "none" | "uppercase" | "lowercase";
1645
+ /**
1646
+ * Format: float
1647
+ * @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
1648
+ */
1649
+ opacity?: number;
1650
+ /** @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. */
1651
+ "z-index"?: number;
1652
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
1653
+ label?: string;
1654
+ /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
1655
+ "edge-animation"?: string;
1656
+ /**
1657
+ * @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.
1658
+ * @enum {string}
1659
+ */
1660
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
1661
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
1662
+ "line-color"?: string;
1663
+ /**
1664
+ * @description The style of the edge's line.
1665
+ * @enum {string}
1666
+ */
1667
+ "line-style"?: "solid" | "dotted" | "dashed";
1668
+ /**
1669
+ * @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.
1670
+ * @enum {string}
1671
+ */
1672
+ "line-cap"?: "butt" | "round" | "square";
1673
+ /**
1674
+ * Format: float
1675
+ * @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.
1676
+ */
1677
+ "line-opacity"?: number;
1678
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1679
+ "target-arrow-color"?: string;
1680
+ /**
1681
+ * @description The shape of the edge's source arrow
1682
+ * @enum {string}
1683
+ */
1684
+ "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
1685
+ /**
1686
+ * @description The fill state of the edge's source arrow
1687
+ * @enum {string}
1688
+ */
1689
+ "target-arrow-fill"?: "filled" | "hollow";
1690
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1691
+ "mid-target-arrow-color"?: string;
1692
+ /**
1693
+ * @description The shape of the edge's source arrow
1694
+ * @enum {string}
1695
+ */
1696
+ "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
1697
+ /**
1698
+ * @description The fill state of the edge's source arrow
1699
+ * @enum {string}
1700
+ */
1701
+ "mid-target-arrow-fill"?: "filled" | "hollow";
1702
+ /**
1703
+ * Format: float
1704
+ * @description Scaling for the arrow size.
1705
+ */
1706
+ "arrow-scale"?: number;
1707
+ /** @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 */
1708
+ "source-label"?: string;
1709
+ /** @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 */
1710
+ "target-label"?: string;
1094
1711
  };
1095
- };
1096
- /** @description Patch configuration for the selector */
1097
- patch?: {
1098
- /**
1099
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1100
- *
1101
- * add: Inserts a value into an array or adds a member to an object.
1102
- * replace: Replaces a value.
1103
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1104
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1105
- * remove: Removes a value.
1106
- * copy: Copies a value from one location to another.
1107
- * move: Moves a value from one location to another.
1108
- * test: Tests that a value at the target location is equal to a specified value.
1109
- *
1110
- * @enum {string}
1111
- */
1112
- patchStrategy?:
1113
- | "merge"
1114
- | "strategic"
1115
- | "add"
1116
- | "remove"
1117
- | "copy"
1118
- | "move"
1119
- | "test";
1120
- /** @description JSON ref to value from where patch should be applied. */
1121
- mutatorRef?: string[][];
1122
- mutatedRef?: string[][];
1123
- };
1124
- }[];
1125
- };
1126
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1127
- deny?: {
1128
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1129
- from: {
1130
- /**
1131
- * Format: uuid
1132
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1133
- */
1134
- id?: string;
1135
- kind?: string;
1136
- /** @description Match configuration for selector */
1137
- match?: {
1138
- refs?: string[][];
1139
- from?: {
1140
- /**
1141
- * Format: uuid
1142
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1143
- */
1144
- id?: string;
1145
- kind: string;
1146
- /** @description JSON ref to value from where patch should be applied. */
1147
- mutatorRef?: string[][];
1148
- mutatedRef?: string[][];
1149
- }[];
1150
- to?: {
1151
- /**
1152
- * Format: uuid
1153
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1154
- */
1155
- id?: string;
1156
- kind: string;
1157
- /** @description JSON ref to value from where patch should be applied. */
1158
- mutatorRef?: string[][];
1159
- mutatedRef?: string[][];
1160
- }[];
1161
- };
1162
- /** @description Match strategy matrix for the selector */
1163
- match_strategy_matrix?: string[][];
1164
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1165
- model?: {
1712
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
1713
+ isAnnotation?: boolean;
1714
+ } & {
1715
+ [key: string]: unknown;
1716
+ };
1717
+ /** @description Visualization styles for a relationship */
1718
+ RelationshipDefinitionMetadataStyles: {
1719
+ /** @description Primary color of the component used for UI representation. */
1720
+ primaryColor: string;
1721
+ /** @description Secondary color of the entity used for UI representation. */
1722
+ secondaryColor?: string;
1723
+ /** @description White SVG of the entity used for UI representation on dark background. */
1724
+ svgWhite: string;
1725
+ /** @description Colored SVG of the entity used for UI representation on light background. */
1726
+ svgColor: string;
1727
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1728
+ svgComplete?: string;
1729
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
1730
+ color?: string;
1166
1731
  /**
1167
- * Format: uuid
1168
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1732
+ * Format: float
1733
+ * @description The opacity of the label text, including its outline.
1169
1734
  */
1170
- id: string;
1171
- /** @description The unique name for the model within the scope of a registrant. */
1172
- name: string;
1173
- /** @description Version of the model definition. */
1174
- version: string;
1175
- /** @description Human-readable name for the model. */
1176
- displayName: string;
1177
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1178
- model: {
1179
- /** @description Version of the model as defined by the registrant. */
1180
- version: string;
1181
- };
1182
- registrant: {
1183
- /** @description Kind of the registrant. */
1184
- kind: string;
1185
- };
1186
- };
1187
- /** @description Patch configuration for the selector */
1188
- patch?: {
1735
+ "text-opacity"?: number;
1736
+ /** @description A comma-separated list of font names to use on the label text. */
1737
+ "font-family"?: string;
1738
+ /** @description The size of the label text. */
1739
+ "font-size"?: string;
1740
+ /** @description A CSS font style to be applied to the label text. */
1741
+ "font-style"?: string;
1742
+ /** @description A CSS font weight to be applied to the label text. */
1743
+ "font-weight"?: string;
1189
1744
  /**
1190
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1191
- *
1192
- * add: Inserts a value into an array or adds a member to an object.
1193
- * replace: Replaces a value.
1194
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1195
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1196
- * remove: Removes a value.
1197
- * copy: Copies a value from one location to another.
1198
- * move: Moves a value from one location to another.
1199
- * test: Tests that a value at the target location is equal to a specified value.
1200
- *
1745
+ * @description A transformation to apply to the label text
1201
1746
  * @enum {string}
1202
1747
  */
1203
- patchStrategy?:
1204
- | "merge"
1205
- | "strategic"
1206
- | "add"
1207
- | "remove"
1208
- | "copy"
1209
- | "move"
1210
- | "test";
1211
- /** @description JSON ref to value from where patch should be applied. */
1212
- mutatorRef?: string[][];
1213
- mutatedRef?: string[][];
1214
- };
1215
- }[];
1216
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1217
- to: {
1218
- /**
1219
- * Format: uuid
1220
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1221
- */
1222
- id?: string;
1223
- kind?: string;
1224
- /** @description Match configuration for selector */
1225
- match?: {
1226
- refs?: string[][];
1227
- from?: {
1228
- /**
1229
- * Format: uuid
1230
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1231
- */
1232
- id?: string;
1233
- kind: string;
1234
- /** @description JSON ref to value from where patch should be applied. */
1235
- mutatorRef?: string[][];
1236
- mutatedRef?: string[][];
1237
- }[];
1238
- to?: {
1239
- /**
1240
- * Format: uuid
1241
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1242
- */
1243
- id?: string;
1244
- kind: string;
1245
- /** @description JSON ref to value from where patch should be applied. */
1246
- mutatorRef?: string[][];
1247
- mutatedRef?: string[][];
1248
- }[];
1249
- };
1250
- /** @description Match strategy matrix for the selector */
1251
- match_strategy_matrix?: string[][];
1252
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1253
- model?: {
1748
+ "text-transform"?: "none" | "uppercase" | "lowercase";
1254
1749
  /**
1255
- * Format: uuid
1256
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1750
+ * Format: float
1751
+ * @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
1257
1752
  */
1258
- id: string;
1259
- /** @description The unique name for the model within the scope of a registrant. */
1260
- name: string;
1261
- /** @description Version of the model definition. */
1262
- version: string;
1263
- /** @description Human-readable name for the model. */
1264
- displayName: string;
1265
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1266
- model: {
1267
- /** @description Version of the model as defined by the registrant. */
1268
- version: string;
1269
- };
1270
- registrant: {
1271
- /** @description Kind of the registrant. */
1272
- kind: string;
1273
- };
1274
- };
1275
- /** @description Patch configuration for the selector */
1276
- patch?: {
1753
+ opacity?: number;
1754
+ /** @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. */
1755
+ "z-index"?: number;
1756
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
1757
+ label?: string;
1758
+ /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
1759
+ "edge-animation"?: string;
1277
1760
  /**
1278
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1279
- *
1280
- * add: Inserts a value into an array or adds a member to an object.
1281
- * replace: Replaces a value.
1282
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1283
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1284
- * remove: Removes a value.
1285
- * copy: Copies a value from one location to another.
1286
- * move: Moves a value from one location to another.
1287
- * test: Tests that a value at the target location is equal to a specified value.
1288
- *
1761
+ * @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.
1289
1762
  * @enum {string}
1290
1763
  */
1291
- patchStrategy?:
1292
- | "merge"
1293
- | "strategic"
1294
- | "add"
1295
- | "remove"
1296
- | "copy"
1297
- | "move"
1298
- | "test";
1299
- /** @description JSON ref to value from where patch should be applied. */
1300
- mutatorRef?: string[][];
1301
- mutatedRef?: string[][];
1302
- };
1303
- }[];
1304
- };
1305
- };
1306
- /** @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. */
1307
- SelectorSet: {
1308
- /** @description Selectors used to define relationships which are allowed. */
1309
- allow: {
1310
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1311
- from: {
1312
- /**
1313
- * Format: uuid
1314
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1315
- */
1316
- id?: string;
1317
- kind?: string;
1318
- /** @description Match configuration for selector */
1319
- match?: {
1320
- refs?: string[][];
1321
- from?: {
1322
- /**
1323
- * Format: uuid
1324
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1325
- */
1326
- id?: string;
1327
- kind: string;
1328
- /** @description JSON ref to value from where patch should be applied. */
1329
- mutatorRef?: string[][];
1330
- mutatedRef?: string[][];
1331
- }[];
1332
- to?: {
1333
- /**
1334
- * Format: uuid
1335
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1336
- */
1337
- id?: string;
1338
- kind: string;
1339
- /** @description JSON ref to value from where patch should be applied. */
1340
- mutatorRef?: string[][];
1341
- mutatedRef?: string[][];
1342
- }[];
1343
- };
1344
- /** @description Match strategy matrix for the selector */
1345
- match_strategy_matrix?: string[][];
1346
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1347
- model?: {
1764
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
1765
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
1766
+ "line-color"?: string;
1348
1767
  /**
1349
- * Format: uuid
1350
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1768
+ * @description The style of the edge's line.
1769
+ * @enum {string}
1351
1770
  */
1352
- id: string;
1353
- /** @description The unique name for the model within the scope of a registrant. */
1354
- name: string;
1355
- /** @description Version of the model definition. */
1356
- version: string;
1357
- /** @description Human-readable name for the model. */
1358
- displayName: string;
1359
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1360
- model: {
1361
- /** @description Version of the model as defined by the registrant. */
1362
- version: string;
1363
- };
1364
- registrant: {
1365
- /** @description Kind of the registrant. */
1366
- kind: string;
1367
- };
1368
- };
1369
- /** @description Patch configuration for the selector */
1370
- patch?: {
1771
+ "line-style"?: "solid" | "dotted" | "dashed";
1371
1772
  /**
1372
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1373
- *
1374
- * add: Inserts a value into an array or adds a member to an object.
1375
- * replace: Replaces a value.
1376
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1377
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1378
- * remove: Removes a value.
1379
- * copy: Copies a value from one location to another.
1380
- * move: Moves a value from one location to another.
1381
- * test: Tests that a value at the target location is equal to a specified value.
1382
- *
1773
+ * @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.
1383
1774
  * @enum {string}
1384
1775
  */
1385
- patchStrategy?:
1386
- | "merge"
1387
- | "strategic"
1388
- | "add"
1389
- | "remove"
1390
- | "copy"
1391
- | "move"
1392
- | "test";
1393
- /** @description JSON ref to value from where patch should be applied. */
1394
- mutatorRef?: string[][];
1395
- mutatedRef?: string[][];
1396
- };
1397
- }[];
1398
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1399
- to: {
1400
- /**
1401
- * Format: uuid
1402
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1403
- */
1404
- id?: string;
1405
- kind?: string;
1406
- /** @description Match configuration for selector */
1407
- match?: {
1408
- refs?: string[][];
1409
- from?: {
1410
- /**
1411
- * Format: uuid
1412
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1413
- */
1414
- id?: string;
1415
- kind: string;
1416
- /** @description JSON ref to value from where patch should be applied. */
1417
- mutatorRef?: string[][];
1418
- mutatedRef?: string[][];
1419
- }[];
1420
- to?: {
1421
- /**
1422
- * Format: uuid
1423
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1424
- */
1425
- id?: string;
1426
- kind: string;
1427
- /** @description JSON ref to value from where patch should be applied. */
1428
- mutatorRef?: string[][];
1429
- mutatedRef?: string[][];
1430
- }[];
1431
- };
1432
- /** @description Match strategy matrix for the selector */
1433
- match_strategy_matrix?: string[][];
1434
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1435
- model?: {
1776
+ "line-cap"?: "butt" | "round" | "square";
1436
1777
  /**
1437
- * Format: uuid
1438
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1778
+ * Format: float
1779
+ * @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.
1439
1780
  */
1440
- id: string;
1441
- /** @description The unique name for the model within the scope of a registrant. */
1442
- name: string;
1443
- /** @description Version of the model definition. */
1444
- version: string;
1445
- /** @description Human-readable name for the model. */
1446
- displayName: string;
1447
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1448
- model: {
1449
- /** @description Version of the model as defined by the registrant. */
1450
- version: string;
1451
- };
1452
- registrant: {
1453
- /** @description Kind of the registrant. */
1454
- kind: string;
1455
- };
1456
- };
1457
- /** @description Patch configuration for the selector */
1458
- patch?: {
1781
+ "line-opacity"?: number;
1782
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1783
+ "target-arrow-color"?: string;
1459
1784
  /**
1460
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1461
- *
1462
- * add: Inserts a value into an array or adds a member to an object.
1463
- * replace: Replaces a value.
1464
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1465
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1466
- * remove: Removes a value.
1467
- * copy: Copies a value from one location to another.
1468
- * move: Moves a value from one location to another.
1469
- * test: Tests that a value at the target location is equal to a specified value.
1470
- *
1785
+ * @description The shape of the edge's source arrow
1471
1786
  * @enum {string}
1472
1787
  */
1473
- patchStrategy?:
1474
- | "merge"
1475
- | "strategic"
1476
- | "add"
1477
- | "remove"
1478
- | "copy"
1479
- | "move"
1480
- | "test";
1481
- /** @description JSON ref to value from where patch should be applied. */
1482
- mutatorRef?: string[][];
1483
- mutatedRef?: string[][];
1484
- };
1485
- }[];
1486
- };
1487
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1488
- deny?: {
1489
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1490
- from: {
1491
- /**
1492
- * Format: uuid
1493
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1494
- */
1495
- id?: string;
1496
- kind?: string;
1497
- /** @description Match configuration for selector */
1498
- match?: {
1499
- refs?: string[][];
1500
- from?: {
1501
- /**
1502
- * Format: uuid
1503
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1504
- */
1505
- id?: string;
1506
- kind: string;
1507
- /** @description JSON ref to value from where patch should be applied. */
1508
- mutatorRef?: string[][];
1509
- mutatedRef?: string[][];
1510
- }[];
1511
- to?: {
1512
- /**
1513
- * Format: uuid
1514
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1515
- */
1516
- id?: string;
1517
- kind: string;
1518
- /** @description JSON ref to value from where patch should be applied. */
1519
- mutatorRef?: string[][];
1520
- mutatedRef?: string[][];
1521
- }[];
1522
- };
1523
- /** @description Match strategy matrix for the selector */
1524
- match_strategy_matrix?: string[][];
1525
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1526
- model?: {
1788
+ "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
1527
1789
  /**
1528
- * Format: uuid
1529
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1790
+ * @description The fill state of the edge's source arrow
1791
+ * @enum {string}
1530
1792
  */
1531
- id: string;
1532
- /** @description The unique name for the model within the scope of a registrant. */
1533
- name: string;
1534
- /** @description Version of the model definition. */
1535
- version: string;
1536
- /** @description Human-readable name for the model. */
1537
- displayName: string;
1538
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1539
- model: {
1540
- /** @description Version of the model as defined by the registrant. */
1541
- version: string;
1542
- };
1543
- registrant: {
1544
- /** @description Kind of the registrant. */
1545
- kind: string;
1546
- };
1547
- };
1548
- /** @description Patch configuration for the selector */
1549
- patch?: {
1793
+ "target-arrow-fill"?: "filled" | "hollow";
1794
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1795
+ "mid-target-arrow-color"?: string;
1550
1796
  /**
1551
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1552
- *
1553
- * add: Inserts a value into an array or adds a member to an object.
1554
- * replace: Replaces a value.
1555
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1556
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1557
- * remove: Removes a value.
1558
- * copy: Copies a value from one location to another.
1559
- * move: Moves a value from one location to another.
1560
- * test: Tests that a value at the target location is equal to a specified value.
1561
- *
1797
+ * @description The shape of the edge's source arrow
1562
1798
  * @enum {string}
1563
1799
  */
1564
- patchStrategy?:
1565
- | "merge"
1566
- | "strategic"
1567
- | "add"
1568
- | "remove"
1569
- | "copy"
1570
- | "move"
1571
- | "test";
1572
- /** @description JSON ref to value from where patch should be applied. */
1573
- mutatorRef?: string[][];
1574
- mutatedRef?: string[][];
1575
- };
1576
- }[];
1577
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1578
- to: {
1579
- /**
1580
- * Format: uuid
1581
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1582
- */
1583
- id?: string;
1584
- kind?: string;
1585
- /** @description Match configuration for selector */
1586
- match?: {
1587
- refs?: string[][];
1588
- from?: {
1589
- /**
1590
- * Format: uuid
1591
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1592
- */
1593
- id?: string;
1594
- kind: string;
1595
- /** @description JSON ref to value from where patch should be applied. */
1596
- mutatorRef?: string[][];
1597
- mutatedRef?: string[][];
1598
- }[];
1599
- to?: {
1600
- /**
1601
- * Format: uuid
1602
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1603
- */
1604
- id?: string;
1605
- kind: string;
1606
- /** @description JSON ref to value from where patch should be applied. */
1607
- mutatorRef?: string[][];
1608
- mutatedRef?: string[][];
1609
- }[];
1610
- };
1611
- /** @description Match strategy matrix for the selector */
1612
- match_strategy_matrix?: string[][];
1613
- /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1614
- model?: {
1800
+ "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
1615
1801
  /**
1616
- * Format: uuid
1617
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1802
+ * @description The fill state of the edge's source arrow
1803
+ * @enum {string}
1618
1804
  */
1619
- id: string;
1620
- /** @description The unique name for the model within the scope of a registrant. */
1621
- name: string;
1622
- /** @description Version of the model definition. */
1623
- version: string;
1624
- /** @description Human-readable name for the model. */
1625
- displayName: string;
1626
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
1627
- model: {
1628
- /** @description Version of the model as defined by the registrant. */
1629
- version: string;
1630
- };
1631
- registrant: {
1632
- /** @description Kind of the registrant. */
1633
- kind: string;
1634
- };
1635
- };
1636
- /** @description Patch configuration for the selector */
1637
- patch?: {
1805
+ "mid-target-arrow-fill"?: "filled" | "hollow";
1638
1806
  /**
1639
- * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
1640
- *
1641
- * add: Inserts a value into an array or adds a member to an object.
1642
- * replace: Replaces a value.
1643
- * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1644
- * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1645
- * remove: Removes a value.
1646
- * copy: Copies a value from one location to another.
1647
- * move: Moves a value from one location to another.
1648
- * test: Tests that a value at the target location is equal to a specified value.
1649
- *
1650
- * @enum {string}
1807
+ * Format: float
1808
+ * @description Scaling for the arrow size.
1651
1809
  */
1652
- patchStrategy?:
1653
- | "merge"
1654
- | "strategic"
1655
- | "add"
1656
- | "remove"
1657
- | "copy"
1658
- | "move"
1659
- | "test";
1660
- /** @description JSON ref to value from where patch should be applied. */
1661
- mutatorRef?: string[][];
1662
- mutatedRef?: string[][];
1663
- };
1664
- }[];
1665
- };
1666
- }[];
1667
- /** @description Metadata contains additional information associated with the Relationship. */
1668
- Relationship_Metadata: {
1669
- /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
1670
- description?: string;
1671
- /** @description Visualization styles for a relationship */
1672
- styles?: {
1673
- /** @description Primary color of the component used for UI representation. */
1674
- primaryColor: string;
1675
- /** @description Secondary color of the entity used for UI representation. */
1676
- secondaryColor?: string;
1677
- /** @description White SVG of the entity used for UI representation on dark background. */
1678
- svgWhite: string;
1679
- /** @description Colored SVG of the entity used for UI representation on light background. */
1680
- svgColor: string;
1681
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1682
- svgComplete?: string;
1683
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
1684
- color?: string;
1685
- /**
1686
- * Format: float
1687
- * @description The opacity of the label text, including its outline.
1688
- */
1689
- "text-opacity"?: number;
1690
- /** @description A comma-separated list of font names to use on the label text. */
1691
- "font-family"?: string;
1692
- /** @description The size of the label text. */
1693
- "font-size"?: string;
1694
- /** @description A CSS font style to be applied to the label text. */
1695
- "font-style"?: string;
1696
- /** @description A CSS font weight to be applied to the label text. */
1697
- "font-weight"?: string;
1698
- /**
1699
- * @description A transformation to apply to the label text
1700
- * @enum {string}
1701
- */
1702
- "text-transform"?: "none" | "uppercase" | "lowercase";
1703
- /**
1704
- * Format: float
1705
- * @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
1706
- */
1707
- opacity?: number;
1708
- /** @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. */
1709
- "z-index"?: number;
1710
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
1711
- label?: string;
1712
- /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
1713
- "edge-animation"?: string;
1714
- /**
1715
- * @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.
1716
- * @enum {string}
1717
- */
1718
- "curve-style"?:
1719
- | "haystack"
1720
- | "straight"
1721
- | "bezier"
1722
- | "unbundled-bezier"
1723
- | "segments"
1724
- | "taxi";
1725
- /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
1726
- "line-color"?: string;
1727
- /**
1728
- * @description The style of the edge's line.
1729
- * @enum {string}
1730
- */
1731
- "line-style"?: "solid" | "dotted" | "dashed";
1732
- /**
1733
- * @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.
1734
- * @enum {string}
1735
- */
1736
- "line-cap"?: "butt" | "round" | "square";
1737
- /**
1738
- * Format: float
1739
- * @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.
1740
- */
1741
- "line-opacity"?: number;
1742
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1743
- "target-arrow-color"?: string;
1744
- /**
1745
- * @description The shape of the edge's source arrow
1746
- * @enum {string}
1747
- */
1748
- "target-arrow-shape"?:
1749
- | "triangle"
1750
- | "triangle-tee"
1751
- | "circle-triangle"
1752
- | "triangle-cross"
1753
- | "triangle-backcurve"
1754
- | "vee"
1755
- | "tee"
1756
- | "square"
1757
- | "circle"
1758
- | "diamond"
1759
- | "chevron"
1760
- | "none";
1761
- /**
1762
- * @description The fill state of the edge's source arrow
1763
- * @enum {string}
1764
- */
1765
- "target-arrow-fill"?: "filled" | "hollow";
1766
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1767
- "mid-target-arrow-color"?: string;
1768
- /**
1769
- * @description The shape of the edge's source arrow
1770
- * @enum {string}
1771
- */
1772
- "mid-target-arrow-shape"?:
1773
- | "triangle"
1774
- | "triangle-tee"
1775
- | "circle-triangle"
1776
- | "triangle-cross"
1777
- | "triangle-backcurve"
1778
- | "vee"
1779
- | "tee"
1780
- | "square"
1781
- | "circle"
1782
- | "diamond"
1783
- | "chevron"
1784
- | "none";
1785
- /**
1786
- * @description The fill state of the edge's source arrow
1787
- * @enum {string}
1788
- */
1789
- "mid-target-arrow-fill"?: "filled" | "hollow";
1790
- /**
1791
- * Format: float
1792
- * @description Scaling for the arrow size.
1793
- */
1794
- "arrow-scale"?: number;
1795
- /** @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 */
1796
- "source-label"?: string;
1797
- /** @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 */
1798
- "target-label"?: string;
1799
- };
1800
- /** @description Indicates whether the relationship should be treated as a logical representation only */
1801
- isAnnotation?: boolean;
1802
- } & { [key: string]: unknown };
1803
- /** @description Visualization styles for a relationship */
1804
- RelationshipDefinitionMetadataStyles: {
1805
- /** @description Primary color of the component used for UI representation. */
1806
- primaryColor: string;
1807
- /** @description Secondary color of the entity used for UI representation. */
1808
- secondaryColor?: string;
1809
- /** @description White SVG of the entity used for UI representation on dark background. */
1810
- svgWhite: string;
1811
- /** @description Colored SVG of the entity used for UI representation on light background. */
1812
- svgColor: string;
1813
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1814
- svgComplete?: string;
1815
- /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
1816
- color?: string;
1817
- /**
1818
- * Format: float
1819
- * @description The opacity of the label text, including its outline.
1820
- */
1821
- "text-opacity"?: number;
1822
- /** @description A comma-separated list of font names to use on the label text. */
1823
- "font-family"?: string;
1824
- /** @description The size of the label text. */
1825
- "font-size"?: string;
1826
- /** @description A CSS font style to be applied to the label text. */
1827
- "font-style"?: string;
1828
- /** @description A CSS font weight to be applied to the label text. */
1829
- "font-weight"?: string;
1830
- /**
1831
- * @description A transformation to apply to the label text
1832
- * @enum {string}
1833
- */
1834
- "text-transform"?: "none" | "uppercase" | "lowercase";
1835
- /**
1836
- * Format: float
1837
- * @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
1838
- */
1839
- opacity?: number;
1840
- /** @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. */
1841
- "z-index"?: number;
1842
- /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
1843
- label?: string;
1844
- /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
1845
- "edge-animation"?: string;
1846
- /**
1847
- * @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.
1848
- * @enum {string}
1849
- */
1850
- "curve-style"?:
1851
- | "haystack"
1852
- | "straight"
1853
- | "bezier"
1854
- | "unbundled-bezier"
1855
- | "segments"
1856
- | "taxi";
1857
- /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
1858
- "line-color"?: string;
1859
- /**
1860
- * @description The style of the edge's line.
1861
- * @enum {string}
1862
- */
1863
- "line-style"?: "solid" | "dotted" | "dashed";
1864
- /**
1865
- * @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.
1866
- * @enum {string}
1867
- */
1868
- "line-cap"?: "butt" | "round" | "square";
1869
- /**
1870
- * Format: float
1871
- * @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.
1872
- */
1873
- "line-opacity"?: number;
1874
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1875
- "target-arrow-color"?: string;
1876
- /**
1877
- * @description The shape of the edge's source arrow
1878
- * @enum {string}
1879
- */
1880
- "target-arrow-shape"?:
1881
- | "triangle"
1882
- | "triangle-tee"
1883
- | "circle-triangle"
1884
- | "triangle-cross"
1885
- | "triangle-backcurve"
1886
- | "vee"
1887
- | "tee"
1888
- | "square"
1889
- | "circle"
1890
- | "diamond"
1891
- | "chevron"
1892
- | "none";
1893
- /**
1894
- * @description The fill state of the edge's source arrow
1895
- * @enum {string}
1896
- */
1897
- "target-arrow-fill"?: "filled" | "hollow";
1898
- /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
1899
- "mid-target-arrow-color"?: string;
1900
- /**
1901
- * @description The shape of the edge's source arrow
1902
- * @enum {string}
1903
- */
1904
- "mid-target-arrow-shape"?:
1905
- | "triangle"
1906
- | "triangle-tee"
1907
- | "circle-triangle"
1908
- | "triangle-cross"
1909
- | "triangle-backcurve"
1910
- | "vee"
1911
- | "tee"
1912
- | "square"
1913
- | "circle"
1914
- | "diamond"
1915
- | "chevron"
1916
- | "none";
1917
- /**
1918
- * @description The fill state of the edge's source arrow
1919
- * @enum {string}
1920
- */
1921
- "mid-target-arrow-fill"?: "filled" | "hollow";
1922
- /**
1923
- * Format: float
1924
- * @description Scaling for the arrow size.
1925
- */
1926
- "arrow-scale"?: number;
1927
- /** @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 */
1928
- "source-label"?: string;
1929
- /** @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 */
1930
- "target-label"?: string;
1810
+ "arrow-scale"?: number;
1811
+ /** @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 */
1812
+ "source-label"?: string;
1813
+ /** @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 */
1814
+ "target-label"?: string;
1815
+ };
1931
1816
  };
1932
- };
1817
+ responses: never;
1818
+ parameters: never;
1819
+ requestBodies: never;
1820
+ headers: never;
1821
+ pathItems: never;
1933
1822
  }
1934
-
1935
- export interface operations {}
1936
-
1937
- export interface external {}
1823
+ export type $defs = Record<string, never>;
1824
+ export type operations = Record<string, never>;