swaggerhub-cli 0.10.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -61
- package/bin/run +4 -0
- package/oclif.manifest.json +234 -191
- package/package.json +22 -19
- package/src/commands/api/rename.js +69 -0
- package/src/commands/api/validate/download-rules.js +3 -1
- package/src/commands/api/validate/index.js +1 -1
- package/src/commands/spectral/download.js +6 -6
- package/src/commands/spectral/upload.js +8 -8
- package/src/requests/spectral.js +1 -1
- package/src/support/command/handle-response.js +3 -3
- package/src/support/command/parse-input.js +4 -0
- package/src/template-strings/info.js +2 -0
package/oclif.manifest.json
CHANGED
|
@@ -261,6 +261,49 @@
|
|
|
261
261
|
"publish.js"
|
|
262
262
|
]
|
|
263
263
|
},
|
|
264
|
+
"api:rename": {
|
|
265
|
+
"aliases": [],
|
|
266
|
+
"args": {
|
|
267
|
+
"OWNER/API_NAME": {
|
|
268
|
+
"description": "API to be renamed",
|
|
269
|
+
"name": "OWNER/API_NAME",
|
|
270
|
+
"required": true
|
|
271
|
+
},
|
|
272
|
+
"API_NEW_NAME": {
|
|
273
|
+
"description": "New name for the API",
|
|
274
|
+
"name": "API_NEW_NAME",
|
|
275
|
+
"required": true
|
|
276
|
+
}
|
|
277
|
+
},
|
|
278
|
+
"description": "rename an API",
|
|
279
|
+
"examples": [
|
|
280
|
+
"swaggerhub api:rename organization/apiOldName apiNewName"
|
|
281
|
+
],
|
|
282
|
+
"flags": {
|
|
283
|
+
"help": {
|
|
284
|
+
"char": "h",
|
|
285
|
+
"description": "Show CLI help.",
|
|
286
|
+
"name": "help",
|
|
287
|
+
"allowNo": false,
|
|
288
|
+
"type": "boolean"
|
|
289
|
+
}
|
|
290
|
+
},
|
|
291
|
+
"hasDynamicHelp": false,
|
|
292
|
+
"hiddenAliases": [],
|
|
293
|
+
"id": "api:rename",
|
|
294
|
+
"pluginAlias": "swaggerhub-cli",
|
|
295
|
+
"pluginName": "swaggerhub-cli",
|
|
296
|
+
"pluginType": "core",
|
|
297
|
+
"strict": true,
|
|
298
|
+
"enableJsonFlag": false,
|
|
299
|
+
"isESM": false,
|
|
300
|
+
"relativePath": [
|
|
301
|
+
"src",
|
|
302
|
+
"commands",
|
|
303
|
+
"api",
|
|
304
|
+
"rename.js"
|
|
305
|
+
]
|
|
306
|
+
},
|
|
264
307
|
"api:setdefault": {
|
|
265
308
|
"aliases": [],
|
|
266
309
|
"args": {
|
|
@@ -789,29 +832,25 @@
|
|
|
789
832
|
"update.js"
|
|
790
833
|
]
|
|
791
834
|
},
|
|
792
|
-
"
|
|
835
|
+
"spectral:download": {
|
|
793
836
|
"aliases": [],
|
|
794
837
|
"args": {
|
|
795
|
-
"OWNER/
|
|
796
|
-
"description": "
|
|
797
|
-
"name": "OWNER/
|
|
838
|
+
"OWNER/RULESET_NAME": {
|
|
839
|
+
"description": "Organization's Spectral ruleset to create or update on SwaggerHub",
|
|
840
|
+
"name": "OWNER/RULESET_NAME",
|
|
841
|
+
"required": true
|
|
842
|
+
},
|
|
843
|
+
"directory": {
|
|
844
|
+
"description": "Relative path to directory the ruleset files should be saved to",
|
|
845
|
+
"name": "directory",
|
|
798
846
|
"required": true
|
|
799
847
|
}
|
|
800
848
|
},
|
|
801
|
-
"description": "
|
|
849
|
+
"description": "Fetch organization's Spectral ruleset",
|
|
802
850
|
"examples": [
|
|
803
|
-
"swaggerhub
|
|
851
|
+
"swaggerhub spectral:download my_organization/my_api_ruleset rules/"
|
|
804
852
|
],
|
|
805
853
|
"flags": {
|
|
806
|
-
"file": {
|
|
807
|
-
"char": "f",
|
|
808
|
-
"description": "location of integration configuration file",
|
|
809
|
-
"name": "file",
|
|
810
|
-
"required": true,
|
|
811
|
-
"hasDynamicHelp": false,
|
|
812
|
-
"multiple": false,
|
|
813
|
-
"type": "option"
|
|
814
|
-
},
|
|
815
854
|
"help": {
|
|
816
855
|
"char": "h",
|
|
817
856
|
"description": "Show CLI help.",
|
|
@@ -822,7 +861,7 @@
|
|
|
822
861
|
},
|
|
823
862
|
"hasDynamicHelp": false,
|
|
824
863
|
"hiddenAliases": [],
|
|
825
|
-
"id": "
|
|
864
|
+
"id": "spectral:download",
|
|
826
865
|
"pluginAlias": "swaggerhub-cli",
|
|
827
866
|
"pluginName": "swaggerhub-cli",
|
|
828
867
|
"pluginType": "core",
|
|
@@ -832,22 +871,27 @@
|
|
|
832
871
|
"relativePath": [
|
|
833
872
|
"src",
|
|
834
873
|
"commands",
|
|
835
|
-
"
|
|
836
|
-
"
|
|
874
|
+
"spectral",
|
|
875
|
+
"download.js"
|
|
837
876
|
]
|
|
838
877
|
},
|
|
839
|
-
"
|
|
878
|
+
"spectral:upload": {
|
|
840
879
|
"aliases": [],
|
|
841
880
|
"args": {
|
|
842
|
-
"OWNER/
|
|
843
|
-
"description": "
|
|
844
|
-
"name": "OWNER/
|
|
881
|
+
"OWNER/RULESET_NAME": {
|
|
882
|
+
"description": "Organization's Spectral ruleset to create or update on SwaggerHub",
|
|
883
|
+
"name": "OWNER/RULESET_NAME",
|
|
884
|
+
"required": true
|
|
885
|
+
},
|
|
886
|
+
"directory": {
|
|
887
|
+
"description": "Relative path to directory with ruleset files",
|
|
888
|
+
"name": "directory",
|
|
845
889
|
"required": true
|
|
846
890
|
}
|
|
847
891
|
},
|
|
848
|
-
"description": "
|
|
892
|
+
"description": "Create or update organization's Spectral ruleset",
|
|
849
893
|
"examples": [
|
|
850
|
-
"swaggerhub
|
|
894
|
+
"swaggerhub spectral:upload my_organization/my_api_ruleset rules/"
|
|
851
895
|
],
|
|
852
896
|
"flags": {
|
|
853
897
|
"help": {
|
|
@@ -860,7 +904,7 @@
|
|
|
860
904
|
},
|
|
861
905
|
"hasDynamicHelp": false,
|
|
862
906
|
"hiddenAliases": [],
|
|
863
|
-
"id": "
|
|
907
|
+
"id": "spectral:upload",
|
|
864
908
|
"pluginAlias": "swaggerhub-cli",
|
|
865
909
|
"pluginName": "swaggerhub-cli",
|
|
866
910
|
"pluginType": "core",
|
|
@@ -870,24 +914,55 @@
|
|
|
870
914
|
"relativePath": [
|
|
871
915
|
"src",
|
|
872
916
|
"commands",
|
|
873
|
-
"
|
|
874
|
-
"
|
|
917
|
+
"spectral",
|
|
918
|
+
"upload.js"
|
|
875
919
|
]
|
|
876
920
|
},
|
|
877
|
-
"
|
|
921
|
+
"project:create": {
|
|
878
922
|
"aliases": [],
|
|
879
923
|
"args": {
|
|
880
|
-
"OWNER/
|
|
881
|
-
"description": "
|
|
882
|
-
"name": "OWNER/
|
|
924
|
+
"OWNER/PROJECT_NAME": {
|
|
925
|
+
"description": "The new project to create on Swaggerhub",
|
|
926
|
+
"name": "OWNER/PROJECT_NAME",
|
|
883
927
|
"required": true
|
|
884
928
|
}
|
|
885
929
|
},
|
|
886
|
-
"description": "
|
|
930
|
+
"description": "Creates a new project in SwaggerHub.",
|
|
887
931
|
"examples": [
|
|
888
|
-
"swaggerhub
|
|
932
|
+
"swaggerhub project:create organization/new_project_name --description \"project description\"",
|
|
933
|
+
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
934
|
+
"swaggerhub project:create organization/new_project_name --apis \"testapi1,testapi2\"",
|
|
935
|
+
"swaggerhub project:create organization/new_project_name -d \"testdomain3,testdomain4\"",
|
|
936
|
+
"swaggerhub project:create organization/new_project_name --domains \"testdomain3,testdomain4\"",
|
|
937
|
+
"swaggerhub project:create organization/new_project_name -a \"testapi1\" -d \"testdomain3\" --description \"description\""
|
|
889
938
|
],
|
|
890
939
|
"flags": {
|
|
940
|
+
"description": {
|
|
941
|
+
"description": "Description of project",
|
|
942
|
+
"name": "description",
|
|
943
|
+
"required": false,
|
|
944
|
+
"hasDynamicHelp": false,
|
|
945
|
+
"multiple": false,
|
|
946
|
+
"type": "option"
|
|
947
|
+
},
|
|
948
|
+
"apis": {
|
|
949
|
+
"char": "a",
|
|
950
|
+
"description": "Comma separated list of api names to include in project",
|
|
951
|
+
"name": "apis",
|
|
952
|
+
"required": false,
|
|
953
|
+
"hasDynamicHelp": false,
|
|
954
|
+
"multiple": false,
|
|
955
|
+
"type": "option"
|
|
956
|
+
},
|
|
957
|
+
"domains": {
|
|
958
|
+
"char": "d",
|
|
959
|
+
"description": "Comma separated list of domain names to include in project",
|
|
960
|
+
"name": "domains",
|
|
961
|
+
"required": false,
|
|
962
|
+
"hasDynamicHelp": false,
|
|
963
|
+
"multiple": false,
|
|
964
|
+
"type": "option"
|
|
965
|
+
},
|
|
891
966
|
"help": {
|
|
892
967
|
"char": "h",
|
|
893
968
|
"description": "Show CLI help.",
|
|
@@ -898,7 +973,7 @@
|
|
|
898
973
|
},
|
|
899
974
|
"hasDynamicHelp": false,
|
|
900
975
|
"hiddenAliases": [],
|
|
901
|
-
"id": "
|
|
976
|
+
"id": "project:create",
|
|
902
977
|
"pluginAlias": "swaggerhub-cli",
|
|
903
978
|
"pluginName": "swaggerhub-cli",
|
|
904
979
|
"pluginType": "core",
|
|
@@ -908,22 +983,22 @@
|
|
|
908
983
|
"relativePath": [
|
|
909
984
|
"src",
|
|
910
985
|
"commands",
|
|
911
|
-
"
|
|
912
|
-
"
|
|
986
|
+
"project",
|
|
987
|
+
"create.js"
|
|
913
988
|
]
|
|
914
989
|
},
|
|
915
|
-
"
|
|
990
|
+
"project:delete": {
|
|
916
991
|
"aliases": [],
|
|
917
992
|
"args": {
|
|
918
|
-
"OWNER/
|
|
919
|
-
"description": "
|
|
920
|
-
"name": "OWNER/
|
|
993
|
+
"OWNER/PROJECT_NAME": {
|
|
994
|
+
"description": "The project to delete on Swaggerhub",
|
|
995
|
+
"name": "OWNER/PROJECT_NAME",
|
|
921
996
|
"required": true
|
|
922
997
|
}
|
|
923
998
|
},
|
|
924
|
-
"description": "
|
|
999
|
+
"description": "Deletes a project from SwaggerHub.",
|
|
925
1000
|
"examples": [
|
|
926
|
-
"swaggerhub
|
|
1001
|
+
"swaggerhub project:delete organization/project_name"
|
|
927
1002
|
],
|
|
928
1003
|
"flags": {
|
|
929
1004
|
"help": {
|
|
@@ -936,7 +1011,7 @@
|
|
|
936
1011
|
},
|
|
937
1012
|
"hasDynamicHelp": false,
|
|
938
1013
|
"hiddenAliases": [],
|
|
939
|
-
"id": "
|
|
1014
|
+
"id": "project:delete",
|
|
940
1015
|
"pluginAlias": "swaggerhub-cli",
|
|
941
1016
|
"pluginName": "swaggerhub-cli",
|
|
942
1017
|
"pluginType": "core",
|
|
@@ -946,22 +1021,22 @@
|
|
|
946
1021
|
"relativePath": [
|
|
947
1022
|
"src",
|
|
948
1023
|
"commands",
|
|
949
|
-
"
|
|
950
|
-
"
|
|
1024
|
+
"project",
|
|
1025
|
+
"delete.js"
|
|
951
1026
|
]
|
|
952
1027
|
},
|
|
953
|
-
"
|
|
1028
|
+
"project:get": {
|
|
954
1029
|
"aliases": [],
|
|
955
1030
|
"args": {
|
|
956
|
-
"OWNER/
|
|
957
|
-
"description": "
|
|
958
|
-
"name": "OWNER/
|
|
1031
|
+
"OWNER/PROJECT_NAME": {
|
|
1032
|
+
"description": "The project to get details for on Swaggerhub",
|
|
1033
|
+
"name": "OWNER/PROJECT_NAME",
|
|
959
1034
|
"required": true
|
|
960
1035
|
}
|
|
961
1036
|
},
|
|
962
|
-
"description": "
|
|
1037
|
+
"description": "Retrieves the details for a project.",
|
|
963
1038
|
"examples": [
|
|
964
|
-
"swaggerhub
|
|
1039
|
+
"swaggerhub project:get organization/project_name"
|
|
965
1040
|
],
|
|
966
1041
|
"flags": {
|
|
967
1042
|
"help": {
|
|
@@ -974,7 +1049,7 @@
|
|
|
974
1049
|
},
|
|
975
1050
|
"hasDynamicHelp": false,
|
|
976
1051
|
"hiddenAliases": [],
|
|
977
|
-
"id": "
|
|
1052
|
+
"id": "project:get",
|
|
978
1053
|
"pluginAlias": "swaggerhub-cli",
|
|
979
1054
|
"pluginName": "swaggerhub-cli",
|
|
980
1055
|
"pluginType": "core",
|
|
@@ -984,33 +1059,25 @@
|
|
|
984
1059
|
"relativePath": [
|
|
985
1060
|
"src",
|
|
986
1061
|
"commands",
|
|
987
|
-
"
|
|
988
|
-
"
|
|
1062
|
+
"project",
|
|
1063
|
+
"get.js"
|
|
989
1064
|
]
|
|
990
1065
|
},
|
|
991
|
-
"
|
|
1066
|
+
"project:list": {
|
|
992
1067
|
"aliases": [],
|
|
993
1068
|
"args": {
|
|
994
|
-
"OWNER
|
|
995
|
-
"description": "
|
|
996
|
-
"name": "OWNER
|
|
997
|
-
"required":
|
|
1069
|
+
"OWNER": {
|
|
1070
|
+
"description": "The organization to list projects for on Swaggerhub",
|
|
1071
|
+
"name": "OWNER",
|
|
1072
|
+
"required": false
|
|
998
1073
|
}
|
|
999
1074
|
},
|
|
1000
|
-
"description": "
|
|
1075
|
+
"description": "list projects",
|
|
1001
1076
|
"examples": [
|
|
1002
|
-
"swaggerhub
|
|
1077
|
+
"swaggerhub project:list",
|
|
1078
|
+
"swaggerhub project:list organization"
|
|
1003
1079
|
],
|
|
1004
1080
|
"flags": {
|
|
1005
|
-
"file": {
|
|
1006
|
-
"char": "f",
|
|
1007
|
-
"description": "location of integration configuration file",
|
|
1008
|
-
"name": "file",
|
|
1009
|
-
"required": true,
|
|
1010
|
-
"hasDynamicHelp": false,
|
|
1011
|
-
"multiple": false,
|
|
1012
|
-
"type": "option"
|
|
1013
|
-
},
|
|
1014
1081
|
"help": {
|
|
1015
1082
|
"char": "h",
|
|
1016
1083
|
"description": "Show CLI help.",
|
|
@@ -1021,7 +1088,7 @@
|
|
|
1021
1088
|
},
|
|
1022
1089
|
"hasDynamicHelp": false,
|
|
1023
1090
|
"hiddenAliases": [],
|
|
1024
|
-
"id": "
|
|
1091
|
+
"id": "project:list",
|
|
1025
1092
|
"pluginAlias": "swaggerhub-cli",
|
|
1026
1093
|
"pluginName": "swaggerhub-cli",
|
|
1027
1094
|
"pluginType": "core",
|
|
@@ -1031,51 +1098,29 @@
|
|
|
1031
1098
|
"relativePath": [
|
|
1032
1099
|
"src",
|
|
1033
1100
|
"commands",
|
|
1034
|
-
"
|
|
1035
|
-
"
|
|
1101
|
+
"project",
|
|
1102
|
+
"list.js"
|
|
1036
1103
|
]
|
|
1037
1104
|
},
|
|
1038
|
-
"
|
|
1105
|
+
"integration:create": {
|
|
1039
1106
|
"aliases": [],
|
|
1040
1107
|
"args": {
|
|
1041
|
-
"OWNER/
|
|
1042
|
-
"description": "
|
|
1043
|
-
"name": "OWNER/
|
|
1108
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
1109
|
+
"description": "API to add integration to on SwaggerHub",
|
|
1110
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
1044
1111
|
"required": true
|
|
1045
1112
|
}
|
|
1046
1113
|
},
|
|
1047
|
-
"description": "
|
|
1114
|
+
"description": "creates a new API integration from a JSON configuration file.\nSee the documentation for configuration files: https://github.com/SmartBear/swaggerhub-cli/tree/main/examples/integrations\nWhen VERSION is not included in the argument, the integration will be added to be default API version.\n",
|
|
1048
1115
|
"examples": [
|
|
1049
|
-
"swaggerhub
|
|
1050
|
-
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
1051
|
-
"swaggerhub project:create organization/new_project_name --apis \"testapi1,testapi2\"",
|
|
1052
|
-
"swaggerhub project:create organization/new_project_name -d \"testdomain3,testdomain4\"",
|
|
1053
|
-
"swaggerhub project:create organization/new_project_name --domains \"testdomain3,testdomain4\"",
|
|
1054
|
-
"swaggerhub project:create organization/new_project_name -a \"testapi1\" -d \"testdomain3\" --description \"description\""
|
|
1116
|
+
"swaggerhub integration:create organization/api/1.0.0 --file config.json"
|
|
1055
1117
|
],
|
|
1056
1118
|
"flags": {
|
|
1057
|
-
"
|
|
1058
|
-
"
|
|
1059
|
-
"
|
|
1060
|
-
"
|
|
1061
|
-
"
|
|
1062
|
-
"multiple": false,
|
|
1063
|
-
"type": "option"
|
|
1064
|
-
},
|
|
1065
|
-
"apis": {
|
|
1066
|
-
"char": "a",
|
|
1067
|
-
"description": "Comma separated list of api names to include in project",
|
|
1068
|
-
"name": "apis",
|
|
1069
|
-
"required": false,
|
|
1070
|
-
"hasDynamicHelp": false,
|
|
1071
|
-
"multiple": false,
|
|
1072
|
-
"type": "option"
|
|
1073
|
-
},
|
|
1074
|
-
"domains": {
|
|
1075
|
-
"char": "d",
|
|
1076
|
-
"description": "Comma separated list of domain names to include in project",
|
|
1077
|
-
"name": "domains",
|
|
1078
|
-
"required": false,
|
|
1119
|
+
"file": {
|
|
1120
|
+
"char": "f",
|
|
1121
|
+
"description": "location of integration configuration file",
|
|
1122
|
+
"name": "file",
|
|
1123
|
+
"required": true,
|
|
1079
1124
|
"hasDynamicHelp": false,
|
|
1080
1125
|
"multiple": false,
|
|
1081
1126
|
"type": "option"
|
|
@@ -1090,7 +1135,7 @@
|
|
|
1090
1135
|
},
|
|
1091
1136
|
"hasDynamicHelp": false,
|
|
1092
1137
|
"hiddenAliases": [],
|
|
1093
|
-
"id": "
|
|
1138
|
+
"id": "integration:create",
|
|
1094
1139
|
"pluginAlias": "swaggerhub-cli",
|
|
1095
1140
|
"pluginName": "swaggerhub-cli",
|
|
1096
1141
|
"pluginType": "core",
|
|
@@ -1100,22 +1145,22 @@
|
|
|
1100
1145
|
"relativePath": [
|
|
1101
1146
|
"src",
|
|
1102
1147
|
"commands",
|
|
1103
|
-
"
|
|
1148
|
+
"integration",
|
|
1104
1149
|
"create.js"
|
|
1105
1150
|
]
|
|
1106
1151
|
},
|
|
1107
|
-
"
|
|
1152
|
+
"integration:delete": {
|
|
1108
1153
|
"aliases": [],
|
|
1109
1154
|
"args": {
|
|
1110
|
-
"OWNER/
|
|
1111
|
-
"description": "
|
|
1112
|
-
"name": "OWNER/
|
|
1155
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1156
|
+
"description": "Integration to delete for given API on Swaggerhub",
|
|
1157
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1113
1158
|
"required": true
|
|
1114
1159
|
}
|
|
1115
1160
|
},
|
|
1116
|
-
"description": "
|
|
1161
|
+
"description": "deletes the integration from the given API.",
|
|
1117
1162
|
"examples": [
|
|
1118
|
-
"swaggerhub
|
|
1163
|
+
"swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
1119
1164
|
],
|
|
1120
1165
|
"flags": {
|
|
1121
1166
|
"help": {
|
|
@@ -1128,7 +1173,7 @@
|
|
|
1128
1173
|
},
|
|
1129
1174
|
"hasDynamicHelp": false,
|
|
1130
1175
|
"hiddenAliases": [],
|
|
1131
|
-
"id": "
|
|
1176
|
+
"id": "integration:delete",
|
|
1132
1177
|
"pluginAlias": "swaggerhub-cli",
|
|
1133
1178
|
"pluginName": "swaggerhub-cli",
|
|
1134
1179
|
"pluginType": "core",
|
|
@@ -1138,22 +1183,22 @@
|
|
|
1138
1183
|
"relativePath": [
|
|
1139
1184
|
"src",
|
|
1140
1185
|
"commands",
|
|
1141
|
-
"
|
|
1186
|
+
"integration",
|
|
1142
1187
|
"delete.js"
|
|
1143
1188
|
]
|
|
1144
1189
|
},
|
|
1145
|
-
"
|
|
1190
|
+
"integration:execute": {
|
|
1146
1191
|
"aliases": [],
|
|
1147
1192
|
"args": {
|
|
1148
|
-
"OWNER/
|
|
1149
|
-
"description": "
|
|
1150
|
-
"name": "OWNER/
|
|
1193
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1194
|
+
"description": "Integration to execute for given API on Swaggerhub",
|
|
1195
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1151
1196
|
"required": true
|
|
1152
1197
|
}
|
|
1153
1198
|
},
|
|
1154
|
-
"description": "
|
|
1199
|
+
"description": "executes an integration for the given API.",
|
|
1155
1200
|
"examples": [
|
|
1156
|
-
"swaggerhub
|
|
1201
|
+
"swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
1157
1202
|
],
|
|
1158
1203
|
"flags": {
|
|
1159
1204
|
"help": {
|
|
@@ -1166,7 +1211,7 @@
|
|
|
1166
1211
|
},
|
|
1167
1212
|
"hasDynamicHelp": false,
|
|
1168
1213
|
"hiddenAliases": [],
|
|
1169
|
-
"id": "
|
|
1214
|
+
"id": "integration:execute",
|
|
1170
1215
|
"pluginAlias": "swaggerhub-cli",
|
|
1171
1216
|
"pluginName": "swaggerhub-cli",
|
|
1172
1217
|
"pluginType": "core",
|
|
@@ -1176,23 +1221,22 @@
|
|
|
1176
1221
|
"relativePath": [
|
|
1177
1222
|
"src",
|
|
1178
1223
|
"commands",
|
|
1179
|
-
"
|
|
1180
|
-
"
|
|
1224
|
+
"integration",
|
|
1225
|
+
"execute.js"
|
|
1181
1226
|
]
|
|
1182
1227
|
},
|
|
1183
|
-
"
|
|
1228
|
+
"integration:get": {
|
|
1184
1229
|
"aliases": [],
|
|
1185
1230
|
"args": {
|
|
1186
|
-
"OWNER": {
|
|
1187
|
-
"description": "
|
|
1188
|
-
"name": "OWNER",
|
|
1189
|
-
"required":
|
|
1231
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1232
|
+
"description": "Integration to fetch for given API on Swaggerhub",
|
|
1233
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1234
|
+
"required": true
|
|
1190
1235
|
}
|
|
1191
1236
|
},
|
|
1192
|
-
"description": "
|
|
1237
|
+
"description": "retieves an integration for the given API.",
|
|
1193
1238
|
"examples": [
|
|
1194
|
-
"swaggerhub
|
|
1195
|
-
"swaggerhub project:list organization"
|
|
1239
|
+
"swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
1196
1240
|
],
|
|
1197
1241
|
"flags": {
|
|
1198
1242
|
"help": {
|
|
@@ -1205,7 +1249,7 @@
|
|
|
1205
1249
|
},
|
|
1206
1250
|
"hasDynamicHelp": false,
|
|
1207
1251
|
"hiddenAliases": [],
|
|
1208
|
-
"id": "
|
|
1252
|
+
"id": "integration:get",
|
|
1209
1253
|
"pluginAlias": "swaggerhub-cli",
|
|
1210
1254
|
"pluginName": "swaggerhub-cli",
|
|
1211
1255
|
"pluginType": "core",
|
|
@@ -1215,27 +1259,22 @@
|
|
|
1215
1259
|
"relativePath": [
|
|
1216
1260
|
"src",
|
|
1217
1261
|
"commands",
|
|
1218
|
-
"
|
|
1219
|
-
"
|
|
1262
|
+
"integration",
|
|
1263
|
+
"get.js"
|
|
1220
1264
|
]
|
|
1221
1265
|
},
|
|
1222
|
-
"
|
|
1266
|
+
"integration:list": {
|
|
1223
1267
|
"aliases": [],
|
|
1224
1268
|
"args": {
|
|
1225
|
-
"OWNER/
|
|
1226
|
-
"description": "
|
|
1227
|
-
"name": "OWNER/
|
|
1228
|
-
"required": true
|
|
1229
|
-
},
|
|
1230
|
-
"directory": {
|
|
1231
|
-
"description": "Relative path to directory the ruleset files should be saved to",
|
|
1232
|
-
"name": "directory",
|
|
1269
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
1270
|
+
"description": "API to list integrations for on Swaggerhub",
|
|
1271
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
1233
1272
|
"required": true
|
|
1234
1273
|
}
|
|
1235
1274
|
},
|
|
1236
|
-
"description": "
|
|
1275
|
+
"description": "list integrations on an API.",
|
|
1237
1276
|
"examples": [
|
|
1238
|
-
"swaggerhub
|
|
1277
|
+
"swaggerhub integration:list organization/api/1.0.0"
|
|
1239
1278
|
],
|
|
1240
1279
|
"flags": {
|
|
1241
1280
|
"help": {
|
|
@@ -1248,7 +1287,7 @@
|
|
|
1248
1287
|
},
|
|
1249
1288
|
"hasDynamicHelp": false,
|
|
1250
1289
|
"hiddenAliases": [],
|
|
1251
|
-
"id": "
|
|
1290
|
+
"id": "integration:list",
|
|
1252
1291
|
"pluginAlias": "swaggerhub-cli",
|
|
1253
1292
|
"pluginName": "swaggerhub-cli",
|
|
1254
1293
|
"pluginType": "core",
|
|
@@ -1258,29 +1297,33 @@
|
|
|
1258
1297
|
"relativePath": [
|
|
1259
1298
|
"src",
|
|
1260
1299
|
"commands",
|
|
1261
|
-
"
|
|
1262
|
-
"
|
|
1300
|
+
"integration",
|
|
1301
|
+
"list.js"
|
|
1263
1302
|
]
|
|
1264
1303
|
},
|
|
1265
|
-
"
|
|
1304
|
+
"integration:update": {
|
|
1266
1305
|
"aliases": [],
|
|
1267
1306
|
"args": {
|
|
1268
|
-
"OWNER/
|
|
1269
|
-
"description": "
|
|
1270
|
-
"name": "OWNER/
|
|
1271
|
-
"required": true
|
|
1272
|
-
},
|
|
1273
|
-
"directory": {
|
|
1274
|
-
"description": "Relative path to directory with ruleset files",
|
|
1275
|
-
"name": "directory",
|
|
1307
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1308
|
+
"description": "Integration to update for given API on Swaggerhub",
|
|
1309
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1276
1310
|
"required": true
|
|
1277
1311
|
}
|
|
1278
1312
|
},
|
|
1279
|
-
"description": "
|
|
1313
|
+
"description": "update the configuration of an API integration.",
|
|
1280
1314
|
"examples": [
|
|
1281
|
-
"swaggerhub
|
|
1315
|
+
"swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json"
|
|
1282
1316
|
],
|
|
1283
1317
|
"flags": {
|
|
1318
|
+
"file": {
|
|
1319
|
+
"char": "f",
|
|
1320
|
+
"description": "location of integration configuration file",
|
|
1321
|
+
"name": "file",
|
|
1322
|
+
"required": true,
|
|
1323
|
+
"hasDynamicHelp": false,
|
|
1324
|
+
"multiple": false,
|
|
1325
|
+
"type": "option"
|
|
1326
|
+
},
|
|
1284
1327
|
"help": {
|
|
1285
1328
|
"char": "h",
|
|
1286
1329
|
"description": "Show CLI help.",
|
|
@@ -1291,7 +1334,7 @@
|
|
|
1291
1334
|
},
|
|
1292
1335
|
"hasDynamicHelp": false,
|
|
1293
1336
|
"hiddenAliases": [],
|
|
1294
|
-
"id": "
|
|
1337
|
+
"id": "integration:update",
|
|
1295
1338
|
"pluginAlias": "swaggerhub-cli",
|
|
1296
1339
|
"pluginName": "swaggerhub-cli",
|
|
1297
1340
|
"pluginType": "core",
|
|
@@ -1301,8 +1344,8 @@
|
|
|
1301
1344
|
"relativePath": [
|
|
1302
1345
|
"src",
|
|
1303
1346
|
"commands",
|
|
1304
|
-
"
|
|
1305
|
-
"
|
|
1347
|
+
"integration",
|
|
1348
|
+
"update.js"
|
|
1306
1349
|
]
|
|
1307
1350
|
},
|
|
1308
1351
|
"api:validate:download-rules": {
|
|
@@ -1570,23 +1613,18 @@
|
|
|
1570
1613
|
"remove.js"
|
|
1571
1614
|
]
|
|
1572
1615
|
},
|
|
1573
|
-
"project:
|
|
1616
|
+
"project:member:list": {
|
|
1574
1617
|
"aliases": [],
|
|
1575
1618
|
"args": {
|
|
1576
1619
|
"OWNER/PROJECT_NAME": {
|
|
1577
|
-
"description": "
|
|
1620
|
+
"description": "Project to list members of on Swaggerhub",
|
|
1578
1621
|
"name": "OWNER/PROJECT_NAME",
|
|
1579
1622
|
"required": true
|
|
1580
|
-
},
|
|
1581
|
-
"DOMAIN": {
|
|
1582
|
-
"description": "The name of the domain on Swaggerhub to add",
|
|
1583
|
-
"name": "DOMAIN",
|
|
1584
|
-
"required": true
|
|
1585
1623
|
}
|
|
1586
1624
|
},
|
|
1587
|
-
"description": "
|
|
1625
|
+
"description": "list members of a project",
|
|
1588
1626
|
"examples": [
|
|
1589
|
-
"swaggerhub project:
|
|
1627
|
+
"swaggerhub project:member:list organisation/project_name"
|
|
1590
1628
|
],
|
|
1591
1629
|
"flags": {
|
|
1592
1630
|
"help": {
|
|
@@ -1599,7 +1637,7 @@
|
|
|
1599
1637
|
},
|
|
1600
1638
|
"hasDynamicHelp": false,
|
|
1601
1639
|
"hiddenAliases": [],
|
|
1602
|
-
"id": "project:
|
|
1640
|
+
"id": "project:member:list",
|
|
1603
1641
|
"pluginAlias": "swaggerhub-cli",
|
|
1604
1642
|
"pluginName": "swaggerhub-cli",
|
|
1605
1643
|
"pluginType": "core",
|
|
@@ -1610,27 +1648,27 @@
|
|
|
1610
1648
|
"src",
|
|
1611
1649
|
"commands",
|
|
1612
1650
|
"project",
|
|
1613
|
-
"
|
|
1614
|
-
"
|
|
1651
|
+
"member",
|
|
1652
|
+
"list.js"
|
|
1615
1653
|
]
|
|
1616
1654
|
},
|
|
1617
|
-
"project:domain:
|
|
1655
|
+
"project:domain:add": {
|
|
1618
1656
|
"aliases": [],
|
|
1619
1657
|
"args": {
|
|
1620
1658
|
"OWNER/PROJECT_NAME": {
|
|
1621
|
-
"description": "The project to
|
|
1659
|
+
"description": "The project to add the domain to on Swaggerhub",
|
|
1622
1660
|
"name": "OWNER/PROJECT_NAME",
|
|
1623
1661
|
"required": true
|
|
1624
1662
|
},
|
|
1625
1663
|
"DOMAIN": {
|
|
1626
|
-
"description": "The name of the domain on Swaggerhub to
|
|
1664
|
+
"description": "The name of the domain on Swaggerhub to add",
|
|
1627
1665
|
"name": "DOMAIN",
|
|
1628
1666
|
"required": true
|
|
1629
1667
|
}
|
|
1630
1668
|
},
|
|
1631
|
-
"description": "
|
|
1669
|
+
"description": "Adds a domain to an existing project.",
|
|
1632
1670
|
"examples": [
|
|
1633
|
-
"swaggerhub project:domain:
|
|
1671
|
+
"swaggerhub project:domain:add organization/project_name my_domain"
|
|
1634
1672
|
],
|
|
1635
1673
|
"flags": {
|
|
1636
1674
|
"help": {
|
|
@@ -1643,7 +1681,7 @@
|
|
|
1643
1681
|
},
|
|
1644
1682
|
"hasDynamicHelp": false,
|
|
1645
1683
|
"hiddenAliases": [],
|
|
1646
|
-
"id": "project:domain:
|
|
1684
|
+
"id": "project:domain:add",
|
|
1647
1685
|
"pluginAlias": "swaggerhub-cli",
|
|
1648
1686
|
"pluginName": "swaggerhub-cli",
|
|
1649
1687
|
"pluginType": "core",
|
|
@@ -1655,21 +1693,26 @@
|
|
|
1655
1693
|
"commands",
|
|
1656
1694
|
"project",
|
|
1657
1695
|
"domain",
|
|
1658
|
-
"
|
|
1696
|
+
"add.js"
|
|
1659
1697
|
]
|
|
1660
1698
|
},
|
|
1661
|
-
"project:
|
|
1699
|
+
"project:domain:remove": {
|
|
1662
1700
|
"aliases": [],
|
|
1663
1701
|
"args": {
|
|
1664
1702
|
"OWNER/PROJECT_NAME": {
|
|
1665
|
-
"description": "
|
|
1703
|
+
"description": "The project to remove the domain from on Swaggerhub",
|
|
1666
1704
|
"name": "OWNER/PROJECT_NAME",
|
|
1667
1705
|
"required": true
|
|
1706
|
+
},
|
|
1707
|
+
"DOMAIN": {
|
|
1708
|
+
"description": "The name of the domain on Swaggerhub to remove",
|
|
1709
|
+
"name": "DOMAIN",
|
|
1710
|
+
"required": true
|
|
1668
1711
|
}
|
|
1669
1712
|
},
|
|
1670
|
-
"description": "
|
|
1713
|
+
"description": "Removes a domain from a project in SwaggerHub.",
|
|
1671
1714
|
"examples": [
|
|
1672
|
-
"swaggerhub project:
|
|
1715
|
+
"swaggerhub project:domain:remove organization/project_name my_domain"
|
|
1673
1716
|
],
|
|
1674
1717
|
"flags": {
|
|
1675
1718
|
"help": {
|
|
@@ -1682,7 +1725,7 @@
|
|
|
1682
1725
|
},
|
|
1683
1726
|
"hasDynamicHelp": false,
|
|
1684
1727
|
"hiddenAliases": [],
|
|
1685
|
-
"id": "project:
|
|
1728
|
+
"id": "project:domain:remove",
|
|
1686
1729
|
"pluginAlias": "swaggerhub-cli",
|
|
1687
1730
|
"pluginName": "swaggerhub-cli",
|
|
1688
1731
|
"pluginType": "core",
|
|
@@ -1693,10 +1736,10 @@
|
|
|
1693
1736
|
"src",
|
|
1694
1737
|
"commands",
|
|
1695
1738
|
"project",
|
|
1696
|
-
"
|
|
1697
|
-
"
|
|
1739
|
+
"domain",
|
|
1740
|
+
"remove.js"
|
|
1698
1741
|
]
|
|
1699
1742
|
}
|
|
1700
1743
|
},
|
|
1701
|
-
"version": "0.
|
|
1744
|
+
"version": "0.12.0"
|
|
1702
1745
|
}
|