@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
@@ -798,12 +798,11 @@ interface components {
798
798
  relationships: {
799
799
  /**
800
800
  * Format: uuid
801
- * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
801
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
802
802
  */
803
- id?: string;
803
+ id: string;
804
804
  /**
805
805
  * @description Specifies the version of the schema used for the relationship definition.
806
- * @default relationships.meshery.io/v1alpha3
807
806
  * @example [
808
807
  * "v1",
809
808
  * "v1alpha1",
@@ -814,34 +813,6 @@ interface components {
814
813
  schemaVersion: string;
815
814
  /** @description A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1. */
816
815
  version: string;
817
- /** @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 */
818
- model: {
819
- /**
820
- * Format: uuid
821
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
822
- */
823
- id: string;
824
- /**
825
- * @description The unique name for the model within the scope of a registrant.
826
- * @default untitled-model
827
- */
828
- name: string;
829
- /** @description Version of the model definition. */
830
- version: string;
831
- /**
832
- * @description Human-readable name for the model.
833
- * @default Untitled Model
834
- */
835
- displayName: string;
836
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
837
- model: {
838
- /** @description Version of the model as defined by the registrant. */
839
- version: string;
840
- };
841
- registrant: {
842
- kind: string;
843
- };
844
- };
845
816
  /**
846
817
  * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
847
818
  * @enum {string}
@@ -853,12 +824,9 @@ interface components {
853
824
  subType: string;
854
825
  /**
855
826
  * @description Status of the relationship.
856
- * @default enabled
857
827
  * @enum {string}
858
828
  */
859
- status?: "pending" | "approved" | "ignored" | "enabled" | "deleted";
860
- /** @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. */
861
- evaluationQuery?: string;
829
+ status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
862
830
  /** @description Capabilities associated with the relationship. */
863
831
  capabilities?: {
864
832
  /**
@@ -876,15 +844,15 @@ interface components {
876
844
  /** @description Name of the capability in human-readible format. */
877
845
  displayName: string;
878
846
  /** @description A written representation of the purpose and characteristics of the capability. */
879
- description?: string;
847
+ description: string;
880
848
  /** @description Top-level categorization of the capability */
881
849
  kind: string;
882
850
  /** @description Classification of capabilities. Used to group capabilities similar in nature. */
883
851
  type: string;
884
852
  /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
885
- subType?: string;
853
+ subType: string;
886
854
  /** @description Key that backs the capability. */
887
- key?: string;
855
+ key: string;
888
856
  /** @description State of the entity in which the capability is applicable. */
889
857
  entityState: ("declaration" | "instance")[];
890
858
  /**
@@ -902,12 +870,8 @@ interface components {
902
870
  metadata?: {
903
871
  /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
904
872
  description?: string;
905
- /**
906
- * @description Indicates whether the relationship should be treated as a logical representation only
907
- * @default false
908
- */
909
- isAnnotation?: boolean;
910
- styles?: Partial<{
873
+ /** @description Visualization styles for a relationship */
874
+ styles?: {
911
875
  /** @description Primary color of the component used for UI representation. */
912
876
  primaryColor: string;
913
877
  /** @description Secondary color of the entity used for UI representation. */
@@ -918,9 +882,12 @@ interface components {
918
882
  svgColor: string;
919
883
  /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
920
884
  svgComplete?: string;
921
- /** @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%)). */
885
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
922
886
  color?: string;
923
- /** @description The opacity of the label text, including its outline. */
887
+ /**
888
+ * Format: float
889
+ * @description The opacity of the label text, including its outline.
890
+ */
924
891
  "text-opacity"?: number;
925
892
  /** @description A comma-separated list of font names to use on the label text. */
926
893
  "font-family"?: string;
@@ -935,115 +902,154 @@ interface components {
935
902
  * @enum {string}
936
903
  */
937
904
  "text-transform"?: "none" | "uppercase" | "lowercase";
938
- /** @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 */
905
+ /**
906
+ * Format: float
907
+ * @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
908
+ */
939
909
  opacity?: number;
940
910
  /** @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. */
941
911
  "z-index"?: number;
942
- /** @description The text to display for an elements label. Can give a path, e.g. data(id) will label with the elements id */
912
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
943
913
  label?: string;
944
- } & {
945
914
  /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
946
915
  "edge-animation"?: string;
947
916
  /**
948
917
  * @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.
949
- * @default straight
950
918
  * @enum {string}
951
919
  */
952
- "curve-style"?: "straight" | "haystack" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
953
- /** @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%)). */
920
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
921
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
954
922
  "line-color"?: string;
955
923
  /**
956
- * @description The style of the edges line.
924
+ * @description The style of the edge's line.
957
925
  * @enum {string}
958
926
  */
959
927
  "line-style"?: "solid" | "dotted" | "dashed";
960
928
  /**
961
- * @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.
962
- * @default butt
929
+ * @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.
963
930
  * @enum {string}
964
931
  */
965
932
  "line-cap"?: "butt" | "round" | "square";
966
933
  /**
967
- * @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.
968
- * @default 1
934
+ * Format: float
935
+ * @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.
969
936
  */
970
937
  "line-opacity"?: number;
971
- /** @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%)). */
938
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
972
939
  "target-arrow-color"?: string;
973
940
  /**
974
- * @description The shape of the edges source arrow
941
+ * @description The shape of the edge's source arrow
975
942
  * @enum {string}
976
943
  */
977
944
  "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
978
945
  /**
979
- * @description The fill state of the edges source arrow
946
+ * @description The fill state of the edge's source arrow
980
947
  * @enum {string}
981
948
  */
982
949
  "target-arrow-fill"?: "filled" | "hollow";
983
- /** @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%)). */
950
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
984
951
  "mid-target-arrow-color"?: string;
985
952
  /**
986
- * @description The shape of the edges source arrow
953
+ * @description The shape of the edge's source arrow
987
954
  * @enum {string}
988
955
  */
989
956
  "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
990
957
  /**
991
- * @description The fill state of the edges source arrow
958
+ * @description The fill state of the edge's source arrow
992
959
  * @enum {string}
993
960
  */
994
961
  "mid-target-arrow-fill"?: "filled" | "hollow";
995
- /** @description Scaling for the arrow size. */
962
+ /**
963
+ * Format: float
964
+ * @description Scaling for the arrow size.
965
+ */
996
966
  "arrow-scale"?: number;
997
- /** @description The text to display for an edges source label. Can give a path, e.g. data(id) will label with the elements id */
967
+ /** @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 */
998
968
  "source-label"?: string;
999
- /** @description The text to display for an edges target label. Can give a path, e.g. data(id) will label with the elements id */
969
+ /** @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 */
1000
970
  "target-label"?: string;
1001
- }> & Partial<{
1002
- /** @description Primary color of the component used for UI representation. */
1003
- primaryColor: string;
1004
- /** @description Secondary color of the entity used for UI representation. */
1005
- secondaryColor?: string;
1006
- /** @description White SVG of the entity used for UI representation on dark background. */
1007
- svgWhite: string;
1008
- /** @description Colored SVG of the entity used for UI representation on light background. */
1009
- svgColor: string;
1010
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
1011
- svgComplete?: string;
1012
- /** @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%)). */
1013
- color?: string;
1014
- /** @description The opacity of the label text, including its outline. */
1015
- "text-opacity"?: number;
1016
- /** @description A comma-separated list of font names to use on the label text. */
1017
- "font-family"?: string;
1018
- /** @description The size of the label text. */
1019
- "font-size"?: string;
1020
- /** @description A CSS font style to be applied to the label text. */
1021
- "font-style"?: string;
1022
- /** @description A CSS font weight to be applied to the label text. */
1023
- "font-weight"?: string;
1024
- /**
1025
- * @description A transformation to apply to the label text
1026
- * @enum {string}
1027
- */
1028
- "text-transform"?: "none" | "uppercase" | "lowercase";
1029
- /** @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 */
1030
- opacity?: number;
1031
- /** @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. */
1032
- "z-index"?: number;
1033
- /** @description The text to display for an element’s label. Can give a path, e.g. data(id) will label with the elements id */
1034
- label?: string;
1035
- }>;
971
+ };
972
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
973
+ isAnnotation?: boolean;
1036
974
  } & {
1037
975
  [key: string]: unknown;
1038
976
  };
977
+ /** @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 */
978
+ model: {
979
+ /**
980
+ * Format: uuid
981
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
982
+ */
983
+ id: string;
984
+ /**
985
+ * @description The unique name for the model within the scope of a registrant.
986
+ * @default untitled-model
987
+ */
988
+ name: string;
989
+ /** @description Version of the model definition. */
990
+ version: string;
991
+ /**
992
+ * @description Human-readable name for the model.
993
+ * @default Untitled Model
994
+ */
995
+ displayName: string;
996
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
997
+ model: {
998
+ /** @description Version of the model as defined by the registrant. */
999
+ version: string;
1000
+ };
1001
+ registrant: {
1002
+ kind: string;
1003
+ };
1004
+ };
1005
+ /**
1006
+ * Format: uuid
1007
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1008
+ */
1009
+ modelId?: string;
1010
+ /** @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. */
1011
+ evaluationQuery?: string;
1039
1012
  /** @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. */
1040
1013
  selectors?: {
1041
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1042
- deny?: {
1014
+ /** @description Selectors used to define relationships which are allowed. */
1015
+ allow: {
1043
1016
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1044
1017
  from: {
1018
+ /**
1019
+ * Format: uuid
1020
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1021
+ */
1022
+ id?: string;
1045
1023
  kind?: string;
1046
- /** @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 */
1024
+ /** @description Match configuration for selector */
1025
+ match?: {
1026
+ refs?: string[][];
1027
+ from?: {
1028
+ /**
1029
+ * Format: uuid
1030
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1031
+ */
1032
+ id?: string;
1033
+ kind: string;
1034
+ /** @description JSON ref to value from where patch should be applied. */
1035
+ mutatorRef?: string[][];
1036
+ mutatedRef?: string[][];
1037
+ }[];
1038
+ to?: {
1039
+ /**
1040
+ * Format: uuid
1041
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1042
+ */
1043
+ id?: string;
1044
+ kind: string;
1045
+ /** @description JSON ref to value from where patch should be applied. */
1046
+ mutatorRef?: string[][];
1047
+ mutatedRef?: string[][];
1048
+ }[];
1049
+ };
1050
+ /** @description Match strategy matrix for the selector */
1051
+ match_strategy_matrix?: string[][];
1052
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1047
1053
  model?: {
1048
1054
  /**
1049
1055
  * Format: uuid
@@ -1071,39 +1077,7 @@ interface components {
1071
1077
  kind: string;
1072
1078
  };
1073
1079
  };
1074
- /**
1075
- * Format: uuid
1076
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1077
- */
1078
- id?: string;
1079
- match?: string[][] | {
1080
- from?: ({
1081
- kind?: string;
1082
- /**
1083
- * Format: uuid
1084
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1085
- */
1086
- id?: string;
1087
- } & ({
1088
- /** @description JSON ref to value from where patch should be applied. */
1089
- mutatorRef?: string[][];
1090
- } | {
1091
- mutatedRef?: string[][];
1092
- }))[];
1093
- to?: ({
1094
- kind?: string;
1095
- /**
1096
- * Format: uuid
1097
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1098
- */
1099
- id?: string;
1100
- } & ({
1101
- /** @description JSON ref to value from where patch should be applied. */
1102
- mutatorRef?: string[][];
1103
- } | {
1104
- mutatedRef?: string[][];
1105
- }))[];
1106
- };
1080
+ /** @description Patch configuration for the selector */
1107
1081
  patch?: {
1108
1082
  /**
1109
1083
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1111,26 +1085,57 @@ interface components {
1111
1085
  * add: Inserts a value into an array or adds a member to an object.
1112
1086
  * replace: Replaces a value.
1113
1087
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1114
- * 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.
1088
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1115
1089
  * remove: Removes a value.
1116
1090
  * copy: Copies a value from one location to another.
1117
1091
  * move: Moves a value from one location to another.
1118
1092
  * test: Tests that a value at the target location is equal to a specified value.
1119
- * @default copy
1093
+ *
1120
1094
  * @enum {string}
1121
1095
  */
1122
1096
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1123
- } & ({
1124
1097
  /** @description JSON ref to value from where patch should be applied. */
1125
1098
  mutatorRef?: string[][];
1126
- } | {
1127
1099
  mutatedRef?: string[][];
1128
- });
1100
+ };
1129
1101
  }[];
1130
1102
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1131
1103
  to: {
1104
+ /**
1105
+ * Format: uuid
1106
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1107
+ */
1108
+ id?: string;
1132
1109
  kind?: string;
1133
- /** @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 */
1110
+ /** @description Match configuration for selector */
1111
+ match?: {
1112
+ refs?: string[][];
1113
+ from?: {
1114
+ /**
1115
+ * Format: uuid
1116
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1117
+ */
1118
+ id?: string;
1119
+ kind: string;
1120
+ /** @description JSON ref to value from where patch should be applied. */
1121
+ mutatorRef?: string[][];
1122
+ mutatedRef?: string[][];
1123
+ }[];
1124
+ to?: {
1125
+ /**
1126
+ * Format: uuid
1127
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1128
+ */
1129
+ id?: string;
1130
+ kind: string;
1131
+ /** @description JSON ref to value from where patch should be applied. */
1132
+ mutatorRef?: string[][];
1133
+ mutatedRef?: string[][];
1134
+ }[];
1135
+ };
1136
+ /** @description Match strategy matrix for the selector */
1137
+ match_strategy_matrix?: string[][];
1138
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1134
1139
  model?: {
1135
1140
  /**
1136
1141
  * Format: uuid
@@ -1158,39 +1163,7 @@ interface components {
1158
1163
  kind: string;
1159
1164
  };
1160
1165
  };
1161
- /**
1162
- * Format: uuid
1163
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1164
- */
1165
- id?: string;
1166
- match?: string[][] | {
1167
- from?: ({
1168
- kind?: string;
1169
- /**
1170
- * Format: uuid
1171
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1172
- */
1173
- id?: string;
1174
- } & ({
1175
- /** @description JSON ref to value from where patch should be applied. */
1176
- mutatorRef?: string[][];
1177
- } | {
1178
- mutatedRef?: string[][];
1179
- }))[];
1180
- to?: ({
1181
- kind?: string;
1182
- /**
1183
- * Format: uuid
1184
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1185
- */
1186
- id?: string;
1187
- } & ({
1188
- /** @description JSON ref to value from where patch should be applied. */
1189
- mutatorRef?: string[][];
1190
- } | {
1191
- mutatedRef?: string[][];
1192
- }))[];
1193
- };
1166
+ /** @description Patch configuration for the selector */
1194
1167
  patch?: {
1195
1168
  /**
1196
1169
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1198,31 +1171,60 @@ interface components {
1198
1171
  * add: Inserts a value into an array or adds a member to an object.
1199
1172
  * replace: Replaces a value.
1200
1173
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1201
- * 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.
1174
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1202
1175
  * remove: Removes a value.
1203
1176
  * copy: Copies a value from one location to another.
1204
1177
  * move: Moves a value from one location to another.
1205
1178
  * test: Tests that a value at the target location is equal to a specified value.
1206
- * @default copy
1179
+ *
1207
1180
  * @enum {string}
1208
1181
  */
1209
1182
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1210
- } & ({
1211
1183
  /** @description JSON ref to value from where patch should be applied. */
1212
1184
  mutatorRef?: string[][];
1213
- } | {
1214
1185
  mutatedRef?: string[][];
1215
- });
1186
+ };
1216
1187
  }[];
1217
1188
  };
1218
- /** @description Selectors used to define relationships which are allowed. */
1219
- allow: {
1189
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
1190
+ deny?: {
1220
1191
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1221
1192
  from: {
1193
+ /**
1194
+ * Format: uuid
1195
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1196
+ */
1197
+ id?: string;
1222
1198
  kind?: string;
1223
- /** @description Strategy criterion for determing how to match the values at mutator/mutated paths */
1199
+ /** @description Match configuration for selector */
1200
+ match?: {
1201
+ refs?: string[][];
1202
+ from?: {
1203
+ /**
1204
+ * Format: uuid
1205
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1206
+ */
1207
+ id?: string;
1208
+ kind: string;
1209
+ /** @description JSON ref to value from where patch should be applied. */
1210
+ mutatorRef?: string[][];
1211
+ mutatedRef?: string[][];
1212
+ }[];
1213
+ to?: {
1214
+ /**
1215
+ * Format: uuid
1216
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1217
+ */
1218
+ id?: string;
1219
+ kind: string;
1220
+ /** @description JSON ref to value from where patch should be applied. */
1221
+ mutatorRef?: string[][];
1222
+ mutatedRef?: string[][];
1223
+ }[];
1224
+ };
1225
+ /** @description Match strategy matrix for the selector */
1224
1226
  match_strategy_matrix?: string[][];
1225
- /** @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 */
1227
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1226
1228
  model?: {
1227
1229
  /**
1228
1230
  * Format: uuid
@@ -1250,39 +1252,7 @@ interface components {
1250
1252
  kind: string;
1251
1253
  };
1252
1254
  };
1253
- /**
1254
- * Format: uuid
1255
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1256
- */
1257
- id?: string;
1258
- match?: string[][] | {
1259
- from?: ({
1260
- kind?: string;
1261
- /**
1262
- * Format: uuid
1263
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1264
- */
1265
- id?: string;
1266
- } & ({
1267
- /** @description JSON ref to value from where patch should be applied. */
1268
- mutatorRef?: string[][];
1269
- } | {
1270
- mutatedRef?: string[][];
1271
- }))[];
1272
- to?: ({
1273
- kind?: string;
1274
- /**
1275
- * Format: uuid
1276
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1277
- */
1278
- id?: string;
1279
- } & ({
1280
- /** @description JSON ref to value from where patch should be applied. */
1281
- mutatorRef?: string[][];
1282
- } | {
1283
- mutatedRef?: string[][];
1284
- }))[];
1285
- };
1255
+ /** @description Patch configuration for the selector */
1286
1256
  patch?: {
1287
1257
  /**
1288
1258
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1290,26 +1260,57 @@ interface components {
1290
1260
  * add: Inserts a value into an array or adds a member to an object.
1291
1261
  * replace: Replaces a value.
1292
1262
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1293
- * 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.
1263
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1294
1264
  * remove: Removes a value.
1295
1265
  * copy: Copies a value from one location to another.
1296
1266
  * move: Moves a value from one location to another.
1297
1267
  * test: Tests that a value at the target location is equal to a specified value.
1298
- * @default copy
1268
+ *
1299
1269
  * @enum {string}
1300
1270
  */
1301
1271
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1302
- } & ({
1303
1272
  /** @description JSON ref to value from where patch should be applied. */
1304
1273
  mutatorRef?: string[][];
1305
- } | {
1306
1274
  mutatedRef?: string[][];
1307
- });
1275
+ };
1308
1276
  }[];
1309
1277
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
1310
1278
  to: {
1279
+ /**
1280
+ * Format: uuid
1281
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1282
+ */
1283
+ id?: string;
1311
1284
  kind?: string;
1312
- /** @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 */
1285
+ /** @description Match configuration for selector */
1286
+ match?: {
1287
+ refs?: string[][];
1288
+ from?: {
1289
+ /**
1290
+ * Format: uuid
1291
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1292
+ */
1293
+ id?: string;
1294
+ kind: string;
1295
+ /** @description JSON ref to value from where patch should be applied. */
1296
+ mutatorRef?: string[][];
1297
+ mutatedRef?: string[][];
1298
+ }[];
1299
+ to?: {
1300
+ /**
1301
+ * Format: uuid
1302
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1303
+ */
1304
+ id?: string;
1305
+ kind: string;
1306
+ /** @description JSON ref to value from where patch should be applied. */
1307
+ mutatorRef?: string[][];
1308
+ mutatedRef?: string[][];
1309
+ }[];
1310
+ };
1311
+ /** @description Match strategy matrix for the selector */
1312
+ match_strategy_matrix?: string[][];
1313
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
1313
1314
  model?: {
1314
1315
  /**
1315
1316
  * Format: uuid
@@ -1337,39 +1338,7 @@ interface components {
1337
1338
  kind: string;
1338
1339
  };
1339
1340
  };
1340
- /**
1341
- * Format: uuid
1342
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1343
- */
1344
- id?: string;
1345
- match?: string[][] | {
1346
- from?: ({
1347
- kind?: string;
1348
- /**
1349
- * Format: uuid
1350
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1351
- */
1352
- id?: string;
1353
- } & ({
1354
- /** @description JSON ref to value from where patch should be applied. */
1355
- mutatorRef?: string[][];
1356
- } | {
1357
- mutatedRef?: string[][];
1358
- }))[];
1359
- to?: ({
1360
- kind?: string;
1361
- /**
1362
- * Format: uuid
1363
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
1364
- */
1365
- id?: string;
1366
- } & ({
1367
- /** @description JSON ref to value from where patch should be applied. */
1368
- mutatorRef?: string[][];
1369
- } | {
1370
- mutatedRef?: string[][];
1371
- }))[];
1372
- };
1341
+ /** @description Patch configuration for the selector */
1373
1342
  patch?: {
1374
1343
  /**
1375
1344
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -1377,34 +1346,22 @@ interface components {
1377
1346
  * add: Inserts a value into an array or adds a member to an object.
1378
1347
  * replace: Replaces a value.
1379
1348
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
1380
- * 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.
1349
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
1381
1350
  * remove: Removes a value.
1382
1351
  * copy: Copies a value from one location to another.
1383
1352
  * move: Moves a value from one location to another.
1384
1353
  * test: Tests that a value at the target location is equal to a specified value.
1385
- * @default copy
1354
+ *
1386
1355
  * @enum {string}
1387
1356
  */
1388
1357
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
1389
- } & ({
1390
1358
  /** @description JSON ref to value from where patch should be applied. */
1391
1359
  mutatorRef?: string[][];
1392
- } | {
1393
1360
  mutatedRef?: string[][];
1394
- });
1361
+ };
1395
1362
  }[];
1396
1363
  };
1397
1364
  }[];
1398
- /**
1399
- * Format: date-time
1400
- * @description Timestamp when the resource was created.
1401
- */
1402
- created_at?: string;
1403
- /**
1404
- * Format: date-time
1405
- * @description Timestamp when the resource was updated.
1406
- */
1407
- updated_at?: string;
1408
1365
  }[];
1409
1366
  };
1410
1367
  MesheryPattern: {
@@ -2230,12 +2187,11 @@ interface components {
2230
2187
  relationships: {
2231
2188
  /**
2232
2189
  * Format: uuid
2233
- * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
2190
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2234
2191
  */
2235
- id?: string;
2192
+ id: string;
2236
2193
  /**
2237
2194
  * @description Specifies the version of the schema used for the relationship definition.
2238
- * @default relationships.meshery.io/v1alpha3
2239
2195
  * @example [
2240
2196
  * "v1",
2241
2197
  * "v1alpha1",
@@ -2246,34 +2202,6 @@ interface components {
2246
2202
  schemaVersion: string;
2247
2203
  /** @description A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1. */
2248
2204
  version: string;
2249
- /** @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 */
2250
- model: {
2251
- /**
2252
- * Format: uuid
2253
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2254
- */
2255
- id: string;
2256
- /**
2257
- * @description The unique name for the model within the scope of a registrant.
2258
- * @default untitled-model
2259
- */
2260
- name: string;
2261
- /** @description Version of the model definition. */
2262
- version: string;
2263
- /**
2264
- * @description Human-readable name for the model.
2265
- * @default Untitled Model
2266
- */
2267
- displayName: string;
2268
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
2269
- model: {
2270
- /** @description Version of the model as defined by the registrant. */
2271
- version: string;
2272
- };
2273
- registrant: {
2274
- kind: string;
2275
- };
2276
- };
2277
2205
  /**
2278
2206
  * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
2279
2207
  * @enum {string}
@@ -2285,12 +2213,9 @@ interface components {
2285
2213
  subType: string;
2286
2214
  /**
2287
2215
  * @description Status of the relationship.
2288
- * @default enabled
2289
2216
  * @enum {string}
2290
2217
  */
2291
- status?: "pending" | "approved" | "ignored" | "enabled" | "deleted";
2292
- /** @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. */
2293
- evaluationQuery?: string;
2218
+ status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
2294
2219
  /** @description Capabilities associated with the relationship. */
2295
2220
  capabilities?: {
2296
2221
  /**
@@ -2308,15 +2233,15 @@ interface components {
2308
2233
  /** @description Name of the capability in human-readible format. */
2309
2234
  displayName: string;
2310
2235
  /** @description A written representation of the purpose and characteristics of the capability. */
2311
- description?: string;
2236
+ description: string;
2312
2237
  /** @description Top-level categorization of the capability */
2313
2238
  kind: string;
2314
2239
  /** @description Classification of capabilities. Used to group capabilities similar in nature. */
2315
2240
  type: string;
2316
2241
  /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
2317
- subType?: string;
2242
+ subType: string;
2318
2243
  /** @description Key that backs the capability. */
2319
- key?: string;
2244
+ key: string;
2320
2245
  /** @description State of the entity in which the capability is applicable. */
2321
2246
  entityState: ("declaration" | "instance")[];
2322
2247
  /**
@@ -2334,12 +2259,8 @@ interface components {
2334
2259
  metadata?: {
2335
2260
  /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
2336
2261
  description?: string;
2337
- /**
2338
- * @description Indicates whether the relationship should be treated as a logical representation only
2339
- * @default false
2340
- */
2341
- isAnnotation?: boolean;
2342
- styles?: Partial<{
2262
+ /** @description Visualization styles for a relationship */
2263
+ styles?: {
2343
2264
  /** @description Primary color of the component used for UI representation. */
2344
2265
  primaryColor: string;
2345
2266
  /** @description Secondary color of the entity used for UI representation. */
@@ -2350,9 +2271,12 @@ interface components {
2350
2271
  svgColor: string;
2351
2272
  /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
2352
2273
  svgComplete?: string;
2353
- /** @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%)). */
2274
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
2354
2275
  color?: string;
2355
- /** @description The opacity of the label text, including its outline. */
2276
+ /**
2277
+ * Format: float
2278
+ * @description The opacity of the label text, including its outline.
2279
+ */
2356
2280
  "text-opacity"?: number;
2357
2281
  /** @description A comma-separated list of font names to use on the label text. */
2358
2282
  "font-family"?: string;
@@ -2367,115 +2291,154 @@ interface components {
2367
2291
  * @enum {string}
2368
2292
  */
2369
2293
  "text-transform"?: "none" | "uppercase" | "lowercase";
2370
- /** @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 */
2294
+ /**
2295
+ * Format: float
2296
+ * @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
2297
+ */
2371
2298
  opacity?: number;
2372
2299
  /** @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. */
2373
2300
  "z-index"?: number;
2374
- /** @description The text to display for an elements label. Can give a path, e.g. data(id) will label with the elements id */
2301
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
2375
2302
  label?: string;
2376
- } & {
2377
2303
  /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
2378
2304
  "edge-animation"?: string;
2379
2305
  /**
2380
2306
  * @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.
2381
- * @default straight
2382
2307
  * @enum {string}
2383
2308
  */
2384
- "curve-style"?: "straight" | "haystack" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
2385
- /** @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%)). */
2309
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
2310
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
2386
2311
  "line-color"?: string;
2387
2312
  /**
2388
- * @description The style of the edges line.
2313
+ * @description The style of the edge's line.
2389
2314
  * @enum {string}
2390
2315
  */
2391
2316
  "line-style"?: "solid" | "dotted" | "dashed";
2392
2317
  /**
2393
- * @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.
2394
- * @default butt
2318
+ * @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.
2395
2319
  * @enum {string}
2396
2320
  */
2397
2321
  "line-cap"?: "butt" | "round" | "square";
2398
2322
  /**
2399
- * @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.
2400
- * @default 1
2323
+ * Format: float
2324
+ * @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.
2401
2325
  */
2402
2326
  "line-opacity"?: number;
2403
- /** @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%)). */
2327
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
2404
2328
  "target-arrow-color"?: string;
2405
2329
  /**
2406
- * @description The shape of the edges source arrow
2330
+ * @description The shape of the edge's source arrow
2407
2331
  * @enum {string}
2408
2332
  */
2409
2333
  "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
2410
2334
  /**
2411
- * @description The fill state of the edges source arrow
2335
+ * @description The fill state of the edge's source arrow
2412
2336
  * @enum {string}
2413
2337
  */
2414
2338
  "target-arrow-fill"?: "filled" | "hollow";
2415
- /** @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%)). */
2339
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
2416
2340
  "mid-target-arrow-color"?: string;
2417
2341
  /**
2418
- * @description The shape of the edges source arrow
2342
+ * @description The shape of the edge's source arrow
2419
2343
  * @enum {string}
2420
2344
  */
2421
2345
  "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
2422
2346
  /**
2423
- * @description The fill state of the edges source arrow
2347
+ * @description The fill state of the edge's source arrow
2424
2348
  * @enum {string}
2425
2349
  */
2426
2350
  "mid-target-arrow-fill"?: "filled" | "hollow";
2427
- /** @description Scaling for the arrow size. */
2351
+ /**
2352
+ * Format: float
2353
+ * @description Scaling for the arrow size.
2354
+ */
2428
2355
  "arrow-scale"?: number;
2429
- /** @description The text to display for an edges source label. Can give a path, e.g. data(id) will label with the elements id */
2356
+ /** @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 */
2430
2357
  "source-label"?: string;
2431
- /** @description The text to display for an edges target label. Can give a path, e.g. data(id) will label with the elements id */
2358
+ /** @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 */
2432
2359
  "target-label"?: string;
2433
- }> & Partial<{
2434
- /** @description Primary color of the component used for UI representation. */
2435
- primaryColor: string;
2436
- /** @description Secondary color of the entity used for UI representation. */
2437
- secondaryColor?: string;
2438
- /** @description White SVG of the entity used for UI representation on dark background. */
2439
- svgWhite: string;
2440
- /** @description Colored SVG of the entity used for UI representation on light background. */
2441
- svgColor: string;
2442
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
2443
- svgComplete?: string;
2444
- /** @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%)). */
2445
- color?: string;
2446
- /** @description The opacity of the label text, including its outline. */
2447
- "text-opacity"?: number;
2448
- /** @description A comma-separated list of font names to use on the label text. */
2449
- "font-family"?: string;
2450
- /** @description The size of the label text. */
2451
- "font-size"?: string;
2452
- /** @description A CSS font style to be applied to the label text. */
2453
- "font-style"?: string;
2454
- /** @description A CSS font weight to be applied to the label text. */
2455
- "font-weight"?: string;
2456
- /**
2457
- * @description A transformation to apply to the label text
2458
- * @enum {string}
2459
- */
2460
- "text-transform"?: "none" | "uppercase" | "lowercase";
2461
- /** @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 */
2462
- opacity?: number;
2463
- /** @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. */
2464
- "z-index"?: number;
2465
- /** @description The text to display for an element’s label. Can give a path, e.g. data(id) will label with the elements id */
2466
- label?: string;
2467
- }>;
2360
+ };
2361
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
2362
+ isAnnotation?: boolean;
2468
2363
  } & {
2469
2364
  [key: string]: unknown;
2470
2365
  };
2366
+ /** @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 */
2367
+ model: {
2368
+ /**
2369
+ * Format: uuid
2370
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2371
+ */
2372
+ id: string;
2373
+ /**
2374
+ * @description The unique name for the model within the scope of a registrant.
2375
+ * @default untitled-model
2376
+ */
2377
+ name: string;
2378
+ /** @description Version of the model definition. */
2379
+ version: string;
2380
+ /**
2381
+ * @description Human-readable name for the model.
2382
+ * @default Untitled Model
2383
+ */
2384
+ displayName: string;
2385
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
2386
+ model: {
2387
+ /** @description Version of the model as defined by the registrant. */
2388
+ version: string;
2389
+ };
2390
+ registrant: {
2391
+ kind: string;
2392
+ };
2393
+ };
2394
+ /**
2395
+ * Format: uuid
2396
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2397
+ */
2398
+ modelId?: string;
2399
+ /** @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. */
2400
+ evaluationQuery?: string;
2471
2401
  /** @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. */
2472
2402
  selectors?: {
2473
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
2474
- deny?: {
2403
+ /** @description Selectors used to define relationships which are allowed. */
2404
+ allow: {
2475
2405
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
2476
2406
  from: {
2407
+ /**
2408
+ * Format: uuid
2409
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2410
+ */
2411
+ id?: string;
2477
2412
  kind?: string;
2478
- /** @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 */
2413
+ /** @description Match configuration for selector */
2414
+ match?: {
2415
+ refs?: string[][];
2416
+ from?: {
2417
+ /**
2418
+ * Format: uuid
2419
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2420
+ */
2421
+ id?: string;
2422
+ kind: string;
2423
+ /** @description JSON ref to value from where patch should be applied. */
2424
+ mutatorRef?: string[][];
2425
+ mutatedRef?: string[][];
2426
+ }[];
2427
+ to?: {
2428
+ /**
2429
+ * Format: uuid
2430
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2431
+ */
2432
+ id?: string;
2433
+ kind: string;
2434
+ /** @description JSON ref to value from where patch should be applied. */
2435
+ mutatorRef?: string[][];
2436
+ mutatedRef?: string[][];
2437
+ }[];
2438
+ };
2439
+ /** @description Match strategy matrix for the selector */
2440
+ match_strategy_matrix?: string[][];
2441
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
2479
2442
  model?: {
2480
2443
  /**
2481
2444
  * Format: uuid
@@ -2503,39 +2466,7 @@ interface components {
2503
2466
  kind: string;
2504
2467
  };
2505
2468
  };
2506
- /**
2507
- * Format: uuid
2508
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2509
- */
2510
- id?: string;
2511
- match?: string[][] | {
2512
- from?: ({
2513
- kind?: string;
2514
- /**
2515
- * Format: uuid
2516
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2517
- */
2518
- id?: string;
2519
- } & ({
2520
- /** @description JSON ref to value from where patch should be applied. */
2521
- mutatorRef?: string[][];
2522
- } | {
2523
- mutatedRef?: string[][];
2524
- }))[];
2525
- to?: ({
2526
- kind?: string;
2527
- /**
2528
- * Format: uuid
2529
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2530
- */
2531
- id?: string;
2532
- } & ({
2533
- /** @description JSON ref to value from where patch should be applied. */
2534
- mutatorRef?: string[][];
2535
- } | {
2536
- mutatedRef?: string[][];
2537
- }))[];
2538
- };
2469
+ /** @description Patch configuration for the selector */
2539
2470
  patch?: {
2540
2471
  /**
2541
2472
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -2543,33 +2474,64 @@ interface components {
2543
2474
  * add: Inserts a value into an array or adds a member to an object.
2544
2475
  * replace: Replaces a value.
2545
2476
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
2546
- * 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.
2477
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
2547
2478
  * remove: Removes a value.
2548
2479
  * copy: Copies a value from one location to another.
2549
2480
  * move: Moves a value from one location to another.
2550
2481
  * test: Tests that a value at the target location is equal to a specified value.
2551
- * @default copy
2482
+ *
2552
2483
  * @enum {string}
2553
2484
  */
2554
2485
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
2555
- } & ({
2556
2486
  /** @description JSON ref to value from where patch should be applied. */
2557
2487
  mutatorRef?: string[][];
2558
- } | {
2559
2488
  mutatedRef?: string[][];
2560
- });
2489
+ };
2561
2490
  }[];
2562
2491
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
2563
2492
  to: {
2493
+ /**
2494
+ * Format: uuid
2495
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2496
+ */
2497
+ id?: string;
2564
2498
  kind?: string;
2565
- /** @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 */
2566
- model?: {
2567
- /**
2568
- * Format: uuid
2569
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2570
- */
2571
- id: string;
2572
- /**
2499
+ /** @description Match configuration for selector */
2500
+ match?: {
2501
+ refs?: string[][];
2502
+ from?: {
2503
+ /**
2504
+ * Format: uuid
2505
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2506
+ */
2507
+ id?: string;
2508
+ kind: string;
2509
+ /** @description JSON ref to value from where patch should be applied. */
2510
+ mutatorRef?: string[][];
2511
+ mutatedRef?: string[][];
2512
+ }[];
2513
+ to?: {
2514
+ /**
2515
+ * Format: uuid
2516
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2517
+ */
2518
+ id?: string;
2519
+ kind: string;
2520
+ /** @description JSON ref to value from where patch should be applied. */
2521
+ mutatorRef?: string[][];
2522
+ mutatedRef?: string[][];
2523
+ }[];
2524
+ };
2525
+ /** @description Match strategy matrix for the selector */
2526
+ match_strategy_matrix?: string[][];
2527
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
2528
+ model?: {
2529
+ /**
2530
+ * Format: uuid
2531
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2532
+ */
2533
+ id: string;
2534
+ /**
2573
2535
  * @description The unique name for the model within the scope of a registrant.
2574
2536
  * @default untitled-model
2575
2537
  */
@@ -2590,39 +2552,7 @@ interface components {
2590
2552
  kind: string;
2591
2553
  };
2592
2554
  };
2593
- /**
2594
- * Format: uuid
2595
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2596
- */
2597
- id?: string;
2598
- match?: string[][] | {
2599
- from?: ({
2600
- kind?: string;
2601
- /**
2602
- * Format: uuid
2603
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2604
- */
2605
- id?: string;
2606
- } & ({
2607
- /** @description JSON ref to value from where patch should be applied. */
2608
- mutatorRef?: string[][];
2609
- } | {
2610
- mutatedRef?: string[][];
2611
- }))[];
2612
- to?: ({
2613
- kind?: string;
2614
- /**
2615
- * Format: uuid
2616
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2617
- */
2618
- id?: string;
2619
- } & ({
2620
- /** @description JSON ref to value from where patch should be applied. */
2621
- mutatorRef?: string[][];
2622
- } | {
2623
- mutatedRef?: string[][];
2624
- }))[];
2625
- };
2555
+ /** @description Patch configuration for the selector */
2626
2556
  patch?: {
2627
2557
  /**
2628
2558
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -2630,31 +2560,60 @@ interface components {
2630
2560
  * add: Inserts a value into an array or adds a member to an object.
2631
2561
  * replace: Replaces a value.
2632
2562
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
2633
- * 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.
2563
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
2634
2564
  * remove: Removes a value.
2635
2565
  * copy: Copies a value from one location to another.
2636
2566
  * move: Moves a value from one location to another.
2637
2567
  * test: Tests that a value at the target location is equal to a specified value.
2638
- * @default copy
2568
+ *
2639
2569
  * @enum {string}
2640
2570
  */
2641
2571
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
2642
- } & ({
2643
2572
  /** @description JSON ref to value from where patch should be applied. */
2644
2573
  mutatorRef?: string[][];
2645
- } | {
2646
2574
  mutatedRef?: string[][];
2647
- });
2575
+ };
2648
2576
  }[];
2649
2577
  };
2650
- /** @description Selectors used to define relationships which are allowed. */
2651
- allow: {
2578
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
2579
+ deny?: {
2652
2580
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
2653
2581
  from: {
2582
+ /**
2583
+ * Format: uuid
2584
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2585
+ */
2586
+ id?: string;
2654
2587
  kind?: string;
2655
- /** @description Strategy criterion for determing how to match the values at mutator/mutated paths */
2588
+ /** @description Match configuration for selector */
2589
+ match?: {
2590
+ refs?: string[][];
2591
+ from?: {
2592
+ /**
2593
+ * Format: uuid
2594
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2595
+ */
2596
+ id?: string;
2597
+ kind: string;
2598
+ /** @description JSON ref to value from where patch should be applied. */
2599
+ mutatorRef?: string[][];
2600
+ mutatedRef?: string[][];
2601
+ }[];
2602
+ to?: {
2603
+ /**
2604
+ * Format: uuid
2605
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2606
+ */
2607
+ id?: string;
2608
+ kind: string;
2609
+ /** @description JSON ref to value from where patch should be applied. */
2610
+ mutatorRef?: string[][];
2611
+ mutatedRef?: string[][];
2612
+ }[];
2613
+ };
2614
+ /** @description Match strategy matrix for the selector */
2656
2615
  match_strategy_matrix?: string[][];
2657
- /** @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 */
2616
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
2658
2617
  model?: {
2659
2618
  /**
2660
2619
  * Format: uuid
@@ -2682,39 +2641,7 @@ interface components {
2682
2641
  kind: string;
2683
2642
  };
2684
2643
  };
2685
- /**
2686
- * Format: uuid
2687
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2688
- */
2689
- id?: string;
2690
- match?: string[][] | {
2691
- from?: ({
2692
- kind?: string;
2693
- /**
2694
- * Format: uuid
2695
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2696
- */
2697
- id?: string;
2698
- } & ({
2699
- /** @description JSON ref to value from where patch should be applied. */
2700
- mutatorRef?: string[][];
2701
- } | {
2702
- mutatedRef?: string[][];
2703
- }))[];
2704
- to?: ({
2705
- kind?: string;
2706
- /**
2707
- * Format: uuid
2708
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2709
- */
2710
- id?: string;
2711
- } & ({
2712
- /** @description JSON ref to value from where patch should be applied. */
2713
- mutatorRef?: string[][];
2714
- } | {
2715
- mutatedRef?: string[][];
2716
- }))[];
2717
- };
2644
+ /** @description Patch configuration for the selector */
2718
2645
  patch?: {
2719
2646
  /**
2720
2647
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -2722,26 +2649,57 @@ interface components {
2722
2649
  * add: Inserts a value into an array or adds a member to an object.
2723
2650
  * replace: Replaces a value.
2724
2651
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
2725
- * 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.
2652
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
2726
2653
  * remove: Removes a value.
2727
2654
  * copy: Copies a value from one location to another.
2728
2655
  * move: Moves a value from one location to another.
2729
2656
  * test: Tests that a value at the target location is equal to a specified value.
2730
- * @default copy
2657
+ *
2731
2658
  * @enum {string}
2732
2659
  */
2733
2660
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
2734
- } & ({
2735
2661
  /** @description JSON ref to value from where patch should be applied. */
2736
2662
  mutatorRef?: string[][];
2737
- } | {
2738
2663
  mutatedRef?: string[][];
2739
- });
2664
+ };
2740
2665
  }[];
2741
2666
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
2742
2667
  to: {
2668
+ /**
2669
+ * Format: uuid
2670
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2671
+ */
2672
+ id?: string;
2743
2673
  kind?: string;
2744
- /** @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 */
2674
+ /** @description Match configuration for selector */
2675
+ match?: {
2676
+ refs?: string[][];
2677
+ from?: {
2678
+ /**
2679
+ * Format: uuid
2680
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2681
+ */
2682
+ id?: string;
2683
+ kind: string;
2684
+ /** @description JSON ref to value from where patch should be applied. */
2685
+ mutatorRef?: string[][];
2686
+ mutatedRef?: string[][];
2687
+ }[];
2688
+ to?: {
2689
+ /**
2690
+ * Format: uuid
2691
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
2692
+ */
2693
+ id?: string;
2694
+ kind: string;
2695
+ /** @description JSON ref to value from where patch should be applied. */
2696
+ mutatorRef?: string[][];
2697
+ mutatedRef?: string[][];
2698
+ }[];
2699
+ };
2700
+ /** @description Match strategy matrix for the selector */
2701
+ match_strategy_matrix?: string[][];
2702
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
2745
2703
  model?: {
2746
2704
  /**
2747
2705
  * Format: uuid
@@ -2769,39 +2727,7 @@ interface components {
2769
2727
  kind: string;
2770
2728
  };
2771
2729
  };
2772
- /**
2773
- * Format: uuid
2774
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2775
- */
2776
- id?: string;
2777
- match?: string[][] | {
2778
- from?: ({
2779
- kind?: string;
2780
- /**
2781
- * Format: uuid
2782
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2783
- */
2784
- id?: string;
2785
- } & ({
2786
- /** @description JSON ref to value from where patch should be applied. */
2787
- mutatorRef?: string[][];
2788
- } | {
2789
- mutatedRef?: string[][];
2790
- }))[];
2791
- to?: ({
2792
- kind?: string;
2793
- /**
2794
- * Format: uuid
2795
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
2796
- */
2797
- id?: string;
2798
- } & ({
2799
- /** @description JSON ref to value from where patch should be applied. */
2800
- mutatorRef?: string[][];
2801
- } | {
2802
- mutatedRef?: string[][];
2803
- }))[];
2804
- };
2730
+ /** @description Patch configuration for the selector */
2805
2731
  patch?: {
2806
2732
  /**
2807
2733
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -2809,34 +2735,22 @@ interface components {
2809
2735
  * add: Inserts a value into an array or adds a member to an object.
2810
2736
  * replace: Replaces a value.
2811
2737
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
2812
- * 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.
2738
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
2813
2739
  * remove: Removes a value.
2814
2740
  * copy: Copies a value from one location to another.
2815
2741
  * move: Moves a value from one location to another.
2816
2742
  * test: Tests that a value at the target location is equal to a specified value.
2817
- * @default copy
2743
+ *
2818
2744
  * @enum {string}
2819
2745
  */
2820
2746
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
2821
- } & ({
2822
2747
  /** @description JSON ref to value from where patch should be applied. */
2823
2748
  mutatorRef?: string[][];
2824
- } | {
2825
2749
  mutatedRef?: string[][];
2826
- });
2750
+ };
2827
2751
  }[];
2828
2752
  };
2829
2753
  }[];
2830
- /**
2831
- * Format: date-time
2832
- * @description Timestamp when the resource was created.
2833
- */
2834
- created_at?: string;
2835
- /**
2836
- * Format: date-time
2837
- * @description Timestamp when the resource was updated.
2838
- */
2839
- updated_at?: string;
2840
2754
  }[];
2841
2755
  };
2842
2756
  /** Format: date-time */
@@ -3671,12 +3585,11 @@ interface components {
3671
3585
  relationships: {
3672
3586
  /**
3673
3587
  * Format: uuid
3674
- * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
3588
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3675
3589
  */
3676
- id?: string;
3590
+ id: string;
3677
3591
  /**
3678
3592
  * @description Specifies the version of the schema used for the relationship definition.
3679
- * @default relationships.meshery.io/v1alpha3
3680
3593
  * @example [
3681
3594
  * "v1",
3682
3595
  * "v1alpha1",
@@ -3687,34 +3600,6 @@ interface components {
3687
3600
  schemaVersion: string;
3688
3601
  /** @description A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1. */
3689
3602
  version: string;
3690
- /** @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 */
3691
- model: {
3692
- /**
3693
- * Format: uuid
3694
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3695
- */
3696
- id: string;
3697
- /**
3698
- * @description The unique name for the model within the scope of a registrant.
3699
- * @default untitled-model
3700
- */
3701
- name: string;
3702
- /** @description Version of the model definition. */
3703
- version: string;
3704
- /**
3705
- * @description Human-readable name for the model.
3706
- * @default Untitled Model
3707
- */
3708
- displayName: string;
3709
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3710
- model: {
3711
- /** @description Version of the model as defined by the registrant. */
3712
- version: string;
3713
- };
3714
- registrant: {
3715
- kind: string;
3716
- };
3717
- };
3718
3603
  /**
3719
3604
  * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
3720
3605
  * @enum {string}
@@ -3726,12 +3611,9 @@ interface components {
3726
3611
  subType: string;
3727
3612
  /**
3728
3613
  * @description Status of the relationship.
3729
- * @default enabled
3730
3614
  * @enum {string}
3731
3615
  */
3732
- status?: "pending" | "approved" | "ignored" | "enabled" | "deleted";
3733
- /** @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. */
3734
- evaluationQuery?: string;
3616
+ status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
3735
3617
  /** @description Capabilities associated with the relationship. */
3736
3618
  capabilities?: {
3737
3619
  /**
@@ -3749,15 +3631,15 @@ interface components {
3749
3631
  /** @description Name of the capability in human-readible format. */
3750
3632
  displayName: string;
3751
3633
  /** @description A written representation of the purpose and characteristics of the capability. */
3752
- description?: string;
3634
+ description: string;
3753
3635
  /** @description Top-level categorization of the capability */
3754
3636
  kind: string;
3755
3637
  /** @description Classification of capabilities. Used to group capabilities similar in nature. */
3756
3638
  type: string;
3757
3639
  /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
3758
- subType?: string;
3640
+ subType: string;
3759
3641
  /** @description Key that backs the capability. */
3760
- key?: string;
3642
+ key: string;
3761
3643
  /** @description State of the entity in which the capability is applicable. */
3762
3644
  entityState: ("declaration" | "instance")[];
3763
3645
  /**
@@ -3775,12 +3657,8 @@ interface components {
3775
3657
  metadata?: {
3776
3658
  /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
3777
3659
  description?: string;
3778
- /**
3779
- * @description Indicates whether the relationship should be treated as a logical representation only
3780
- * @default false
3781
- */
3782
- isAnnotation?: boolean;
3783
- styles?: Partial<{
3660
+ /** @description Visualization styles for a relationship */
3661
+ styles?: {
3784
3662
  /** @description Primary color of the component used for UI representation. */
3785
3663
  primaryColor: string;
3786
3664
  /** @description Secondary color of the entity used for UI representation. */
@@ -3791,9 +3669,12 @@ interface components {
3791
3669
  svgColor: string;
3792
3670
  /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
3793
3671
  svgComplete?: string;
3794
- /** @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%)). */
3672
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
3795
3673
  color?: string;
3796
- /** @description The opacity of the label text, including its outline. */
3674
+ /**
3675
+ * Format: float
3676
+ * @description The opacity of the label text, including its outline.
3677
+ */
3797
3678
  "text-opacity"?: number;
3798
3679
  /** @description A comma-separated list of font names to use on the label text. */
3799
3680
  "font-family"?: string;
@@ -3808,175 +3689,182 @@ interface components {
3808
3689
  * @enum {string}
3809
3690
  */
3810
3691
  "text-transform"?: "none" | "uppercase" | "lowercase";
3811
- /** @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 */
3692
+ /**
3693
+ * Format: float
3694
+ * @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
3695
+ */
3812
3696
  opacity?: number;
3813
3697
  /** @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. */
3814
3698
  "z-index"?: number;
3815
- /** @description The text to display for an elements label. Can give a path, e.g. data(id) will label with the elements id */
3699
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
3816
3700
  label?: string;
3817
- } & {
3818
3701
  /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
3819
3702
  "edge-animation"?: string;
3820
3703
  /**
3821
3704
  * @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.
3822
- * @default straight
3823
3705
  * @enum {string}
3824
3706
  */
3825
- "curve-style"?: "straight" | "haystack" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
3826
- /** @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%)). */
3707
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
3708
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
3827
3709
  "line-color"?: string;
3828
3710
  /**
3829
- * @description The style of the edges line.
3711
+ * @description The style of the edge's line.
3830
3712
  * @enum {string}
3831
3713
  */
3832
3714
  "line-style"?: "solid" | "dotted" | "dashed";
3833
3715
  /**
3834
- * @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.
3835
- * @default butt
3716
+ * @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.
3836
3717
  * @enum {string}
3837
3718
  */
3838
3719
  "line-cap"?: "butt" | "round" | "square";
3839
3720
  /**
3840
- * @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.
3841
- * @default 1
3721
+ * Format: float
3722
+ * @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.
3842
3723
  */
3843
3724
  "line-opacity"?: number;
3844
- /** @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%)). */
3725
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
3845
3726
  "target-arrow-color"?: string;
3846
3727
  /**
3847
- * @description The shape of the edges source arrow
3728
+ * @description The shape of the edge's source arrow
3848
3729
  * @enum {string}
3849
3730
  */
3850
3731
  "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
3851
3732
  /**
3852
- * @description The fill state of the edges source arrow
3733
+ * @description The fill state of the edge's source arrow
3853
3734
  * @enum {string}
3854
3735
  */
3855
3736
  "target-arrow-fill"?: "filled" | "hollow";
3856
- /** @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%)). */
3737
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
3857
3738
  "mid-target-arrow-color"?: string;
3858
3739
  /**
3859
- * @description The shape of the edges source arrow
3740
+ * @description The shape of the edge's source arrow
3860
3741
  * @enum {string}
3861
3742
  */
3862
3743
  "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
3863
3744
  /**
3864
- * @description The fill state of the edges source arrow
3745
+ * @description The fill state of the edge's source arrow
3865
3746
  * @enum {string}
3866
3747
  */
3867
3748
  "mid-target-arrow-fill"?: "filled" | "hollow";
3868
- /** @description Scaling for the arrow size. */
3749
+ /**
3750
+ * Format: float
3751
+ * @description Scaling for the arrow size.
3752
+ */
3869
3753
  "arrow-scale"?: number;
3870
- /** @description The text to display for an edges source label. Can give a path, e.g. data(id) will label with the elements id */
3754
+ /** @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 */
3871
3755
  "source-label"?: string;
3872
- /** @description The text to display for an edges target label. Can give a path, e.g. data(id) will label with the elements id */
3756
+ /** @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 */
3873
3757
  "target-label"?: string;
3874
- }> & Partial<{
3875
- /** @description Primary color of the component used for UI representation. */
3876
- primaryColor: string;
3877
- /** @description Secondary color of the entity used for UI representation. */
3878
- secondaryColor?: string;
3879
- /** @description White SVG of the entity used for UI representation on dark background. */
3880
- svgWhite: string;
3881
- /** @description Colored SVG of the entity used for UI representation on light background. */
3882
- svgColor: string;
3883
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
3884
- svgComplete?: string;
3885
- /** @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%)). */
3886
- color?: string;
3887
- /** @description The opacity of the label text, including its outline. */
3888
- "text-opacity"?: number;
3889
- /** @description A comma-separated list of font names to use on the label text. */
3890
- "font-family"?: string;
3891
- /** @description The size of the label text. */
3892
- "font-size"?: string;
3893
- /** @description A CSS font style to be applied to the label text. */
3894
- "font-style"?: string;
3895
- /** @description A CSS font weight to be applied to the label text. */
3896
- "font-weight"?: string;
3897
- /**
3898
- * @description A transformation to apply to the label text
3899
- * @enum {string}
3900
- */
3901
- "text-transform"?: "none" | "uppercase" | "lowercase";
3902
- /** @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 */
3903
- opacity?: number;
3904
- /** @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. */
3905
- "z-index"?: number;
3906
- /** @description The text to display for an element’s label. Can give a path, e.g. data(id) will label with the elements id */
3907
- label?: string;
3908
- }>;
3758
+ };
3759
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
3760
+ isAnnotation?: boolean;
3909
3761
  } & {
3910
3762
  [key: string]: unknown;
3911
3763
  };
3912
- /** @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. */
3913
- selectors?: {
3914
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
3915
- deny?: {
3916
- /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
3917
- from: {
3918
- kind?: string;
3919
- /** @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 */
3920
- model?: {
3921
- /**
3922
- * Format: uuid
3923
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3924
- */
3925
- id: string;
3926
- /**
3927
- * @description The unique name for the model within the scope of a registrant.
3928
- * @default untitled-model
3929
- */
3930
- name: string;
3931
- /** @description Version of the model definition. */
3932
- version: string;
3933
- /**
3934
- * @description Human-readable name for the model.
3935
- * @default Untitled Model
3936
- */
3937
- displayName: string;
3938
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3939
- model: {
3940
- /** @description Version of the model as defined by the registrant. */
3941
- version: string;
3942
- };
3943
- registrant: {
3944
- kind: string;
3945
- };
3946
- };
3764
+ /** @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 */
3765
+ model: {
3766
+ /**
3767
+ * Format: uuid
3768
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3769
+ */
3770
+ id: string;
3771
+ /**
3772
+ * @description The unique name for the model within the scope of a registrant.
3773
+ * @default untitled-model
3774
+ */
3775
+ name: string;
3776
+ /** @description Version of the model definition. */
3777
+ version: string;
3778
+ /**
3779
+ * @description Human-readable name for the model.
3780
+ * @default Untitled Model
3781
+ */
3782
+ displayName: string;
3783
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3784
+ model: {
3785
+ /** @description Version of the model as defined by the registrant. */
3786
+ version: string;
3787
+ };
3788
+ registrant: {
3789
+ kind: string;
3790
+ };
3791
+ };
3792
+ /**
3793
+ * Format: uuid
3794
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3795
+ */
3796
+ modelId?: string;
3797
+ /** @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. */
3798
+ evaluationQuery?: string;
3799
+ /** @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. */
3800
+ selectors?: {
3801
+ /** @description Selectors used to define relationships which are allowed. */
3802
+ allow: {
3803
+ /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
3804
+ from: {
3947
3805
  /**
3948
3806
  * Format: uuid
3949
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
3807
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3950
3808
  */
3951
3809
  id?: string;
3952
- match?: string[][] | {
3953
- from?: ({
3954
- kind?: string;
3810
+ kind?: string;
3811
+ /** @description Match configuration for selector */
3812
+ match?: {
3813
+ refs?: string[][];
3814
+ from?: {
3955
3815
  /**
3956
3816
  * Format: uuid
3957
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
3817
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3958
3818
  */
3959
3819
  id?: string;
3960
- } & ({
3820
+ kind: string;
3961
3821
  /** @description JSON ref to value from where patch should be applied. */
3962
3822
  mutatorRef?: string[][];
3963
- } | {
3964
3823
  mutatedRef?: string[][];
3965
- }))[];
3966
- to?: ({
3967
- kind?: string;
3824
+ }[];
3825
+ to?: {
3968
3826
  /**
3969
3827
  * Format: uuid
3970
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
3828
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3971
3829
  */
3972
3830
  id?: string;
3973
- } & ({
3831
+ kind: string;
3974
3832
  /** @description JSON ref to value from where patch should be applied. */
3975
3833
  mutatorRef?: string[][];
3976
- } | {
3977
3834
  mutatedRef?: string[][];
3978
- }))[];
3835
+ }[];
3836
+ };
3837
+ /** @description Match strategy matrix for the selector */
3838
+ match_strategy_matrix?: string[][];
3839
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
3840
+ model?: {
3841
+ /**
3842
+ * Format: uuid
3843
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3844
+ */
3845
+ id: string;
3846
+ /**
3847
+ * @description The unique name for the model within the scope of a registrant.
3848
+ * @default untitled-model
3849
+ */
3850
+ name: string;
3851
+ /** @description Version of the model definition. */
3852
+ version: string;
3853
+ /**
3854
+ * @description Human-readable name for the model.
3855
+ * @default Untitled Model
3856
+ */
3857
+ displayName: string;
3858
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3859
+ model: {
3860
+ /** @description Version of the model as defined by the registrant. */
3861
+ version: string;
3862
+ };
3863
+ registrant: {
3864
+ kind: string;
3865
+ };
3979
3866
  };
3867
+ /** @description Patch configuration for the selector */
3980
3868
  patch?: {
3981
3869
  /**
3982
3870
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -3984,26 +3872,57 @@ interface components {
3984
3872
  * add: Inserts a value into an array or adds a member to an object.
3985
3873
  * replace: Replaces a value.
3986
3874
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
3987
- * 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.
3875
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
3988
3876
  * remove: Removes a value.
3989
3877
  * copy: Copies a value from one location to another.
3990
3878
  * move: Moves a value from one location to another.
3991
3879
  * test: Tests that a value at the target location is equal to a specified value.
3992
- * @default copy
3880
+ *
3993
3881
  * @enum {string}
3994
3882
  */
3995
3883
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
3996
- } & ({
3997
3884
  /** @description JSON ref to value from where patch should be applied. */
3998
3885
  mutatorRef?: string[][];
3999
- } | {
4000
3886
  mutatedRef?: string[][];
4001
- });
3887
+ };
4002
3888
  }[];
4003
3889
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
4004
3890
  to: {
3891
+ /**
3892
+ * Format: uuid
3893
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3894
+ */
3895
+ id?: string;
4005
3896
  kind?: string;
4006
- /** @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 */
3897
+ /** @description Match configuration for selector */
3898
+ match?: {
3899
+ refs?: string[][];
3900
+ from?: {
3901
+ /**
3902
+ * Format: uuid
3903
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3904
+ */
3905
+ id?: string;
3906
+ kind: string;
3907
+ /** @description JSON ref to value from where patch should be applied. */
3908
+ mutatorRef?: string[][];
3909
+ mutatedRef?: string[][];
3910
+ }[];
3911
+ to?: {
3912
+ /**
3913
+ * Format: uuid
3914
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3915
+ */
3916
+ id?: string;
3917
+ kind: string;
3918
+ /** @description JSON ref to value from where patch should be applied. */
3919
+ mutatorRef?: string[][];
3920
+ mutatedRef?: string[][];
3921
+ }[];
3922
+ };
3923
+ /** @description Match strategy matrix for the selector */
3924
+ match_strategy_matrix?: string[][];
3925
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
4007
3926
  model?: {
4008
3927
  /**
4009
3928
  * Format: uuid
@@ -4031,39 +3950,7 @@ interface components {
4031
3950
  kind: string;
4032
3951
  };
4033
3952
  };
4034
- /**
4035
- * Format: uuid
4036
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4037
- */
4038
- id?: string;
4039
- match?: string[][] | {
4040
- from?: ({
4041
- kind?: string;
4042
- /**
4043
- * Format: uuid
4044
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4045
- */
4046
- id?: string;
4047
- } & ({
4048
- /** @description JSON ref to value from where patch should be applied. */
4049
- mutatorRef?: string[][];
4050
- } | {
4051
- mutatedRef?: string[][];
4052
- }))[];
4053
- to?: ({
4054
- kind?: string;
4055
- /**
4056
- * Format: uuid
4057
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4058
- */
4059
- id?: string;
4060
- } & ({
4061
- /** @description JSON ref to value from where patch should be applied. */
4062
- mutatorRef?: string[][];
4063
- } | {
4064
- mutatedRef?: string[][];
4065
- }))[];
4066
- };
3953
+ /** @description Patch configuration for the selector */
4067
3954
  patch?: {
4068
3955
  /**
4069
3956
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -4071,31 +3958,60 @@ interface components {
4071
3958
  * add: Inserts a value into an array or adds a member to an object.
4072
3959
  * replace: Replaces a value.
4073
3960
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4074
- * 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.
3961
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4075
3962
  * remove: Removes a value.
4076
3963
  * copy: Copies a value from one location to another.
4077
3964
  * move: Moves a value from one location to another.
4078
3965
  * test: Tests that a value at the target location is equal to a specified value.
4079
- * @default copy
3966
+ *
4080
3967
  * @enum {string}
4081
3968
  */
4082
3969
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4083
- } & ({
4084
3970
  /** @description JSON ref to value from where patch should be applied. */
4085
3971
  mutatorRef?: string[][];
4086
- } | {
4087
3972
  mutatedRef?: string[][];
4088
- });
3973
+ };
4089
3974
  }[];
4090
3975
  };
4091
- /** @description Selectors used to define relationships which are allowed. */
4092
- allow: {
3976
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
3977
+ deny?: {
4093
3978
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
4094
3979
  from: {
3980
+ /**
3981
+ * Format: uuid
3982
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3983
+ */
3984
+ id?: string;
4095
3985
  kind?: string;
4096
- /** @description Strategy criterion for determing how to match the values at mutator/mutated paths */
3986
+ /** @description Match configuration for selector */
3987
+ match?: {
3988
+ refs?: string[][];
3989
+ from?: {
3990
+ /**
3991
+ * Format: uuid
3992
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3993
+ */
3994
+ id?: string;
3995
+ kind: string;
3996
+ /** @description JSON ref to value from where patch should be applied. */
3997
+ mutatorRef?: string[][];
3998
+ mutatedRef?: string[][];
3999
+ }[];
4000
+ to?: {
4001
+ /**
4002
+ * Format: uuid
4003
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
4004
+ */
4005
+ id?: string;
4006
+ kind: string;
4007
+ /** @description JSON ref to value from where patch should be applied. */
4008
+ mutatorRef?: string[][];
4009
+ mutatedRef?: string[][];
4010
+ }[];
4011
+ };
4012
+ /** @description Match strategy matrix for the selector */
4097
4013
  match_strategy_matrix?: string[][];
4098
- /** @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 */
4014
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
4099
4015
  model?: {
4100
4016
  /**
4101
4017
  * Format: uuid
@@ -4123,39 +4039,7 @@ interface components {
4123
4039
  kind: string;
4124
4040
  };
4125
4041
  };
4126
- /**
4127
- * Format: uuid
4128
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4129
- */
4130
- id?: string;
4131
- match?: string[][] | {
4132
- from?: ({
4133
- kind?: string;
4134
- /**
4135
- * Format: uuid
4136
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4137
- */
4138
- id?: string;
4139
- } & ({
4140
- /** @description JSON ref to value from where patch should be applied. */
4141
- mutatorRef?: string[][];
4142
- } | {
4143
- mutatedRef?: string[][];
4144
- }))[];
4145
- to?: ({
4146
- kind?: string;
4147
- /**
4148
- * Format: uuid
4149
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4150
- */
4151
- id?: string;
4152
- } & ({
4153
- /** @description JSON ref to value from where patch should be applied. */
4154
- mutatorRef?: string[][];
4155
- } | {
4156
- mutatedRef?: string[][];
4157
- }))[];
4158
- };
4042
+ /** @description Patch configuration for the selector */
4159
4043
  patch?: {
4160
4044
  /**
4161
4045
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -4163,26 +4047,57 @@ interface components {
4163
4047
  * add: Inserts a value into an array or adds a member to an object.
4164
4048
  * replace: Replaces a value.
4165
4049
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4166
- * 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.
4050
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4167
4051
  * remove: Removes a value.
4168
4052
  * copy: Copies a value from one location to another.
4169
4053
  * move: Moves a value from one location to another.
4170
4054
  * test: Tests that a value at the target location is equal to a specified value.
4171
- * @default copy
4055
+ *
4172
4056
  * @enum {string}
4173
4057
  */
4174
4058
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4175
- } & ({
4176
4059
  /** @description JSON ref to value from where patch should be applied. */
4177
4060
  mutatorRef?: string[][];
4178
- } | {
4179
4061
  mutatedRef?: string[][];
4180
- });
4062
+ };
4181
4063
  }[];
4182
4064
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
4183
4065
  to: {
4066
+ /**
4067
+ * Format: uuid
4068
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
4069
+ */
4070
+ id?: string;
4184
4071
  kind?: string;
4185
- /** @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 */
4072
+ /** @description Match configuration for selector */
4073
+ match?: {
4074
+ refs?: string[][];
4075
+ from?: {
4076
+ /**
4077
+ * Format: uuid
4078
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
4079
+ */
4080
+ id?: string;
4081
+ kind: string;
4082
+ /** @description JSON ref to value from where patch should be applied. */
4083
+ mutatorRef?: string[][];
4084
+ mutatedRef?: string[][];
4085
+ }[];
4086
+ to?: {
4087
+ /**
4088
+ * Format: uuid
4089
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
4090
+ */
4091
+ id?: string;
4092
+ kind: string;
4093
+ /** @description JSON ref to value from where patch should be applied. */
4094
+ mutatorRef?: string[][];
4095
+ mutatedRef?: string[][];
4096
+ }[];
4097
+ };
4098
+ /** @description Match strategy matrix for the selector */
4099
+ match_strategy_matrix?: string[][];
4100
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
4186
4101
  model?: {
4187
4102
  /**
4188
4103
  * Format: uuid
@@ -4210,39 +4125,7 @@ interface components {
4210
4125
  kind: string;
4211
4126
  };
4212
4127
  };
4213
- /**
4214
- * Format: uuid
4215
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4216
- */
4217
- id?: string;
4218
- match?: string[][] | {
4219
- from?: ({
4220
- kind?: string;
4221
- /**
4222
- * Format: uuid
4223
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4224
- */
4225
- id?: string;
4226
- } & ({
4227
- /** @description JSON ref to value from where patch should be applied. */
4228
- mutatorRef?: string[][];
4229
- } | {
4230
- mutatedRef?: string[][];
4231
- }))[];
4232
- to?: ({
4233
- kind?: string;
4234
- /**
4235
- * Format: uuid
4236
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
4237
- */
4238
- id?: string;
4239
- } & ({
4240
- /** @description JSON ref to value from where patch should be applied. */
4241
- mutatorRef?: string[][];
4242
- } | {
4243
- mutatedRef?: string[][];
4244
- }))[];
4245
- };
4128
+ /** @description Patch configuration for the selector */
4246
4129
  patch?: {
4247
4130
  /**
4248
4131
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -4250,34 +4133,22 @@ interface components {
4250
4133
  * add: Inserts a value into an array or adds a member to an object.
4251
4134
  * replace: Replaces a value.
4252
4135
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
4253
- * 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.
4136
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
4254
4137
  * remove: Removes a value.
4255
4138
  * copy: Copies a value from one location to another.
4256
4139
  * move: Moves a value from one location to another.
4257
4140
  * test: Tests that a value at the target location is equal to a specified value.
4258
- * @default copy
4141
+ *
4259
4142
  * @enum {string}
4260
4143
  */
4261
4144
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
4262
- } & ({
4263
4145
  /** @description JSON ref to value from where patch should be applied. */
4264
4146
  mutatorRef?: string[][];
4265
- } | {
4266
4147
  mutatedRef?: string[][];
4267
- });
4148
+ };
4268
4149
  }[];
4269
4150
  };
4270
4151
  }[];
4271
- /**
4272
- * Format: date-time
4273
- * @description Timestamp when the resource was created.
4274
- */
4275
- created_at?: string;
4276
- /**
4277
- * Format: date-time
4278
- * @description Timestamp when the resource was updated.
4279
- */
4280
- updated_at?: string;
4281
4152
  }[];
4282
4153
  };
4283
4154
  /** Format: date-time */
@@ -5121,12 +4992,11 @@ interface components {
5121
4992
  relationships: {
5122
4993
  /**
5123
4994
  * Format: uuid
5124
- * @description Uniquely identifies the entity (i.e. component) as defined in a declaration (i.e. design).
4995
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5125
4996
  */
5126
- id?: string;
4997
+ id: string;
5127
4998
  /**
5128
4999
  * @description Specifies the version of the schema used for the relationship definition.
5129
- * @default relationships.meshery.io/v1alpha3
5130
5000
  * @example [
5131
5001
  * "v1",
5132
5002
  * "v1alpha1",
@@ -5137,61 +5007,30 @@ interface components {
5137
5007
  schemaVersion: string;
5138
5008
  /** @description A valid semantic version string between 5 and 256 characters. The pattern allows for a major.minor.patch version followed by an optional pre-release tag like '-alpha' or '-beta.2' and an optional build metadata tag like '+build.1. */
5139
5009
  version: string;
5140
- /** @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 */
5141
- model: {
5010
+ /**
5011
+ * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
5012
+ * @enum {string}
5013
+ */
5014
+ kind: "hierarchical" | "edge" | "sibling";
5015
+ /** @description Classification of relationships. Used to group relationships similar in nature. */
5016
+ type: string;
5017
+ /** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
5018
+ subType: string;
5019
+ /**
5020
+ * @description Status of the relationship.
5021
+ * @enum {string}
5022
+ */
5023
+ status?: "enabled" | "ignored" | "deleted" | "approved" | "pending";
5024
+ /** @description Capabilities associated with the relationship. */
5025
+ capabilities?: {
5142
5026
  /**
5143
- * Format: uuid
5144
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5145
- */
5146
- id: string;
5147
- /**
5148
- * @description The unique name for the model within the scope of a registrant.
5149
- * @default untitled-model
5150
- */
5151
- name: string;
5152
- /** @description Version of the model definition. */
5153
- version: string;
5154
- /**
5155
- * @description Human-readable name for the model.
5156
- * @default Untitled Model
5157
- */
5158
- displayName: string;
5159
- /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
5160
- model: {
5161
- /** @description Version of the model as defined by the registrant. */
5162
- version: string;
5163
- };
5164
- registrant: {
5165
- kind: string;
5166
- };
5167
- };
5168
- /**
5169
- * @description Kind of the Relationship. Learn more about relationships - https://docs.meshery.io/concepts/logical/relationships.
5170
- * @enum {string}
5171
- */
5172
- kind: "hierarchical" | "edge" | "sibling";
5173
- /** @description Classification of relationships. Used to group relationships similar in nature. */
5174
- type: string;
5175
- /** @description Most granular unit of relationship classification. The combination of Kind, Type and SubType together uniquely identify a Relationship. */
5176
- subType: string;
5177
- /**
5178
- * @description Status of the relationship.
5179
- * @default enabled
5180
- * @enum {string}
5181
- */
5182
- status?: "pending" | "approved" | "ignored" | "enabled" | "deleted";
5183
- /** @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. */
5184
- evaluationQuery?: string;
5185
- /** @description Capabilities associated with the relationship. */
5186
- capabilities?: {
5187
- /**
5188
- * @description Specifies the version of the schema to which the capability definition conforms.
5189
- * @example [
5190
- * "v1",
5191
- * "v1alpha1",
5192
- * "v2beta3",
5193
- * "v1.custom-suffix"
5194
- * ]
5027
+ * @description Specifies the version of the schema to which the capability definition conforms.
5028
+ * @example [
5029
+ * "v1",
5030
+ * "v1alpha1",
5031
+ * "v2beta3",
5032
+ * "v1.custom-suffix"
5033
+ * ]
5195
5034
  */
5196
5035
  schemaVersion: string;
5197
5036
  /** @description Version of the capability definition. */
@@ -5199,15 +5038,15 @@ interface components {
5199
5038
  /** @description Name of the capability in human-readible format. */
5200
5039
  displayName: string;
5201
5040
  /** @description A written representation of the purpose and characteristics of the capability. */
5202
- description?: string;
5041
+ description: string;
5203
5042
  /** @description Top-level categorization of the capability */
5204
5043
  kind: string;
5205
5044
  /** @description Classification of capabilities. Used to group capabilities similar in nature. */
5206
5045
  type: string;
5207
5046
  /** @description Most granular unit of capability classification. The combination of Kind, Type and SubType together uniquely identify a Capability. */
5208
- subType?: string;
5047
+ subType: string;
5209
5048
  /** @description Key that backs the capability. */
5210
- key?: string;
5049
+ key: string;
5211
5050
  /** @description State of the entity in which the capability is applicable. */
5212
5051
  entityState: ("declaration" | "instance")[];
5213
5052
  /**
@@ -5225,12 +5064,8 @@ interface components {
5225
5064
  metadata?: {
5226
5065
  /** @description Characterization of the meaning of the relationship and its relevance to both Meshery and entities under management. */
5227
5066
  description?: string;
5228
- /**
5229
- * @description Indicates whether the relationship should be treated as a logical representation only
5230
- * @default false
5231
- */
5232
- isAnnotation?: boolean;
5233
- styles?: Partial<{
5067
+ /** @description Visualization styles for a relationship */
5068
+ styles?: {
5234
5069
  /** @description Primary color of the component used for UI representation. */
5235
5070
  primaryColor: string;
5236
5071
  /** @description Secondary color of the entity used for UI representation. */
@@ -5241,9 +5076,12 @@ interface components {
5241
5076
  svgColor: string;
5242
5077
  /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
5243
5078
  svgComplete?: string;
5244
- /** @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%)). */
5079
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
5245
5080
  color?: string;
5246
- /** @description The opacity of the label text, including its outline. */
5081
+ /**
5082
+ * Format: float
5083
+ * @description The opacity of the label text, including its outline.
5084
+ */
5247
5085
  "text-opacity"?: number;
5248
5086
  /** @description A comma-separated list of font names to use on the label text. */
5249
5087
  "font-family"?: string;
@@ -5258,115 +5096,154 @@ interface components {
5258
5096
  * @enum {string}
5259
5097
  */
5260
5098
  "text-transform"?: "none" | "uppercase" | "lowercase";
5261
- /** @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 */
5099
+ /**
5100
+ * Format: float
5101
+ * @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
5102
+ */
5262
5103
  opacity?: number;
5263
5104
  /** @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. */
5264
5105
  "z-index"?: number;
5265
- /** @description The text to display for an elements label. Can give a path, e.g. data(id) will label with the elements id */
5106
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
5266
5107
  label?: string;
5267
- } & {
5268
5108
  /** @description The animation to use for the edge. Can be like 'marching-ants' , 'blink' , 'moving-gradient',etc . */
5269
5109
  "edge-animation"?: string;
5270
5110
  /**
5271
5111
  * @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.
5272
- * @default straight
5273
5112
  * @enum {string}
5274
5113
  */
5275
- "curve-style"?: "straight" | "haystack" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
5276
- /** @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%)). */
5114
+ "curve-style"?: "haystack" | "straight" | "bezier" | "unbundled-bezier" | "segments" | "taxi";
5115
+ /** @description The colour of the edge's line. Colours may be specified by name (e.g. red), hex (e.g. */
5277
5116
  "line-color"?: string;
5278
5117
  /**
5279
- * @description The style of the edges line.
5118
+ * @description The style of the edge's line.
5280
5119
  * @enum {string}
5281
5120
  */
5282
5121
  "line-style"?: "solid" | "dotted" | "dashed";
5283
5122
  /**
5284
- * @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.
5285
- * @default butt
5123
+ * @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.
5286
5124
  * @enum {string}
5287
5125
  */
5288
5126
  "line-cap"?: "butt" | "round" | "square";
5289
5127
  /**
5290
- * @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.
5291
- * @default 1
5128
+ * Format: float
5129
+ * @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.
5292
5130
  */
5293
5131
  "line-opacity"?: number;
5294
- /** @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%)). */
5132
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
5295
5133
  "target-arrow-color"?: string;
5296
5134
  /**
5297
- * @description The shape of the edges source arrow
5135
+ * @description The shape of the edge's source arrow
5298
5136
  * @enum {string}
5299
5137
  */
5300
5138
  "target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
5301
5139
  /**
5302
- * @description The fill state of the edges source arrow
5140
+ * @description The fill state of the edge's source arrow
5303
5141
  * @enum {string}
5304
5142
  */
5305
5143
  "target-arrow-fill"?: "filled" | "hollow";
5306
- /** @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%)). */
5144
+ /** @description The colour of the edge's source arrow. Colours may be specified by name (e.g. red), hex (e.g. */
5307
5145
  "mid-target-arrow-color"?: string;
5308
5146
  /**
5309
- * @description The shape of the edges source arrow
5147
+ * @description The shape of the edge's source arrow
5310
5148
  * @enum {string}
5311
5149
  */
5312
5150
  "mid-target-arrow-shape"?: "triangle" | "triangle-tee" | "circle-triangle" | "triangle-cross" | "triangle-backcurve" | "vee" | "tee" | "square" | "circle" | "diamond" | "chevron" | "none";
5313
5151
  /**
5314
- * @description The fill state of the edges source arrow
5152
+ * @description The fill state of the edge's source arrow
5315
5153
  * @enum {string}
5316
5154
  */
5317
5155
  "mid-target-arrow-fill"?: "filled" | "hollow";
5318
- /** @description Scaling for the arrow size. */
5156
+ /**
5157
+ * Format: float
5158
+ * @description Scaling for the arrow size.
5159
+ */
5319
5160
  "arrow-scale"?: number;
5320
- /** @description The text to display for an edges source label. Can give a path, e.g. data(id) will label with the elements id */
5161
+ /** @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 */
5321
5162
  "source-label"?: string;
5322
- /** @description The text to display for an edges target label. Can give a path, e.g. data(id) will label with the elements id */
5163
+ /** @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 */
5323
5164
  "target-label"?: string;
5324
- }> & Partial<{
5325
- /** @description Primary color of the component used for UI representation. */
5326
- primaryColor: string;
5327
- /** @description Secondary color of the entity used for UI representation. */
5328
- secondaryColor?: string;
5329
- /** @description White SVG of the entity used for UI representation on dark background. */
5330
- svgWhite: string;
5331
- /** @description Colored SVG of the entity used for UI representation on light background. */
5332
- svgColor: string;
5333
- /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
5334
- svgComplete?: string;
5335
- /** @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%)). */
5336
- color?: string;
5337
- /** @description The opacity of the label text, including its outline. */
5338
- "text-opacity"?: number;
5339
- /** @description A comma-separated list of font names to use on the label text. */
5340
- "font-family"?: string;
5341
- /** @description The size of the label text. */
5342
- "font-size"?: string;
5343
- /** @description A CSS font style to be applied to the label text. */
5344
- "font-style"?: string;
5345
- /** @description A CSS font weight to be applied to the label text. */
5346
- "font-weight"?: string;
5347
- /**
5348
- * @description A transformation to apply to the label text
5349
- * @enum {string}
5350
- */
5351
- "text-transform"?: "none" | "uppercase" | "lowercase";
5352
- /** @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 */
5353
- opacity?: number;
5354
- /** @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. */
5355
- "z-index"?: number;
5356
- /** @description The text to display for an element’s label. Can give a path, e.g. data(id) will label with the elements id */
5357
- label?: string;
5358
- }>;
5165
+ };
5166
+ /** @description Indicates whether the relationship should be treated as a logical representation only */
5167
+ isAnnotation?: boolean;
5359
5168
  } & {
5360
5169
  [key: string]: unknown;
5361
5170
  };
5171
+ /** @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 */
5172
+ model: {
5173
+ /**
5174
+ * Format: uuid
5175
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5176
+ */
5177
+ id: string;
5178
+ /**
5179
+ * @description The unique name for the model within the scope of a registrant.
5180
+ * @default untitled-model
5181
+ */
5182
+ name: string;
5183
+ /** @description Version of the model definition. */
5184
+ version: string;
5185
+ /**
5186
+ * @description Human-readable name for the model.
5187
+ * @default Untitled Model
5188
+ */
5189
+ displayName: string;
5190
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
5191
+ model: {
5192
+ /** @description Version of the model as defined by the registrant. */
5193
+ version: string;
5194
+ };
5195
+ registrant: {
5196
+ kind: string;
5197
+ };
5198
+ };
5199
+ /**
5200
+ * Format: uuid
5201
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5202
+ */
5203
+ modelId?: string;
5204
+ /** @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. */
5205
+ evaluationQuery?: string;
5362
5206
  /** @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. */
5363
5207
  selectors?: {
5364
- /** @description Optional selectors used to define relationships which should not be created / is restricted. */
5365
- deny?: {
5208
+ /** @description Selectors used to define relationships which are allowed. */
5209
+ allow: {
5366
5210
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
5367
5211
  from: {
5212
+ /**
5213
+ * Format: uuid
5214
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5215
+ */
5216
+ id?: string;
5368
5217
  kind?: string;
5369
- /** @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 */
5218
+ /** @description Match configuration for selector */
5219
+ match?: {
5220
+ refs?: string[][];
5221
+ from?: {
5222
+ /**
5223
+ * Format: uuid
5224
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5225
+ */
5226
+ id?: string;
5227
+ kind: string;
5228
+ /** @description JSON ref to value from where patch should be applied. */
5229
+ mutatorRef?: string[][];
5230
+ mutatedRef?: string[][];
5231
+ }[];
5232
+ to?: {
5233
+ /**
5234
+ * Format: uuid
5235
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5236
+ */
5237
+ id?: string;
5238
+ kind: string;
5239
+ /** @description JSON ref to value from where patch should be applied. */
5240
+ mutatorRef?: string[][];
5241
+ mutatedRef?: string[][];
5242
+ }[];
5243
+ };
5244
+ /** @description Match strategy matrix for the selector */
5245
+ match_strategy_matrix?: string[][];
5246
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
5370
5247
  model?: {
5371
5248
  /**
5372
5249
  * Format: uuid
@@ -5394,39 +5271,7 @@ interface components {
5394
5271
  kind: string;
5395
5272
  };
5396
5273
  };
5397
- /**
5398
- * Format: uuid
5399
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5400
- */
5401
- id?: string;
5402
- match?: string[][] | {
5403
- from?: ({
5404
- kind?: string;
5405
- /**
5406
- * Format: uuid
5407
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5408
- */
5409
- id?: string;
5410
- } & ({
5411
- /** @description JSON ref to value from where patch should be applied. */
5412
- mutatorRef?: string[][];
5413
- } | {
5414
- mutatedRef?: string[][];
5415
- }))[];
5416
- to?: ({
5417
- kind?: string;
5418
- /**
5419
- * Format: uuid
5420
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5421
- */
5422
- id?: string;
5423
- } & ({
5424
- /** @description JSON ref to value from where patch should be applied. */
5425
- mutatorRef?: string[][];
5426
- } | {
5427
- mutatedRef?: string[][];
5428
- }))[];
5429
- };
5274
+ /** @description Patch configuration for the selector */
5430
5275
  patch?: {
5431
5276
  /**
5432
5277
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -5434,26 +5279,57 @@ interface components {
5434
5279
  * add: Inserts a value into an array or adds a member to an object.
5435
5280
  * replace: Replaces a value.
5436
5281
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
5437
- * 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.
5282
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
5438
5283
  * remove: Removes a value.
5439
5284
  * copy: Copies a value from one location to another.
5440
5285
  * move: Moves a value from one location to another.
5441
5286
  * test: Tests that a value at the target location is equal to a specified value.
5442
- * @default copy
5287
+ *
5443
5288
  * @enum {string}
5444
5289
  */
5445
5290
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
5446
- } & ({
5447
5291
  /** @description JSON ref to value from where patch should be applied. */
5448
5292
  mutatorRef?: string[][];
5449
- } | {
5450
5293
  mutatedRef?: string[][];
5451
- });
5294
+ };
5452
5295
  }[];
5453
5296
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
5454
5297
  to: {
5298
+ /**
5299
+ * Format: uuid
5300
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5301
+ */
5302
+ id?: string;
5455
5303
  kind?: string;
5456
- /** @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 */
5304
+ /** @description Match configuration for selector */
5305
+ match?: {
5306
+ refs?: string[][];
5307
+ from?: {
5308
+ /**
5309
+ * Format: uuid
5310
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5311
+ */
5312
+ id?: string;
5313
+ kind: string;
5314
+ /** @description JSON ref to value from where patch should be applied. */
5315
+ mutatorRef?: string[][];
5316
+ mutatedRef?: string[][];
5317
+ }[];
5318
+ to?: {
5319
+ /**
5320
+ * Format: uuid
5321
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5322
+ */
5323
+ id?: string;
5324
+ kind: string;
5325
+ /** @description JSON ref to value from where patch should be applied. */
5326
+ mutatorRef?: string[][];
5327
+ mutatedRef?: string[][];
5328
+ }[];
5329
+ };
5330
+ /** @description Match strategy matrix for the selector */
5331
+ match_strategy_matrix?: string[][];
5332
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
5457
5333
  model?: {
5458
5334
  /**
5459
5335
  * Format: uuid
@@ -5481,39 +5357,7 @@ interface components {
5481
5357
  kind: string;
5482
5358
  };
5483
5359
  };
5484
- /**
5485
- * Format: uuid
5486
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5487
- */
5488
- id?: string;
5489
- match?: string[][] | {
5490
- from?: ({
5491
- kind?: string;
5492
- /**
5493
- * Format: uuid
5494
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5495
- */
5496
- id?: string;
5497
- } & ({
5498
- /** @description JSON ref to value from where patch should be applied. */
5499
- mutatorRef?: string[][];
5500
- } | {
5501
- mutatedRef?: string[][];
5502
- }))[];
5503
- to?: ({
5504
- kind?: string;
5505
- /**
5506
- * Format: uuid
5507
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5508
- */
5509
- id?: string;
5510
- } & ({
5511
- /** @description JSON ref to value from where patch should be applied. */
5512
- mutatorRef?: string[][];
5513
- } | {
5514
- mutatedRef?: string[][];
5515
- }))[];
5516
- };
5360
+ /** @description Patch configuration for the selector */
5517
5361
  patch?: {
5518
5362
  /**
5519
5363
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -5521,31 +5365,60 @@ interface components {
5521
5365
  * add: Inserts a value into an array or adds a member to an object.
5522
5366
  * replace: Replaces a value.
5523
5367
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
5524
- * 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.
5368
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
5525
5369
  * remove: Removes a value.
5526
5370
  * copy: Copies a value from one location to another.
5527
5371
  * move: Moves a value from one location to another.
5528
5372
  * test: Tests that a value at the target location is equal to a specified value.
5529
- * @default copy
5373
+ *
5530
5374
  * @enum {string}
5531
5375
  */
5532
5376
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
5533
- } & ({
5534
5377
  /** @description JSON ref to value from where patch should be applied. */
5535
5378
  mutatorRef?: string[][];
5536
- } | {
5537
5379
  mutatedRef?: string[][];
5538
- });
5380
+ };
5539
5381
  }[];
5540
5382
  };
5541
- /** @description Selectors used to define relationships which are allowed. */
5542
- allow: {
5383
+ /** @description Optional selectors used to define relationships which should not be created / is restricted. */
5384
+ deny?: {
5543
5385
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
5544
5386
  from: {
5387
+ /**
5388
+ * Format: uuid
5389
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5390
+ */
5391
+ id?: string;
5545
5392
  kind?: string;
5546
- /** @description Strategy criterion for determing how to match the values at mutator/mutated paths */
5393
+ /** @description Match configuration for selector */
5394
+ match?: {
5395
+ refs?: string[][];
5396
+ from?: {
5397
+ /**
5398
+ * Format: uuid
5399
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5400
+ */
5401
+ id?: string;
5402
+ kind: string;
5403
+ /** @description JSON ref to value from where patch should be applied. */
5404
+ mutatorRef?: string[][];
5405
+ mutatedRef?: string[][];
5406
+ }[];
5407
+ to?: {
5408
+ /**
5409
+ * Format: uuid
5410
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5411
+ */
5412
+ id?: string;
5413
+ kind: string;
5414
+ /** @description JSON ref to value from where patch should be applied. */
5415
+ mutatorRef?: string[][];
5416
+ mutatedRef?: string[][];
5417
+ }[];
5418
+ };
5419
+ /** @description Match strategy matrix for the selector */
5547
5420
  match_strategy_matrix?: string[][];
5548
- /** @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 */
5421
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
5549
5422
  model?: {
5550
5423
  /**
5551
5424
  * Format: uuid
@@ -5573,39 +5446,7 @@ interface components {
5573
5446
  kind: string;
5574
5447
  };
5575
5448
  };
5576
- /**
5577
- * Format: uuid
5578
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5579
- */
5580
- id?: string;
5581
- match?: string[][] | {
5582
- from?: ({
5583
- kind?: string;
5584
- /**
5585
- * Format: uuid
5586
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5587
- */
5588
- id?: string;
5589
- } & ({
5590
- /** @description JSON ref to value from where patch should be applied. */
5591
- mutatorRef?: string[][];
5592
- } | {
5593
- mutatedRef?: string[][];
5594
- }))[];
5595
- to?: ({
5596
- kind?: string;
5597
- /**
5598
- * Format: uuid
5599
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5600
- */
5601
- id?: string;
5602
- } & ({
5603
- /** @description JSON ref to value from where patch should be applied. */
5604
- mutatorRef?: string[][];
5605
- } | {
5606
- mutatedRef?: string[][];
5607
- }))[];
5608
- };
5449
+ /** @description Patch configuration for the selector */
5609
5450
  patch?: {
5610
5451
  /**
5611
5452
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -5613,26 +5454,57 @@ interface components {
5613
5454
  * add: Inserts a value into an array or adds a member to an object.
5614
5455
  * replace: Replaces a value.
5615
5456
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
5616
- * 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.
5457
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
5617
5458
  * remove: Removes a value.
5618
5459
  * copy: Copies a value from one location to another.
5619
5460
  * move: Moves a value from one location to another.
5620
5461
  * test: Tests that a value at the target location is equal to a specified value.
5621
- * @default copy
5462
+ *
5622
5463
  * @enum {string}
5623
5464
  */
5624
5465
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
5625
- } & ({
5626
5466
  /** @description JSON ref to value from where patch should be applied. */
5627
5467
  mutatorRef?: string[][];
5628
- } | {
5629
5468
  mutatedRef?: string[][];
5630
- });
5469
+ };
5631
5470
  }[];
5632
5471
  /** @description Describes the component(s) which are involved in the relationship along with a set of actions to perform upon selection match. */
5633
5472
  to: {
5473
+ /**
5474
+ * Format: uuid
5475
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5476
+ */
5477
+ id?: string;
5634
5478
  kind?: string;
5635
- /** @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 */
5479
+ /** @description Match configuration for selector */
5480
+ match?: {
5481
+ refs?: string[][];
5482
+ from?: {
5483
+ /**
5484
+ * Format: uuid
5485
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5486
+ */
5487
+ id?: string;
5488
+ kind: string;
5489
+ /** @description JSON ref to value from where patch should be applied. */
5490
+ mutatorRef?: string[][];
5491
+ mutatedRef?: string[][];
5492
+ }[];
5493
+ to?: {
5494
+ /**
5495
+ * Format: uuid
5496
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
5497
+ */
5498
+ id?: string;
5499
+ kind: string;
5500
+ /** @description JSON ref to value from where patch should be applied. */
5501
+ mutatorRef?: string[][];
5502
+ mutatedRef?: string[][];
5503
+ }[];
5504
+ };
5505
+ /** @description Match strategy matrix for the selector */
5506
+ match_strategy_matrix?: string[][];
5507
+ /** @description Name of the model implicated by this selector. Learn more at https://docs.meshery.io/concepts/models */
5636
5508
  model?: {
5637
5509
  /**
5638
5510
  * Format: uuid
@@ -5660,39 +5532,7 @@ interface components {
5660
5532
  kind: string;
5661
5533
  };
5662
5534
  };
5663
- /**
5664
- * Format: uuid
5665
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5666
- */
5667
- id?: string;
5668
- match?: string[][] | {
5669
- from?: ({
5670
- kind?: string;
5671
- /**
5672
- * Format: uuid
5673
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5674
- */
5675
- id?: string;
5676
- } & ({
5677
- /** @description JSON ref to value from where patch should be applied. */
5678
- mutatorRef?: string[][];
5679
- } | {
5680
- mutatedRef?: string[][];
5681
- }))[];
5682
- to?: ({
5683
- kind?: string;
5684
- /**
5685
- * Format: uuid
5686
- * @description A Universally Unique Identifier used to uniquely identify entites in Meshery. The UUID core defintion is used across different schemas.
5687
- */
5688
- id?: string;
5689
- } & ({
5690
- /** @description JSON ref to value from where patch should be applied. */
5691
- mutatorRef?: string[][];
5692
- } | {
5693
- mutatedRef?: string[][];
5694
- }))[];
5695
- };
5535
+ /** @description Patch configuration for the selector */
5696
5536
  patch?: {
5697
5537
  /**
5698
5538
  * @description patchStrategy allows you to make specific changes to a resource using a standard JSON Patch format (RFC 6902).
@@ -5700,34 +5540,22 @@ interface components {
5700
5540
  * add: Inserts a value into an array or adds a member to an object.
5701
5541
  * replace: Replaces a value.
5702
5542
  * merge: Combines the values of the target location with the values from the patch. If the target location doesn't exist, it is created.
5703
- * 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.
5543
+ * strategic: specific to Kubernetes and understands the structure of Kubernetes objects.
5704
5544
  * remove: Removes a value.
5705
5545
  * copy: Copies a value from one location to another.
5706
5546
  * move: Moves a value from one location to another.
5707
5547
  * test: Tests that a value at the target location is equal to a specified value.
5708
- * @default copy
5548
+ *
5709
5549
  * @enum {string}
5710
5550
  */
5711
5551
  patchStrategy?: "merge" | "strategic" | "add" | "remove" | "copy" | "move" | "test";
5712
- } & ({
5713
5552
  /** @description JSON ref to value from where patch should be applied. */
5714
5553
  mutatorRef?: string[][];
5715
- } | {
5716
5554
  mutatedRef?: string[][];
5717
- });
5555
+ };
5718
5556
  }[];
5719
5557
  };
5720
5558
  }[];
5721
- /**
5722
- * Format: date-time
5723
- * @description Timestamp when the resource was created.
5724
- */
5725
- created_at?: string;
5726
- /**
5727
- * Format: date-time
5728
- * @description Timestamp when the resource was updated.
5729
- */
5730
- updated_at?: string;
5731
5559
  }[];
5732
5560
  };
5733
5561
  /** Format: date-time */