@meshery/schemas 1.3.20 → 1.3.21

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 (36) hide show
  1. package/dist/cloudApi.d.mts +431 -17
  2. package/dist/cloudApi.d.ts +431 -17
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1beta2/key/Key.d.ts +18 -3
  6. package/dist/constructs/v1beta2/key/KeySchema.js +1 -1
  7. package/dist/constructs/v1beta2/key/KeySchema.mjs +1 -1
  8. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +18 -3
  9. package/dist/constructs/v1beta2/keychain/KeychainSchema.js +1 -1
  10. package/dist/constructs/v1beta2/keychain/KeychainSchema.mjs +1 -1
  11. package/dist/constructs/v1beta2/view/View.d.ts +12 -2
  12. package/dist/constructs/v1beta2/view/ViewSchema.js +2 -2
  13. package/dist/constructs/v1beta2/view/ViewSchema.mjs +2 -2
  14. package/dist/constructs/v1beta3/academy/Academy.d.ts +10 -0
  15. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  16. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  17. package/dist/constructs/v1beta3/connection/Connection.d.ts +793 -11
  18. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +1 -1
  19. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +1 -1
  20. package/dist/constructs/v1beta3/environment/Environment.d.ts +18 -3
  21. package/dist/constructs/v1beta3/environment/EnvironmentSchema.js +1 -1
  22. package/dist/constructs/v1beta3/environment/EnvironmentSchema.mjs +1 -1
  23. package/dist/constructs/v1beta3/event/Event.d.ts +19 -2
  24. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  25. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  26. package/dist/constructs/v1beta3/token/Token.d.ts +12 -2
  27. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  28. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  29. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +36 -6
  30. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.js +2 -2
  31. package/dist/constructs/v1beta3/workspace/WorkspaceSchema.mjs +2 -2
  32. package/dist/mesheryApi.d.mts +406 -10
  33. package/dist/mesheryApi.d.ts +406 -10
  34. package/dist/mesheryApi.js +1 -1
  35. package/dist/mesheryApi.mjs +1 -1
  36. package/package.json +1 -1
@@ -528,6 +528,268 @@ export interface components {
528
528
  /** @description Number of elements per page */
529
529
  pageSize: number;
530
530
  };
531
+ /** @description Payload for registering (creating) or updating a connection definition. Contains only client-settable fields; server-generated fields such as createdAt, updatedAt, and deletedAt are excluded. */
532
+ ConnectionDefinitionPayload: {
533
+ /**
534
+ * Format: uuid
535
+ * @description Existing connection definition ID for updates; omit on create.
536
+ */
537
+ id?: string;
538
+ /**
539
+ * @description Specifies the version of the schema the definition conforms to.
540
+ * @default connections.meshery.io/v1beta3
541
+ * @example [
542
+ * "v1",
543
+ * "v1alpha1",
544
+ * "v2beta3",
545
+ * "v1.custom-suffix",
546
+ * "models.meshery.io/v1beta1",
547
+ * "capability.meshery.io/v1alpha1"
548
+ * ]
549
+ */
550
+ schemaVersion: string;
551
+ /** @description Connection definition name */
552
+ name: string;
553
+ /** @description Human-readable description of the connection definition and its purpose. */
554
+ description?: string;
555
+ /**
556
+ * Format: uri
557
+ * @description URL of the remote resource connections of this kind point to.
558
+ */
559
+ url?: string;
560
+ /** @description Connection kind (e.g., kubernetes, prometheus, grafana) */
561
+ kind: string;
562
+ /** @description Connection type (platform, telemetry, collaboration) */
563
+ type: string;
564
+ /** @description Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
565
+ subType: string;
566
+ /**
567
+ * @description Connection Status Value
568
+ * @enum {string}
569
+ */
570
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
571
+ /** @description Reference to the registered model that owns this connection definition. */
572
+ modelReference?: {
573
+ /**
574
+ * Format: uuid
575
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
576
+ */
577
+ id: string;
578
+ /**
579
+ * @description The unique name for the model within the scope of a registrant.
580
+ * @example cert-manager
581
+ */
582
+ name: string;
583
+ /** @description Version of the model definition. */
584
+ version: string;
585
+ /**
586
+ * @description Human-readable name for the model.
587
+ * @example Cert Manager
588
+ */
589
+ displayName: string;
590
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
591
+ model: {
592
+ /** @description Version of the model as defined by the registrant. */
593
+ version: string;
594
+ };
595
+ registrant: {
596
+ /** @description Kind of the registrant. */
597
+ kind: string;
598
+ };
599
+ };
600
+ /** @description Kind-specific connection metadata */
601
+ metadata?: Record<string, never>;
602
+ /** @description Schema for the credential associated with connections of this kind. */
603
+ credentialSchema?: Record<string, never>;
604
+ /** @description Schema for connections of this kind. */
605
+ connectionSchema?: Record<string, never>;
606
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
607
+ styles?: ({
608
+ /** @description Primary color of the component used for UI representation. */
609
+ primaryColor: string;
610
+ /** @description Secondary color of the entity used for UI representation. */
611
+ secondaryColor?: string;
612
+ /** @description White SVG of the entity used for UI representation on dark background. */
613
+ svgWhite: string;
614
+ /** @description Colored SVG of the entity used for UI representation on light background. */
615
+ svgColor: string;
616
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
617
+ svgComplete: string;
618
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
619
+ color?: string;
620
+ /** @description The opacity of the label text, including its outline. */
621
+ textOpacity?: number;
622
+ /** @description A comma-separated list of font names to use on the label text. */
623
+ fontFamily?: string;
624
+ /** @description The size of the label text. */
625
+ fontSize?: string;
626
+ /** @description A CSS font style to be applied to the label text. */
627
+ fontStyle?: string;
628
+ /** @description A CSS font weight to be applied to the label text. */
629
+ fontWeight?: string;
630
+ /**
631
+ * @description A transformation to apply to the label text
632
+ * @enum {string}
633
+ */
634
+ textTransform?: "none" | "uppercase" | "lowercase";
635
+ /** @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. */
636
+ opacity?: number;
637
+ /** @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. */
638
+ zIndex?: number;
639
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
640
+ label?: string;
641
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
642
+ animation?: Record<string, never>;
643
+ } & {
644
+ [key: string]: unknown;
645
+ }) & {
646
+ /**
647
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
648
+ * @enum {string}
649
+ */
650
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
651
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
652
+ position?: {
653
+ /** @description The x-coordinate of the node. */
654
+ x: number;
655
+ /** @description The y-coordinate of the node. */
656
+ y: number;
657
+ };
658
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
659
+ bodyText?: string;
660
+ /**
661
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
662
+ * @enum {string}
663
+ */
664
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
665
+ /** @description The maximum width for wrapping text in the node. */
666
+ bodyTextMaxWidth?: string;
667
+ /** @description The opacity of the node's body text, including its outline. */
668
+ bodyTextOpacity?: number;
669
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
670
+ bodyTextBackgroundColor?: string;
671
+ /** @description The size of the node's body text. */
672
+ bodyTextFontSize?: number;
673
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
674
+ bodyTextColor?: string;
675
+ /** @description A CSS font weight to be applied to the node's body text. */
676
+ bodyTextFontWeight?: string;
677
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
678
+ bodyTextHorizontalAlign?: string;
679
+ /** @description A CSS text decoration to be applied to the node's body text. */
680
+ bodyTextDecoration?: string;
681
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
682
+ bodyTextVerticalAlign?: string;
683
+ /** @description The width of the node's body or the width of an edge's line. */
684
+ width?: number;
685
+ /** @description The height of the node's body */
686
+ height?: number;
687
+ /**
688
+ * Format: uri
689
+ * @description The URL that points to the image to show in the node.
690
+ */
691
+ backgroundImage?: string;
692
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
693
+ backgroundColor?: string;
694
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
695
+ backgroundBlacken?: number;
696
+ /** @description The opacity level of the node's background colour */
697
+ backgroundOpacity?: number;
698
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
699
+ backgroundPositionX?: string;
700
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
701
+ backgroundPositionY?: string;
702
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
703
+ backgroundOffsetX?: string;
704
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
705
+ backgroundOffsetY?: string;
706
+ /**
707
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
708
+ * @enum {string}
709
+ */
710
+ backgroundFit?: "none" | "contain" | "cover";
711
+ /**
712
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
713
+ * @enum {string}
714
+ */
715
+ backgroundClip?: "none" | "node" | "node-border";
716
+ /**
717
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
718
+ * @enum {string}
719
+ */
720
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
721
+ /**
722
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
723
+ * @enum {string}
724
+ */
725
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
726
+ /** @description The size of the node's border. */
727
+ borderWidth?: number;
728
+ /**
729
+ * @description The style of the node's border
730
+ * @enum {string}
731
+ */
732
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
733
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
734
+ borderColor?: string;
735
+ /** @description The opacity of the node's border */
736
+ borderOpacity?: number;
737
+ /** @description The amount of padding around all sides of the node. */
738
+ padding?: number;
739
+ /**
740
+ * @description The horizontal alignment of a node's label
741
+ * @enum {string}
742
+ */
743
+ textHalign?: "left" | "center" | "right";
744
+ /**
745
+ * @description The vertical alignment of a node's label
746
+ * @enum {string}
747
+ */
748
+ textValign?: "top" | "center" | "bottom";
749
+ /**
750
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
751
+ * @default no
752
+ * @enum {string}
753
+ */
754
+ ghost: "yes" | "no";
755
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
756
+ activeBgColor?: string;
757
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
758
+ activeBgOpacity?: string;
759
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
760
+ activeBgSize?: string;
761
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
762
+ selectionBoxColor?: string;
763
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
764
+ selectionBoxBorderWidth?: number;
765
+ /** @description The opacity of the selection box. Selector needs to be *core* */
766
+ selectionBoxOpacity?: number;
767
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
768
+ outsideTextureBgColor?: string;
769
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
770
+ outsideTextureBgOpacity?: number;
771
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
772
+ shapePolygonPoints?: string;
773
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
774
+ menuBackgroundColor?: string;
775
+ /** @description The opacity of the background of the component menu. */
776
+ menuBackgroundOpacity?: number;
777
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
778
+ menuForgroundColor?: string;
779
+ };
780
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
781
+ transitionMap?: {
782
+ [key: string]: {
783
+ /**
784
+ * @description Connection Status Value
785
+ * @enum {string}
786
+ */
787
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
788
+ /** @description Human-readable explanation of when or why this transition occurs. */
789
+ description?: string;
790
+ }[];
791
+ };
792
+ };
531
793
  /** @description Represents a page of connections with meta information about connections count */
532
794
  ConnectionPage: {
533
795
  /** @description List of connections on this page */
@@ -3580,16 +3842,276 @@ export interface operations {
3580
3842
  };
3581
3843
  requestBody: {
3582
3844
  content: {
3583
- "application/json": unknown;
3584
- };
3585
- };
3586
- responses: {
3587
- /** @description Connection definition registered */
3588
- 201: {
3589
- headers: {
3590
- [name: string]: unknown;
3591
- };
3592
- content: {
3845
+ "application/json": {
3846
+ /**
3847
+ * Format: uuid
3848
+ * @description Existing connection definition ID for updates; omit on create.
3849
+ */
3850
+ id?: string;
3851
+ /**
3852
+ * @description Specifies the version of the schema the definition conforms to.
3853
+ * @default connections.meshery.io/v1beta3
3854
+ * @example [
3855
+ * "v1",
3856
+ * "v1alpha1",
3857
+ * "v2beta3",
3858
+ * "v1.custom-suffix",
3859
+ * "models.meshery.io/v1beta1",
3860
+ * "capability.meshery.io/v1alpha1"
3861
+ * ]
3862
+ */
3863
+ schemaVersion?: string;
3864
+ /** @description Connection definition name */
3865
+ name: string;
3866
+ /** @description Human-readable description of the connection definition and its purpose. */
3867
+ description?: string;
3868
+ /**
3869
+ * Format: uri
3870
+ * @description URL of the remote resource connections of this kind point to.
3871
+ */
3872
+ url?: string;
3873
+ /** @description Connection kind (e.g., kubernetes, prometheus, grafana) */
3874
+ kind: string;
3875
+ /** @description Connection type (platform, telemetry, collaboration) */
3876
+ type: string;
3877
+ /** @description Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
3878
+ subType: string;
3879
+ /**
3880
+ * @description Connection Status Value
3881
+ * @enum {string}
3882
+ */
3883
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
3884
+ /** @description Reference to the registered model that owns this connection definition. */
3885
+ modelReference?: {
3886
+ /**
3887
+ * Format: uuid
3888
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
3889
+ */
3890
+ id: string;
3891
+ /**
3892
+ * @description The unique name for the model within the scope of a registrant.
3893
+ * @example cert-manager
3894
+ */
3895
+ name: string;
3896
+ /** @description Version of the model definition. */
3897
+ version: string;
3898
+ /**
3899
+ * @description Human-readable name for the model.
3900
+ * @example Cert Manager
3901
+ */
3902
+ displayName: string;
3903
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
3904
+ model: {
3905
+ /** @description Version of the model as defined by the registrant. */
3906
+ version: string;
3907
+ };
3908
+ registrant: {
3909
+ /** @description Kind of the registrant. */
3910
+ kind: string;
3911
+ };
3912
+ };
3913
+ /** @description Kind-specific connection metadata */
3914
+ metadata?: Record<string, never>;
3915
+ /** @description Schema for the credential associated with connections of this kind. */
3916
+ credentialSchema?: Record<string, never>;
3917
+ /** @description Schema for connections of this kind. */
3918
+ connectionSchema?: Record<string, never>;
3919
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
3920
+ styles?: ({
3921
+ /** @description Primary color of the component used for UI representation. */
3922
+ primaryColor: string;
3923
+ /** @description Secondary color of the entity used for UI representation. */
3924
+ secondaryColor?: string;
3925
+ /** @description White SVG of the entity used for UI representation on dark background. */
3926
+ svgWhite: string;
3927
+ /** @description Colored SVG of the entity used for UI representation on light background. */
3928
+ svgColor: string;
3929
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
3930
+ svgComplete: string;
3931
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
3932
+ color?: string;
3933
+ /** @description The opacity of the label text, including its outline. */
3934
+ textOpacity?: number;
3935
+ /** @description A comma-separated list of font names to use on the label text. */
3936
+ fontFamily?: string;
3937
+ /** @description The size of the label text. */
3938
+ fontSize?: string;
3939
+ /** @description A CSS font style to be applied to the label text. */
3940
+ fontStyle?: string;
3941
+ /** @description A CSS font weight to be applied to the label text. */
3942
+ fontWeight?: string;
3943
+ /**
3944
+ * @description A transformation to apply to the label text
3945
+ * @enum {string}
3946
+ */
3947
+ textTransform?: "none" | "uppercase" | "lowercase";
3948
+ /** @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. */
3949
+ opacity?: number;
3950
+ /** @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. */
3951
+ zIndex?: number;
3952
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
3953
+ label?: string;
3954
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
3955
+ animation?: Record<string, never>;
3956
+ } & {
3957
+ [key: string]: unknown;
3958
+ }) & {
3959
+ /**
3960
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
3961
+ * @enum {string}
3962
+ */
3963
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
3964
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
3965
+ position?: {
3966
+ /** @description The x-coordinate of the node. */
3967
+ x: number;
3968
+ /** @description The y-coordinate of the node. */
3969
+ y: number;
3970
+ };
3971
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
3972
+ bodyText?: string;
3973
+ /**
3974
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
3975
+ * @enum {string}
3976
+ */
3977
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
3978
+ /** @description The maximum width for wrapping text in the node. */
3979
+ bodyTextMaxWidth?: string;
3980
+ /** @description The opacity of the node's body text, including its outline. */
3981
+ bodyTextOpacity?: number;
3982
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
3983
+ bodyTextBackgroundColor?: string;
3984
+ /** @description The size of the node's body text. */
3985
+ bodyTextFontSize?: number;
3986
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
3987
+ bodyTextColor?: string;
3988
+ /** @description A CSS font weight to be applied to the node's body text. */
3989
+ bodyTextFontWeight?: string;
3990
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
3991
+ bodyTextHorizontalAlign?: string;
3992
+ /** @description A CSS text decoration to be applied to the node's body text. */
3993
+ bodyTextDecoration?: string;
3994
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
3995
+ bodyTextVerticalAlign?: string;
3996
+ /** @description The width of the node's body or the width of an edge's line. */
3997
+ width?: number;
3998
+ /** @description The height of the node's body */
3999
+ height?: number;
4000
+ /**
4001
+ * Format: uri
4002
+ * @description The URL that points to the image to show in the node.
4003
+ */
4004
+ backgroundImage?: string;
4005
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
4006
+ backgroundColor?: string;
4007
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
4008
+ backgroundBlacken?: number;
4009
+ /** @description The opacity level of the node's background colour */
4010
+ backgroundOpacity?: number;
4011
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4012
+ backgroundPositionX?: string;
4013
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4014
+ backgroundPositionY?: string;
4015
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4016
+ backgroundOffsetX?: string;
4017
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4018
+ backgroundOffsetY?: string;
4019
+ /**
4020
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
4021
+ * @enum {string}
4022
+ */
4023
+ backgroundFit?: "none" | "contain" | "cover";
4024
+ /**
4025
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
4026
+ * @enum {string}
4027
+ */
4028
+ backgroundClip?: "none" | "node" | "node-border";
4029
+ /**
4030
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
4031
+ * @enum {string}
4032
+ */
4033
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
4034
+ /**
4035
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
4036
+ * @enum {string}
4037
+ */
4038
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
4039
+ /** @description The size of the node's border. */
4040
+ borderWidth?: number;
4041
+ /**
4042
+ * @description The style of the node's border
4043
+ * @enum {string}
4044
+ */
4045
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
4046
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
4047
+ borderColor?: string;
4048
+ /** @description The opacity of the node's border */
4049
+ borderOpacity?: number;
4050
+ /** @description The amount of padding around all sides of the node. */
4051
+ padding?: number;
4052
+ /**
4053
+ * @description The horizontal alignment of a node's label
4054
+ * @enum {string}
4055
+ */
4056
+ textHalign?: "left" | "center" | "right";
4057
+ /**
4058
+ * @description The vertical alignment of a node's label
4059
+ * @enum {string}
4060
+ */
4061
+ textValign?: "top" | "center" | "bottom";
4062
+ /**
4063
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
4064
+ * @default no
4065
+ * @enum {string}
4066
+ */
4067
+ ghost?: "yes" | "no";
4068
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4069
+ activeBgColor?: string;
4070
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4071
+ activeBgOpacity?: string;
4072
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4073
+ activeBgSize?: string;
4074
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4075
+ selectionBoxColor?: string;
4076
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
4077
+ selectionBoxBorderWidth?: number;
4078
+ /** @description The opacity of the selection box. Selector needs to be *core* */
4079
+ selectionBoxOpacity?: number;
4080
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4081
+ outsideTextureBgColor?: string;
4082
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
4083
+ outsideTextureBgOpacity?: number;
4084
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
4085
+ shapePolygonPoints?: string;
4086
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4087
+ menuBackgroundColor?: string;
4088
+ /** @description The opacity of the background of the component menu. */
4089
+ menuBackgroundOpacity?: number;
4090
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4091
+ menuForgroundColor?: string;
4092
+ };
4093
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
4094
+ transitionMap?: {
4095
+ [key: string]: {
4096
+ /**
4097
+ * @description Connection Status Value
4098
+ * @enum {string}
4099
+ */
4100
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4101
+ /** @description Human-readable explanation of when or why this transition occurs. */
4102
+ description?: string;
4103
+ }[];
4104
+ };
4105
+ };
4106
+ };
4107
+ };
4108
+ responses: {
4109
+ /** @description Connection definition registered */
4110
+ 201: {
4111
+ headers: {
4112
+ [name: string]: unknown;
4113
+ };
4114
+ content: {
3593
4115
  "application/json": unknown;
3594
4116
  };
3595
4117
  };
@@ -3684,7 +4206,267 @@ export interface operations {
3684
4206
  };
3685
4207
  requestBody: {
3686
4208
  content: {
3687
- "application/json": unknown;
4209
+ "application/json": {
4210
+ /**
4211
+ * Format: uuid
4212
+ * @description Existing connection definition ID for updates; omit on create.
4213
+ */
4214
+ id?: string;
4215
+ /**
4216
+ * @description Specifies the version of the schema the definition conforms to.
4217
+ * @default connections.meshery.io/v1beta3
4218
+ * @example [
4219
+ * "v1",
4220
+ * "v1alpha1",
4221
+ * "v2beta3",
4222
+ * "v1.custom-suffix",
4223
+ * "models.meshery.io/v1beta1",
4224
+ * "capability.meshery.io/v1alpha1"
4225
+ * ]
4226
+ */
4227
+ schemaVersion?: string;
4228
+ /** @description Connection definition name */
4229
+ name: string;
4230
+ /** @description Human-readable description of the connection definition and its purpose. */
4231
+ description?: string;
4232
+ /**
4233
+ * Format: uri
4234
+ * @description URL of the remote resource connections of this kind point to.
4235
+ */
4236
+ url?: string;
4237
+ /** @description Connection kind (e.g., kubernetes, prometheus, grafana) */
4238
+ kind: string;
4239
+ /** @description Connection type (platform, telemetry, collaboration) */
4240
+ type: string;
4241
+ /** @description Connection sub-type (cloud, identity, metrics, chat, git, orchestration) */
4242
+ subType: string;
4243
+ /**
4244
+ * @description Connection Status Value
4245
+ * @enum {string}
4246
+ */
4247
+ status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4248
+ /** @description Reference to the registered model that owns this connection definition. */
4249
+ modelReference?: {
4250
+ /**
4251
+ * Format: uuid
4252
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
4253
+ */
4254
+ id: string;
4255
+ /**
4256
+ * @description The unique name for the model within the scope of a registrant.
4257
+ * @example cert-manager
4258
+ */
4259
+ name: string;
4260
+ /** @description Version of the model definition. */
4261
+ version: string;
4262
+ /**
4263
+ * @description Human-readable name for the model.
4264
+ * @example Cert Manager
4265
+ */
4266
+ displayName: string;
4267
+ /** @description Registrant-defined data associated with the model. Properties pertain to the software being managed (e.g. Kubernetes v1.31). */
4268
+ model: {
4269
+ /** @description Version of the model as defined by the registrant. */
4270
+ version: string;
4271
+ };
4272
+ registrant: {
4273
+ /** @description Kind of the registrant. */
4274
+ kind: string;
4275
+ };
4276
+ };
4277
+ /** @description Kind-specific connection metadata */
4278
+ metadata?: Record<string, never>;
4279
+ /** @description Schema for the credential associated with connections of this kind. */
4280
+ credentialSchema?: Record<string, never>;
4281
+ /** @description Schema for connections of this kind. */
4282
+ connectionSchema?: Record<string, never>;
4283
+ /** @description Visualization styles for the connection, including svgColor and svgWhite used for UI representation. */
4284
+ styles?: ({
4285
+ /** @description Primary color of the component used for UI representation. */
4286
+ primaryColor: string;
4287
+ /** @description Secondary color of the entity used for UI representation. */
4288
+ secondaryColor?: string;
4289
+ /** @description White SVG of the entity used for UI representation on dark background. */
4290
+ svgWhite: string;
4291
+ /** @description Colored SVG of the entity used for UI representation on light background. */
4292
+ svgColor: string;
4293
+ /** @description Complete SVG of the entity used for UI representation, often inclusive of background. */
4294
+ svgComplete: string;
4295
+ /** @description The color of the element's label. Colours may be specified by name (e.g. red), hex (e.g. */
4296
+ color?: string;
4297
+ /** @description The opacity of the label text, including its outline. */
4298
+ textOpacity?: number;
4299
+ /** @description A comma-separated list of font names to use on the label text. */
4300
+ fontFamily?: string;
4301
+ /** @description The size of the label text. */
4302
+ fontSize?: string;
4303
+ /** @description A CSS font style to be applied to the label text. */
4304
+ fontStyle?: string;
4305
+ /** @description A CSS font weight to be applied to the label text. */
4306
+ fontWeight?: string;
4307
+ /**
4308
+ * @description A transformation to apply to the label text
4309
+ * @enum {string}
4310
+ */
4311
+ textTransform?: "none" | "uppercase" | "lowercase";
4312
+ /** @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. */
4313
+ opacity?: number;
4314
+ /** @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. */
4315
+ zIndex?: number;
4316
+ /** @description The text to display for an element's label. Can give a path, e.g. data(id) will label with the elements id */
4317
+ label?: string;
4318
+ /** @description The animation to apply to the element. example ripple,bounce,etc */
4319
+ animation?: Record<string, never>;
4320
+ } & {
4321
+ [key: string]: unknown;
4322
+ }) & {
4323
+ /**
4324
+ * @description The shape of the node's body. Note that each shape fits within the specified width and height, and so you may have to adjust width and height if you desire an equilateral shape (i.e. width !== height for several equilateral shapes)
4325
+ * @enum {string}
4326
+ */
4327
+ shape: "ellipse" | "triangle" | "round-triangle" | "rectangle" | "round-rectangle" | "bottom-round-rectangle" | "cut-rectangle" | "barrel" | "rhomboid" | "diamond" | "round-diamond" | "pentagon" | "round-pentagon" | "hexagon" | "round-hexagon" | "concave-hexagon" | "heptagon" | "round-heptagon" | "octagon" | "round-octagon" | "star" | "tag" | "round-tag" | "vee" | "polygon";
4328
+ /** @description The position of the node. If the position is set, the node is drawn at that position in the given dimensions. If the position is not set, the node is drawn at a random position. */
4329
+ position?: {
4330
+ /** @description The x-coordinate of the node. */
4331
+ x: number;
4332
+ /** @description The y-coordinate of the node. */
4333
+ y: number;
4334
+ };
4335
+ /** @description The text to display for an element's body. Can give a path, e.g. data(id) will label with the elements id */
4336
+ bodyText?: string;
4337
+ /**
4338
+ * @description How to wrap the text in the node. Can be 'none', 'wrap', or 'ellipsis'.
4339
+ * @enum {string}
4340
+ */
4341
+ bodyTextWrap?: "none" | "wrap" | "ellipsis";
4342
+ /** @description The maximum width for wrapping text in the node. */
4343
+ bodyTextMaxWidth?: string;
4344
+ /** @description The opacity of the node's body text, including its outline. */
4345
+ bodyTextOpacity?: number;
4346
+ /** @description The colour of the node's body text background. Colours may be specified by name (e.g. red), hex (e.g. */
4347
+ bodyTextBackgroundColor?: string;
4348
+ /** @description The size of the node's body text. */
4349
+ bodyTextFontSize?: number;
4350
+ /** @description The colour of the node's body text. Colours may be specified by name (e.g. red), hex (e.g. */
4351
+ bodyTextColor?: string;
4352
+ /** @description A CSS font weight to be applied to the node's body text. */
4353
+ bodyTextFontWeight?: string;
4354
+ /** @description A CSS horizontal alignment to be applied to the node's body text. */
4355
+ bodyTextHorizontalAlign?: string;
4356
+ /** @description A CSS text decoration to be applied to the node's body text. */
4357
+ bodyTextDecoration?: string;
4358
+ /** @description A CSS vertical alignment to be applied to the node's body text. */
4359
+ bodyTextVerticalAlign?: string;
4360
+ /** @description The width of the node's body or the width of an edge's line. */
4361
+ width?: number;
4362
+ /** @description The height of the node's body */
4363
+ height?: number;
4364
+ /**
4365
+ * Format: uri
4366
+ * @description The URL that points to the image to show in the node.
4367
+ */
4368
+ backgroundImage?: string;
4369
+ /** @description The colour of the node's body. Colours may be specified by name (e.g. red), hex (e.g. */
4370
+ backgroundColor?: string;
4371
+ /** @description Blackens the node's body for values from 0 to 1; whitens the node's body for values from 0 to -1. */
4372
+ backgroundBlacken?: number;
4373
+ /** @description The opacity level of the node's background colour */
4374
+ backgroundOpacity?: number;
4375
+ /** @description The x position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4376
+ backgroundPositionX?: string;
4377
+ /** @description The y position of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4378
+ backgroundPositionY?: string;
4379
+ /** @description The x offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4380
+ backgroundOffsetX?: string;
4381
+ /** @description The y offset of the background image, measured in percent (e.g. 50%) or pixels (e.g. 10px) */
4382
+ backgroundOffsetY?: string;
4383
+ /**
4384
+ * @description How the background image is fit to the node. Can be 'none', 'contain', or 'cover'.
4385
+ * @enum {string}
4386
+ */
4387
+ backgroundFit?: "none" | "contain" | "cover";
4388
+ /**
4389
+ * @description How the background image is clipped to the node. Can be 'none', 'node', or 'node-border'.
4390
+ * @enum {string}
4391
+ */
4392
+ backgroundClip?: "none" | "node" | "node-border";
4393
+ /**
4394
+ * @description How the background image's width is determined. Can be 'none', 'inner', or 'outer'.
4395
+ * @enum {string}
4396
+ */
4397
+ backgroundWidthRelativeTo?: "none" | "inner" | "outer";
4398
+ /**
4399
+ * @description How the background image's height is determined. Can be 'none', 'inner', or 'outer'.
4400
+ * @enum {string}
4401
+ */
4402
+ backgroundHeightRelativeTo?: "none" | "inner" | "outer";
4403
+ /** @description The size of the node's border. */
4404
+ borderWidth?: number;
4405
+ /**
4406
+ * @description The style of the node's border
4407
+ * @enum {string}
4408
+ */
4409
+ borderStyle?: "solid" | "dotted" | "dashed" | "double";
4410
+ /** @description The colour of the node's border. Colours may be specified by name (e.g. red), hex (e.g. */
4411
+ borderColor?: string;
4412
+ /** @description The opacity of the node's border */
4413
+ borderOpacity?: number;
4414
+ /** @description The amount of padding around all sides of the node. */
4415
+ padding?: number;
4416
+ /**
4417
+ * @description The horizontal alignment of a node's label
4418
+ * @enum {string}
4419
+ */
4420
+ textHalign?: "left" | "center" | "right";
4421
+ /**
4422
+ * @description The vertical alignment of a node's label
4423
+ * @enum {string}
4424
+ */
4425
+ textValign?: "top" | "center" | "bottom";
4426
+ /**
4427
+ * @description Whether to use the ghost effect, a semitransparent duplicate of the element drawn at an offset.
4428
+ * @default no
4429
+ * @enum {string}
4430
+ */
4431
+ ghost?: "yes" | "no";
4432
+ /** @description The colour of the indicator shown when the background is grabbed by the user. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4433
+ activeBgColor?: string;
4434
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4435
+ activeBgOpacity?: string;
4436
+ /** @description The opacity of the active background indicator. Selector needs to be *core*. */
4437
+ activeBgSize?: string;
4438
+ /** @description The background colour of the selection box used for drag selection. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4439
+ selectionBoxColor?: string;
4440
+ /** @description The size of the border on the selection box. Selector needs to be *core* */
4441
+ selectionBoxBorderWidth?: number;
4442
+ /** @description The opacity of the selection box. Selector needs to be *core* */
4443
+ selectionBoxOpacity?: number;
4444
+ /** @description The colour of the area outside the viewport texture when initOptions.textureOnViewport === true. Selector needs to be *core*. Colours may be specified by name (e.g. red), hex (e.g. */
4445
+ outsideTextureBgColor?: string;
4446
+ /** @description The opacity of the area outside the viewport texture. Selector needs to be *core* */
4447
+ outsideTextureBgOpacity?: number;
4448
+ /** @description An array (or a space-separated string) of numbers ranging on [-1, 1], representing alternating x and y values (i.e. x1 y1 x2 y2, x3 y3 ...). This represents the points in the polygon for the node's shape. The bounding box of the node is given by (-1, -1), (1, -1), (1, 1), (-1, 1). The node's position is the origin (0, 0 ) */
4449
+ shapePolygonPoints?: string;
4450
+ /** @description The colour of the background of the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4451
+ menuBackgroundColor?: string;
4452
+ /** @description The opacity of the background of the component menu. */
4453
+ menuBackgroundOpacity?: number;
4454
+ /** @description The colour of the text or icons in the component menu. Colours may be specified by name (e.g. red), hex (e.g. */
4455
+ menuForgroundColor?: string;
4456
+ };
4457
+ /** @description Map describing the connection state machine. Each key is a current connection status and its value is the list of states the connection may transition to from that status. */
4458
+ transitionMap?: {
4459
+ [key: string]: {
4460
+ /**
4461
+ * @description Connection Status Value
4462
+ * @enum {string}
4463
+ */
4464
+ nextState: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
4465
+ /** @description Human-readable explanation of when or why this transition occurs. */
4466
+ description?: string;
4467
+ }[];
4468
+ };
4469
+ };
3688
4470
  };
3689
4471
  };
3690
4472
  responses: {