@meshery/schemas 0.8.124 → 0.8.126

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