@meshery/schemas 0.8.113 → 0.8.115
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.
- package/dist/cloudApi.d.mts +1065 -1821
- package/dist/cloudApi.d.ts +1065 -1821
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta1/connection/Connection.d.mts +13 -333
- package/dist/constructs/v1beta1/connection/Connection.d.ts +13 -333
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.mts +108 -1139
- package/dist/constructs/v1beta1/connection/ConnectionSchema.d.ts +108 -1139
- package/dist/constructs/v1beta1/connection/ConnectionSchema.js +1 -1
- package/dist/constructs/v1beta1/connection/ConnectionSchema.mjs +1 -1
- package/dist/mesheryApi.d.mts +46 -46
- package/dist/mesheryApi.d.ts +46 -46
- package/package.json +1 -1
|
@@ -4,28 +4,14 @@
|
|
|
4
4
|
*/
|
|
5
5
|
interface paths {
|
|
6
6
|
"/api/integrations/connections": {
|
|
7
|
-
/** Returns a paginated list of connections for the authenticated user */
|
|
7
|
+
/** Returns a paginated list of connections for the authenticated user with filtering, sorting and pagination support */
|
|
8
8
|
get: operations["GetConnections"];
|
|
9
9
|
/** Register a new connection with credentials */
|
|
10
10
|
post: operations["RegisterConnection"];
|
|
11
11
|
};
|
|
12
|
-
"/api/integrations/connections/{connectionKind}": {
|
|
13
|
-
/** Returns connections filtered by kind (meshery, kubernetes, etc.) */
|
|
14
|
-
get: operations["GetConnectionsByKind"];
|
|
15
|
-
};
|
|
16
|
-
"/api/integrations/connections/status": {
|
|
17
|
-
/** Returns aggregated status information for all connections */
|
|
18
|
-
get: operations["GetConnectionsStatus"];
|
|
19
|
-
};
|
|
20
|
-
"/api/integrations/connections/status/{connectionId}": {
|
|
21
|
-
/** Update the status of a specific connection */
|
|
22
|
-
put: operations["UpdateConnectionStatusByID"];
|
|
23
|
-
};
|
|
24
|
-
"/api/integrations/connections/{connectionKind}/{connectionId}": {
|
|
25
|
-
/** Returns a specific connection by kind and ID */
|
|
26
|
-
get: operations["GetConnectionByID"];
|
|
27
|
-
};
|
|
28
12
|
"/api/integrations/connections/{connectionId}": {
|
|
13
|
+
/** Returns a specific connection by its ID */
|
|
14
|
+
get: operations["GetConnectionById"];
|
|
29
15
|
/** Update an existing connection */
|
|
30
16
|
put: operations["UpdateConnection"];
|
|
31
17
|
/** Delete a specific connection */
|
|
@@ -359,7 +345,7 @@ interface components {
|
|
|
359
345
|
};
|
|
360
346
|
}
|
|
361
347
|
interface operations {
|
|
362
|
-
/** Returns a paginated list of connections for the authenticated user */
|
|
348
|
+
/** Returns a paginated list of connections for the authenticated user with filtering, sorting and pagination support */
|
|
363
349
|
GetConnections: {
|
|
364
350
|
parameters: {
|
|
365
351
|
query: {
|
|
@@ -371,16 +357,20 @@ interface operations {
|
|
|
371
357
|
search?: string;
|
|
372
358
|
/** Sort order */
|
|
373
359
|
order?: string;
|
|
374
|
-
/** Filter connections */
|
|
360
|
+
/** Filter connections (general filter string) */
|
|
375
361
|
filter?: string;
|
|
376
|
-
/** Filter by connection kind */
|
|
362
|
+
/** Filter by connection kind (e.g., kubernetes, prometheus, grafana) */
|
|
377
363
|
kind?: string[];
|
|
378
364
|
/** Filter by connection status */
|
|
379
365
|
status?: ("discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found")[];
|
|
366
|
+
/** Filter by connection type */
|
|
367
|
+
type?: string[];
|
|
368
|
+
/** Filter by connection name (partial match supported) */
|
|
369
|
+
name?: string;
|
|
380
370
|
};
|
|
381
371
|
};
|
|
382
372
|
responses: {
|
|
383
|
-
/**
|
|
373
|
+
/** Paginated list of connections with summary information */
|
|
384
374
|
200: {
|
|
385
375
|
content: {
|
|
386
376
|
"application/json": {
|
|
@@ -610,320 +600,10 @@ interface operations {
|
|
|
610
600
|
};
|
|
611
601
|
};
|
|
612
602
|
};
|
|
613
|
-
/** Returns
|
|
614
|
-
|
|
615
|
-
parameters: {
|
|
616
|
-
path: {
|
|
617
|
-
/** Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
618
|
-
connectionKind: string;
|
|
619
|
-
};
|
|
620
|
-
query: {
|
|
621
|
-
/** Page number */
|
|
622
|
-
page?: number;
|
|
623
|
-
/** Number of items per page */
|
|
624
|
-
pagesize?: number;
|
|
625
|
-
/** Search term */
|
|
626
|
-
search?: string;
|
|
627
|
-
/** Sort order */
|
|
628
|
-
order?: string;
|
|
629
|
-
/** Filter by connection status */
|
|
630
|
-
status?: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
631
|
-
/** Filter by Meshery instance ID (for kubernetes connections) */
|
|
632
|
-
meshery_instance_id?: string;
|
|
633
|
-
/** Include credentials in response (for kubernetes connections) */
|
|
634
|
-
with_credentials?: boolean;
|
|
635
|
-
};
|
|
636
|
-
};
|
|
637
|
-
responses: {
|
|
638
|
-
/** List of connections by kind */
|
|
639
|
-
200: {
|
|
640
|
-
content: {
|
|
641
|
-
"application/json": {
|
|
642
|
-
/** @description List of connections on this page */
|
|
643
|
-
connections: {
|
|
644
|
-
/**
|
|
645
|
-
* Format: uuid
|
|
646
|
-
* @description Connection ID
|
|
647
|
-
*/
|
|
648
|
-
id: string;
|
|
649
|
-
/** @description Connection Name */
|
|
650
|
-
name: string;
|
|
651
|
-
/**
|
|
652
|
-
* Format: uuid
|
|
653
|
-
* @description Associated Credential ID
|
|
654
|
-
*/
|
|
655
|
-
credential_id?: string;
|
|
656
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
657
|
-
type: string;
|
|
658
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
659
|
-
sub_type: string;
|
|
660
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
661
|
-
kind: string;
|
|
662
|
-
/** @description Additional connection metadata */
|
|
663
|
-
metadata?: {
|
|
664
|
-
[key: string]: unknown;
|
|
665
|
-
};
|
|
666
|
-
/**
|
|
667
|
-
* @description Connection Status
|
|
668
|
-
* @enum {string}
|
|
669
|
-
*/
|
|
670
|
-
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
671
|
-
/**
|
|
672
|
-
* Format: uuid
|
|
673
|
-
* @description User ID who owns this connection
|
|
674
|
-
*/
|
|
675
|
-
user_id?: string;
|
|
676
|
-
/** Format: date-time */
|
|
677
|
-
created_at?: string;
|
|
678
|
-
/** Format: date-time */
|
|
679
|
-
updated_at?: string;
|
|
680
|
-
/** Format: date-time */
|
|
681
|
-
deleted_at?: string;
|
|
682
|
-
/** @description Associated environments for this connection */
|
|
683
|
-
environments?: {
|
|
684
|
-
/**
|
|
685
|
-
* Format: uuid
|
|
686
|
-
* @description ID
|
|
687
|
-
*/
|
|
688
|
-
id: string;
|
|
689
|
-
/** @description Environment name */
|
|
690
|
-
name: string;
|
|
691
|
-
/** @description Environment description */
|
|
692
|
-
description: string;
|
|
693
|
-
/**
|
|
694
|
-
* Format: uuid
|
|
695
|
-
* @description Environment organization ID
|
|
696
|
-
*/
|
|
697
|
-
organization_id: string;
|
|
698
|
-
/**
|
|
699
|
-
* Format: uuid
|
|
700
|
-
* @description Environment owner
|
|
701
|
-
*/
|
|
702
|
-
owner?: string;
|
|
703
|
-
/** Format: date-time */
|
|
704
|
-
created_at?: string;
|
|
705
|
-
metadata?: {
|
|
706
|
-
[key: string]: unknown;
|
|
707
|
-
};
|
|
708
|
-
/** Format: date-time */
|
|
709
|
-
updated_at?: string;
|
|
710
|
-
/** Format: date-time */
|
|
711
|
-
deleted_at?: string;
|
|
712
|
-
}[];
|
|
713
|
-
/**
|
|
714
|
-
* @description Specifies the version of the schema used for the definition.
|
|
715
|
-
* @default connections.meshery.io/v1beta1
|
|
716
|
-
* @example [
|
|
717
|
-
* "v1",
|
|
718
|
-
* "v1alpha1",
|
|
719
|
-
* "v2beta3",
|
|
720
|
-
* "v1.custom-suffix"
|
|
721
|
-
* ]
|
|
722
|
-
*/
|
|
723
|
-
schemaVersion: string;
|
|
724
|
-
}[];
|
|
725
|
-
/** @description Total number of connections on all pages */
|
|
726
|
-
total_count: number;
|
|
727
|
-
/** @description Current page number */
|
|
728
|
-
page: number;
|
|
729
|
-
/** @description Number of elements per page */
|
|
730
|
-
page_size: number;
|
|
731
|
-
} | {
|
|
732
|
-
/** @description List of Meshery instances */
|
|
733
|
-
meshery_instances: {
|
|
734
|
-
/** @description Instance ID */
|
|
735
|
-
id?: string;
|
|
736
|
-
/** @description Instance name */
|
|
737
|
-
name?: string;
|
|
738
|
-
/** @description Server ID */
|
|
739
|
-
server_id?: string;
|
|
740
|
-
/** @description Meshery server version */
|
|
741
|
-
server_version?: string;
|
|
742
|
-
/** @description Server location URL */
|
|
743
|
-
server_location?: string;
|
|
744
|
-
/** @description Server build SHA */
|
|
745
|
-
server_build_sha?: string;
|
|
746
|
-
/** @description Creation timestamp */
|
|
747
|
-
created_at?: string;
|
|
748
|
-
/** @description Last update timestamp */
|
|
749
|
-
updated_at?: string;
|
|
750
|
-
/** @description Deletion timestamp */
|
|
751
|
-
deleted_at?: string;
|
|
752
|
-
}[];
|
|
753
|
-
/** @description Current page number */
|
|
754
|
-
page: number;
|
|
755
|
-
/** @description Number of items per page */
|
|
756
|
-
page_size: number;
|
|
757
|
-
/** @description Total number of instances */
|
|
758
|
-
total_count: number;
|
|
759
|
-
};
|
|
760
|
-
};
|
|
761
|
-
};
|
|
762
|
-
/** Server error */
|
|
763
|
-
500: unknown;
|
|
764
|
-
};
|
|
765
|
-
};
|
|
766
|
-
/** Returns aggregated status information for all connections */
|
|
767
|
-
GetConnectionsStatus: {
|
|
768
|
-
parameters: {
|
|
769
|
-
query: {
|
|
770
|
-
/** Page number */
|
|
771
|
-
page?: number;
|
|
772
|
-
/** Number of items per page */
|
|
773
|
-
pagesize?: number;
|
|
774
|
-
/** Search term */
|
|
775
|
-
search?: string;
|
|
776
|
-
/** Sort order */
|
|
777
|
-
order?: string;
|
|
778
|
-
};
|
|
779
|
-
};
|
|
780
|
-
responses: {
|
|
781
|
-
/** Connection status summary */
|
|
782
|
-
200: {
|
|
783
|
-
content: {
|
|
784
|
-
"application/json": {
|
|
785
|
-
/** @description Total number of status entries */
|
|
786
|
-
total_count: number;
|
|
787
|
-
/** @description Current page number */
|
|
788
|
-
page: number;
|
|
789
|
-
/** @description Number of items per page */
|
|
790
|
-
page_size: number;
|
|
791
|
-
/** @description List of status counts */
|
|
792
|
-
connections_status: {
|
|
793
|
-
/** @description Status value */
|
|
794
|
-
status: string;
|
|
795
|
-
/** @description Number of connections with this status */
|
|
796
|
-
count: number;
|
|
797
|
-
}[];
|
|
798
|
-
};
|
|
799
|
-
};
|
|
800
|
-
};
|
|
801
|
-
/** Server error */
|
|
802
|
-
500: unknown;
|
|
803
|
-
};
|
|
804
|
-
};
|
|
805
|
-
/** Update the status of a specific connection */
|
|
806
|
-
UpdateConnectionStatusByID: {
|
|
807
|
-
parameters: {
|
|
808
|
-
path: {
|
|
809
|
-
/** Connection ID */
|
|
810
|
-
connectionId: string;
|
|
811
|
-
};
|
|
812
|
-
};
|
|
813
|
-
responses: {
|
|
814
|
-
/** Connection status updated successfully */
|
|
815
|
-
200: {
|
|
816
|
-
content: {
|
|
817
|
-
"application/json": {
|
|
818
|
-
/** @description List of connections on this page */
|
|
819
|
-
connections: {
|
|
820
|
-
/**
|
|
821
|
-
* Format: uuid
|
|
822
|
-
* @description Connection ID
|
|
823
|
-
*/
|
|
824
|
-
id: string;
|
|
825
|
-
/** @description Connection Name */
|
|
826
|
-
name: string;
|
|
827
|
-
/**
|
|
828
|
-
* Format: uuid
|
|
829
|
-
* @description Associated Credential ID
|
|
830
|
-
*/
|
|
831
|
-
credential_id?: string;
|
|
832
|
-
/** @description Connection Type (platform, telemetry, collaboration) */
|
|
833
|
-
type: string;
|
|
834
|
-
/** @description Connection Subtype (cloud, identity, metrics, chat, git, orchestration) */
|
|
835
|
-
sub_type: string;
|
|
836
|
-
/** @description Connection Kind (meshery, kubernetes, prometheus, grafana, gke, aws, azure, slack, github) */
|
|
837
|
-
kind: string;
|
|
838
|
-
/** @description Additional connection metadata */
|
|
839
|
-
metadata?: {
|
|
840
|
-
[key: string]: unknown;
|
|
841
|
-
};
|
|
842
|
-
/**
|
|
843
|
-
* @description Connection Status
|
|
844
|
-
* @enum {string}
|
|
845
|
-
*/
|
|
846
|
-
status: "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
847
|
-
/**
|
|
848
|
-
* Format: uuid
|
|
849
|
-
* @description User ID who owns this connection
|
|
850
|
-
*/
|
|
851
|
-
user_id?: string;
|
|
852
|
-
/** Format: date-time */
|
|
853
|
-
created_at?: string;
|
|
854
|
-
/** Format: date-time */
|
|
855
|
-
updated_at?: string;
|
|
856
|
-
/** Format: date-time */
|
|
857
|
-
deleted_at?: string;
|
|
858
|
-
/** @description Associated environments for this connection */
|
|
859
|
-
environments?: {
|
|
860
|
-
/**
|
|
861
|
-
* Format: uuid
|
|
862
|
-
* @description ID
|
|
863
|
-
*/
|
|
864
|
-
id: string;
|
|
865
|
-
/** @description Environment name */
|
|
866
|
-
name: string;
|
|
867
|
-
/** @description Environment description */
|
|
868
|
-
description: string;
|
|
869
|
-
/**
|
|
870
|
-
* Format: uuid
|
|
871
|
-
* @description Environment organization ID
|
|
872
|
-
*/
|
|
873
|
-
organization_id: string;
|
|
874
|
-
/**
|
|
875
|
-
* Format: uuid
|
|
876
|
-
* @description Environment owner
|
|
877
|
-
*/
|
|
878
|
-
owner?: string;
|
|
879
|
-
/** Format: date-time */
|
|
880
|
-
created_at?: string;
|
|
881
|
-
metadata?: {
|
|
882
|
-
[key: string]: unknown;
|
|
883
|
-
};
|
|
884
|
-
/** Format: date-time */
|
|
885
|
-
updated_at?: string;
|
|
886
|
-
/** Format: date-time */
|
|
887
|
-
deleted_at?: string;
|
|
888
|
-
}[];
|
|
889
|
-
/**
|
|
890
|
-
* @description Specifies the version of the schema used for the definition.
|
|
891
|
-
* @default connections.meshery.io/v1beta1
|
|
892
|
-
* @example [
|
|
893
|
-
* "v1",
|
|
894
|
-
* "v1alpha1",
|
|
895
|
-
* "v2beta3",
|
|
896
|
-
* "v1.custom-suffix"
|
|
897
|
-
* ]
|
|
898
|
-
*/
|
|
899
|
-
schemaVersion: string;
|
|
900
|
-
}[];
|
|
901
|
-
/** @description Total number of connections on all pages */
|
|
902
|
-
total_count: number;
|
|
903
|
-
/** @description Current page number */
|
|
904
|
-
page: number;
|
|
905
|
-
/** @description Number of elements per page */
|
|
906
|
-
page_size: number;
|
|
907
|
-
};
|
|
908
|
-
};
|
|
909
|
-
};
|
|
910
|
-
/** Connection not found */
|
|
911
|
-
404: unknown;
|
|
912
|
-
/** Server error */
|
|
913
|
-
500: unknown;
|
|
914
|
-
};
|
|
915
|
-
requestBody: {
|
|
916
|
-
content: {
|
|
917
|
-
"text/plain": "discovered" | "registered" | "connected" | "ignored" | "maintenance" | "disconnected" | "deleted" | "not found";
|
|
918
|
-
};
|
|
919
|
-
};
|
|
920
|
-
};
|
|
921
|
-
/** Returns a specific connection by kind and ID */
|
|
922
|
-
GetConnectionByID: {
|
|
603
|
+
/** Returns a specific connection by its ID */
|
|
604
|
+
GetConnectionById: {
|
|
923
605
|
parameters: {
|
|
924
606
|
path: {
|
|
925
|
-
/** Connection kind (meshery, kubernetes, prometheus, grafana, etc.) */
|
|
926
|
-
connectionKind: string;
|
|
927
607
|
/** Connection ID */
|
|
928
608
|
connectionId: string;
|
|
929
609
|
};
|