swaggerhub-cli 0.12.0 → 0.13.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 +67 -41
- package/oclif.manifest.json +249 -213
- package/package.json +7 -4
- package/src/commands/domain/publish.js +12 -5
- package/src/commands/project/list.js +26 -7
- package/src/support/command/update-command.js +20 -4
- package/src/support/http/index.js +2 -1
- package/src/support/http/proxy-agent.js +25 -0
package/oclif.manifest.json
CHANGED
|
@@ -651,9 +651,17 @@
|
|
|
651
651
|
},
|
|
652
652
|
"description": "publish a domain version",
|
|
653
653
|
"examples": [
|
|
654
|
-
"swaggerhub domain:publish organization/domain/1.0.0"
|
|
654
|
+
"swaggerhub domain:publish organization/domain/1.0.0",
|
|
655
|
+
"swaggerhub domain:publish organization/domain/1.0.0 --force"
|
|
655
656
|
],
|
|
656
657
|
"flags": {
|
|
658
|
+
"force": {
|
|
659
|
+
"char": "f",
|
|
660
|
+
"description": "publish domain without prompting for confirmation",
|
|
661
|
+
"name": "force",
|
|
662
|
+
"allowNo": false,
|
|
663
|
+
"type": "boolean"
|
|
664
|
+
},
|
|
657
665
|
"help": {
|
|
658
666
|
"char": "h",
|
|
659
667
|
"description": "Show CLI help.",
|
|
@@ -832,25 +840,29 @@
|
|
|
832
840
|
"update.js"
|
|
833
841
|
]
|
|
834
842
|
},
|
|
835
|
-
"
|
|
843
|
+
"integration:create": {
|
|
836
844
|
"aliases": [],
|
|
837
845
|
"args": {
|
|
838
|
-
"OWNER/
|
|
839
|
-
"description": "
|
|
840
|
-
"name": "OWNER/
|
|
841
|
-
"required": true
|
|
842
|
-
},
|
|
843
|
-
"directory": {
|
|
844
|
-
"description": "Relative path to directory the ruleset files should be saved to",
|
|
845
|
-
"name": "directory",
|
|
846
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
847
|
+
"description": "API to add integration to on SwaggerHub",
|
|
848
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
846
849
|
"required": true
|
|
847
850
|
}
|
|
848
851
|
},
|
|
849
|
-
"description": "
|
|
852
|
+
"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",
|
|
850
853
|
"examples": [
|
|
851
|
-
"swaggerhub
|
|
854
|
+
"swaggerhub integration:create organization/api/1.0.0 --file config.json"
|
|
852
855
|
],
|
|
853
856
|
"flags": {
|
|
857
|
+
"file": {
|
|
858
|
+
"char": "f",
|
|
859
|
+
"description": "location of integration configuration file",
|
|
860
|
+
"name": "file",
|
|
861
|
+
"required": true,
|
|
862
|
+
"hasDynamicHelp": false,
|
|
863
|
+
"multiple": false,
|
|
864
|
+
"type": "option"
|
|
865
|
+
},
|
|
854
866
|
"help": {
|
|
855
867
|
"char": "h",
|
|
856
868
|
"description": "Show CLI help.",
|
|
@@ -861,7 +873,7 @@
|
|
|
861
873
|
},
|
|
862
874
|
"hasDynamicHelp": false,
|
|
863
875
|
"hiddenAliases": [],
|
|
864
|
-
"id": "
|
|
876
|
+
"id": "integration:create",
|
|
865
877
|
"pluginAlias": "swaggerhub-cli",
|
|
866
878
|
"pluginName": "swaggerhub-cli",
|
|
867
879
|
"pluginType": "core",
|
|
@@ -871,27 +883,22 @@
|
|
|
871
883
|
"relativePath": [
|
|
872
884
|
"src",
|
|
873
885
|
"commands",
|
|
874
|
-
"
|
|
875
|
-
"
|
|
886
|
+
"integration",
|
|
887
|
+
"create.js"
|
|
876
888
|
]
|
|
877
889
|
},
|
|
878
|
-
"
|
|
890
|
+
"integration:delete": {
|
|
879
891
|
"aliases": [],
|
|
880
892
|
"args": {
|
|
881
|
-
"OWNER/
|
|
882
|
-
"description": "
|
|
883
|
-
"name": "OWNER/
|
|
884
|
-
"required": true
|
|
885
|
-
},
|
|
886
|
-
"directory": {
|
|
887
|
-
"description": "Relative path to directory with ruleset files",
|
|
888
|
-
"name": "directory",
|
|
893
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
894
|
+
"description": "Integration to delete for given API on Swaggerhub",
|
|
895
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
889
896
|
"required": true
|
|
890
897
|
}
|
|
891
898
|
},
|
|
892
|
-
"description": "
|
|
899
|
+
"description": "deletes the integration from the given API.",
|
|
893
900
|
"examples": [
|
|
894
|
-
"swaggerhub
|
|
901
|
+
"swaggerhub integration:delete organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
895
902
|
],
|
|
896
903
|
"flags": {
|
|
897
904
|
"help": {
|
|
@@ -904,7 +911,7 @@
|
|
|
904
911
|
},
|
|
905
912
|
"hasDynamicHelp": false,
|
|
906
913
|
"hiddenAliases": [],
|
|
907
|
-
"id": "
|
|
914
|
+
"id": "integration:delete",
|
|
908
915
|
"pluginAlias": "swaggerhub-cli",
|
|
909
916
|
"pluginName": "swaggerhub-cli",
|
|
910
917
|
"pluginType": "core",
|
|
@@ -914,55 +921,24 @@
|
|
|
914
921
|
"relativePath": [
|
|
915
922
|
"src",
|
|
916
923
|
"commands",
|
|
917
|
-
"
|
|
918
|
-
"
|
|
924
|
+
"integration",
|
|
925
|
+
"delete.js"
|
|
919
926
|
]
|
|
920
927
|
},
|
|
921
|
-
"
|
|
928
|
+
"integration:execute": {
|
|
922
929
|
"aliases": [],
|
|
923
930
|
"args": {
|
|
924
|
-
"OWNER/
|
|
925
|
-
"description": "
|
|
926
|
-
"name": "OWNER/
|
|
931
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
932
|
+
"description": "Integration to execute for given API on Swaggerhub",
|
|
933
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
927
934
|
"required": true
|
|
928
935
|
}
|
|
929
936
|
},
|
|
930
|
-
"description": "
|
|
937
|
+
"description": "executes an integration for the given API.",
|
|
931
938
|
"examples": [
|
|
932
|
-
"swaggerhub
|
|
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\""
|
|
939
|
+
"swaggerhub integration:execute organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
938
940
|
],
|
|
939
941
|
"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
|
-
},
|
|
966
942
|
"help": {
|
|
967
943
|
"char": "h",
|
|
968
944
|
"description": "Show CLI help.",
|
|
@@ -973,7 +949,7 @@
|
|
|
973
949
|
},
|
|
974
950
|
"hasDynamicHelp": false,
|
|
975
951
|
"hiddenAliases": [],
|
|
976
|
-
"id": "
|
|
952
|
+
"id": "integration:execute",
|
|
977
953
|
"pluginAlias": "swaggerhub-cli",
|
|
978
954
|
"pluginName": "swaggerhub-cli",
|
|
979
955
|
"pluginType": "core",
|
|
@@ -983,22 +959,22 @@
|
|
|
983
959
|
"relativePath": [
|
|
984
960
|
"src",
|
|
985
961
|
"commands",
|
|
986
|
-
"
|
|
987
|
-
"
|
|
962
|
+
"integration",
|
|
963
|
+
"execute.js"
|
|
988
964
|
]
|
|
989
965
|
},
|
|
990
|
-
"
|
|
966
|
+
"integration:get": {
|
|
991
967
|
"aliases": [],
|
|
992
968
|
"args": {
|
|
993
|
-
"OWNER/
|
|
994
|
-
"description": "
|
|
995
|
-
"name": "OWNER/
|
|
969
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
970
|
+
"description": "Integration to fetch for given API on Swaggerhub",
|
|
971
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
996
972
|
"required": true
|
|
997
973
|
}
|
|
998
974
|
},
|
|
999
|
-
"description": "
|
|
975
|
+
"description": "retieves an integration for the given API.",
|
|
1000
976
|
"examples": [
|
|
1001
|
-
"swaggerhub
|
|
977
|
+
"swaggerhub integration:get organization/api/1.0.0/503c2db6-448a-4678-a310-f465429e9704"
|
|
1002
978
|
],
|
|
1003
979
|
"flags": {
|
|
1004
980
|
"help": {
|
|
@@ -1011,7 +987,7 @@
|
|
|
1011
987
|
},
|
|
1012
988
|
"hasDynamicHelp": false,
|
|
1013
989
|
"hiddenAliases": [],
|
|
1014
|
-
"id": "
|
|
990
|
+
"id": "integration:get",
|
|
1015
991
|
"pluginAlias": "swaggerhub-cli",
|
|
1016
992
|
"pluginName": "swaggerhub-cli",
|
|
1017
993
|
"pluginType": "core",
|
|
@@ -1021,22 +997,22 @@
|
|
|
1021
997
|
"relativePath": [
|
|
1022
998
|
"src",
|
|
1023
999
|
"commands",
|
|
1024
|
-
"
|
|
1025
|
-
"
|
|
1000
|
+
"integration",
|
|
1001
|
+
"get.js"
|
|
1026
1002
|
]
|
|
1027
1003
|
},
|
|
1028
|
-
"
|
|
1004
|
+
"integration:list": {
|
|
1029
1005
|
"aliases": [],
|
|
1030
1006
|
"args": {
|
|
1031
|
-
"OWNER/
|
|
1032
|
-
"description": "
|
|
1033
|
-
"name": "OWNER/
|
|
1007
|
+
"OWNER/API_NAME/[VERSION]": {
|
|
1008
|
+
"description": "API to list integrations for on Swaggerhub",
|
|
1009
|
+
"name": "OWNER/API_NAME/[VERSION]",
|
|
1034
1010
|
"required": true
|
|
1035
1011
|
}
|
|
1036
1012
|
},
|
|
1037
|
-
"description": "
|
|
1013
|
+
"description": "list integrations on an API.",
|
|
1038
1014
|
"examples": [
|
|
1039
|
-
"swaggerhub
|
|
1015
|
+
"swaggerhub integration:list organization/api/1.0.0"
|
|
1040
1016
|
],
|
|
1041
1017
|
"flags": {
|
|
1042
1018
|
"help": {
|
|
@@ -1049,7 +1025,7 @@
|
|
|
1049
1025
|
},
|
|
1050
1026
|
"hasDynamicHelp": false,
|
|
1051
1027
|
"hiddenAliases": [],
|
|
1052
|
-
"id": "
|
|
1028
|
+
"id": "integration:list",
|
|
1053
1029
|
"pluginAlias": "swaggerhub-cli",
|
|
1054
1030
|
"pluginName": "swaggerhub-cli",
|
|
1055
1031
|
"pluginType": "core",
|
|
@@ -1059,25 +1035,33 @@
|
|
|
1059
1035
|
"relativePath": [
|
|
1060
1036
|
"src",
|
|
1061
1037
|
"commands",
|
|
1062
|
-
"
|
|
1063
|
-
"
|
|
1038
|
+
"integration",
|
|
1039
|
+
"list.js"
|
|
1064
1040
|
]
|
|
1065
1041
|
},
|
|
1066
|
-
"
|
|
1042
|
+
"integration:update": {
|
|
1067
1043
|
"aliases": [],
|
|
1068
1044
|
"args": {
|
|
1069
|
-
"OWNER": {
|
|
1070
|
-
"description": "
|
|
1071
|
-
"name": "OWNER",
|
|
1072
|
-
"required":
|
|
1045
|
+
"OWNER/API_NAME/VERSION/INTEGRATION_ID": {
|
|
1046
|
+
"description": "Integration to update for given API on Swaggerhub",
|
|
1047
|
+
"name": "OWNER/API_NAME/VERSION/INTEGRATION_ID",
|
|
1048
|
+
"required": true
|
|
1073
1049
|
}
|
|
1074
1050
|
},
|
|
1075
|
-
"description": "
|
|
1051
|
+
"description": "update the configuration of an API integration.",
|
|
1076
1052
|
"examples": [
|
|
1077
|
-
"swaggerhub
|
|
1078
|
-
"swaggerhub project:list organization"
|
|
1053
|
+
"swaggerhub integration:update organization/api/1.0.0/503c2db6-448a-4678-abcd-0123456789abc --file config.json"
|
|
1079
1054
|
],
|
|
1080
1055
|
"flags": {
|
|
1056
|
+
"file": {
|
|
1057
|
+
"char": "f",
|
|
1058
|
+
"description": "location of integration configuration file",
|
|
1059
|
+
"name": "file",
|
|
1060
|
+
"required": true,
|
|
1061
|
+
"hasDynamicHelp": false,
|
|
1062
|
+
"multiple": false,
|
|
1063
|
+
"type": "option"
|
|
1064
|
+
},
|
|
1081
1065
|
"help": {
|
|
1082
1066
|
"char": "h",
|
|
1083
1067
|
"description": "Show CLI help.",
|
|
@@ -1088,7 +1072,7 @@
|
|
|
1088
1072
|
},
|
|
1089
1073
|
"hasDynamicHelp": false,
|
|
1090
1074
|
"hiddenAliases": [],
|
|
1091
|
-
"id": "
|
|
1075
|
+
"id": "integration:update",
|
|
1092
1076
|
"pluginAlias": "swaggerhub-cli",
|
|
1093
1077
|
"pluginName": "swaggerhub-cli",
|
|
1094
1078
|
"pluginType": "core",
|
|
@@ -1098,29 +1082,51 @@
|
|
|
1098
1082
|
"relativePath": [
|
|
1099
1083
|
"src",
|
|
1100
1084
|
"commands",
|
|
1101
|
-
"
|
|
1102
|
-
"
|
|
1085
|
+
"integration",
|
|
1086
|
+
"update.js"
|
|
1103
1087
|
]
|
|
1104
1088
|
},
|
|
1105
|
-
"
|
|
1089
|
+
"project:create": {
|
|
1106
1090
|
"aliases": [],
|
|
1107
1091
|
"args": {
|
|
1108
|
-
"OWNER/
|
|
1109
|
-
"description": "
|
|
1110
|
-
"name": "OWNER/
|
|
1092
|
+
"OWNER/PROJECT_NAME": {
|
|
1093
|
+
"description": "The new project to create on Swaggerhub",
|
|
1094
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1111
1095
|
"required": true
|
|
1112
1096
|
}
|
|
1113
1097
|
},
|
|
1114
|
-
"description": "
|
|
1098
|
+
"description": "Creates a new project in SwaggerHub.",
|
|
1115
1099
|
"examples": [
|
|
1116
|
-
"swaggerhub
|
|
1100
|
+
"swaggerhub project:create organization/new_project_name --description \"project description\"",
|
|
1101
|
+
"swaggerhub project:create organization/new_project_name -a \"testapi1,testapi2\"",
|
|
1102
|
+
"swaggerhub project:create organization/new_project_name --apis \"testapi1,testapi2\"",
|
|
1103
|
+
"swaggerhub project:create organization/new_project_name -d \"testdomain3,testdomain4\"",
|
|
1104
|
+
"swaggerhub project:create organization/new_project_name --domains \"testdomain3,testdomain4\"",
|
|
1105
|
+
"swaggerhub project:create organization/new_project_name -a \"testapi1\" -d \"testdomain3\" --description \"description\""
|
|
1117
1106
|
],
|
|
1118
1107
|
"flags": {
|
|
1119
|
-
"
|
|
1120
|
-
"
|
|
1121
|
-
"
|
|
1122
|
-
"
|
|
1123
|
-
"
|
|
1108
|
+
"description": {
|
|
1109
|
+
"description": "Description of project",
|
|
1110
|
+
"name": "description",
|
|
1111
|
+
"required": false,
|
|
1112
|
+
"hasDynamicHelp": false,
|
|
1113
|
+
"multiple": false,
|
|
1114
|
+
"type": "option"
|
|
1115
|
+
},
|
|
1116
|
+
"apis": {
|
|
1117
|
+
"char": "a",
|
|
1118
|
+
"description": "Comma separated list of api names to include in project",
|
|
1119
|
+
"name": "apis",
|
|
1120
|
+
"required": false,
|
|
1121
|
+
"hasDynamicHelp": false,
|
|
1122
|
+
"multiple": false,
|
|
1123
|
+
"type": "option"
|
|
1124
|
+
},
|
|
1125
|
+
"domains": {
|
|
1126
|
+
"char": "d",
|
|
1127
|
+
"description": "Comma separated list of domain names to include in project",
|
|
1128
|
+
"name": "domains",
|
|
1129
|
+
"required": false,
|
|
1124
1130
|
"hasDynamicHelp": false,
|
|
1125
1131
|
"multiple": false,
|
|
1126
1132
|
"type": "option"
|
|
@@ -1135,7 +1141,7 @@
|
|
|
1135
1141
|
},
|
|
1136
1142
|
"hasDynamicHelp": false,
|
|
1137
1143
|
"hiddenAliases": [],
|
|
1138
|
-
"id": "
|
|
1144
|
+
"id": "project:create",
|
|
1139
1145
|
"pluginAlias": "swaggerhub-cli",
|
|
1140
1146
|
"pluginName": "swaggerhub-cli",
|
|
1141
1147
|
"pluginType": "core",
|
|
@@ -1145,22 +1151,22 @@
|
|
|
1145
1151
|
"relativePath": [
|
|
1146
1152
|
"src",
|
|
1147
1153
|
"commands",
|
|
1148
|
-
"
|
|
1154
|
+
"project",
|
|
1149
1155
|
"create.js"
|
|
1150
1156
|
]
|
|
1151
1157
|
},
|
|
1152
|
-
"
|
|
1158
|
+
"project:delete": {
|
|
1153
1159
|
"aliases": [],
|
|
1154
1160
|
"args": {
|
|
1155
|
-
"OWNER/
|
|
1156
|
-
"description": "
|
|
1157
|
-
"name": "OWNER/
|
|
1161
|
+
"OWNER/PROJECT_NAME": {
|
|
1162
|
+
"description": "The project to delete on Swaggerhub",
|
|
1163
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1158
1164
|
"required": true
|
|
1159
1165
|
}
|
|
1160
1166
|
},
|
|
1161
|
-
"description": "
|
|
1167
|
+
"description": "Deletes a project from SwaggerHub.",
|
|
1162
1168
|
"examples": [
|
|
1163
|
-
"swaggerhub
|
|
1169
|
+
"swaggerhub project:delete organization/project_name"
|
|
1164
1170
|
],
|
|
1165
1171
|
"flags": {
|
|
1166
1172
|
"help": {
|
|
@@ -1173,7 +1179,7 @@
|
|
|
1173
1179
|
},
|
|
1174
1180
|
"hasDynamicHelp": false,
|
|
1175
1181
|
"hiddenAliases": [],
|
|
1176
|
-
"id": "
|
|
1182
|
+
"id": "project:delete",
|
|
1177
1183
|
"pluginAlias": "swaggerhub-cli",
|
|
1178
1184
|
"pluginName": "swaggerhub-cli",
|
|
1179
1185
|
"pluginType": "core",
|
|
@@ -1183,22 +1189,22 @@
|
|
|
1183
1189
|
"relativePath": [
|
|
1184
1190
|
"src",
|
|
1185
1191
|
"commands",
|
|
1186
|
-
"
|
|
1192
|
+
"project",
|
|
1187
1193
|
"delete.js"
|
|
1188
1194
|
]
|
|
1189
1195
|
},
|
|
1190
|
-
"
|
|
1196
|
+
"project:get": {
|
|
1191
1197
|
"aliases": [],
|
|
1192
1198
|
"args": {
|
|
1193
|
-
"OWNER/
|
|
1194
|
-
"description": "
|
|
1195
|
-
"name": "OWNER/
|
|
1199
|
+
"OWNER/PROJECT_NAME": {
|
|
1200
|
+
"description": "The project to get details for on Swaggerhub",
|
|
1201
|
+
"name": "OWNER/PROJECT_NAME",
|
|
1196
1202
|
"required": true
|
|
1197
1203
|
}
|
|
1198
1204
|
},
|
|
1199
|
-
"description": "
|
|
1205
|
+
"description": "Retrieves the details for a project.",
|
|
1200
1206
|
"examples": [
|
|
1201
|
-
"swaggerhub
|
|
1207
|
+
"swaggerhub project:get organization/project_name"
|
|
1202
1208
|
],
|
|
1203
1209
|
"flags": {
|
|
1204
1210
|
"help": {
|
|
@@ -1211,7 +1217,7 @@
|
|
|
1211
1217
|
},
|
|
1212
1218
|
"hasDynamicHelp": false,
|
|
1213
1219
|
"hiddenAliases": [],
|
|
1214
|
-
"id": "
|
|
1220
|
+
"id": "project:get",
|
|
1215
1221
|
"pluginAlias": "swaggerhub-cli",
|
|
1216
1222
|
"pluginName": "swaggerhub-cli",
|
|
1217
1223
|
"pluginType": "core",
|
|
@@ -1221,22 +1227,25 @@
|
|
|
1221
1227
|
"relativePath": [
|
|
1222
1228
|
"src",
|
|
1223
1229
|
"commands",
|
|
1224
|
-
"
|
|
1225
|
-
"
|
|
1230
|
+
"project",
|
|
1231
|
+
"get.js"
|
|
1226
1232
|
]
|
|
1227
1233
|
},
|
|
1228
|
-
"
|
|
1234
|
+
"project:list": {
|
|
1229
1235
|
"aliases": [],
|
|
1230
1236
|
"args": {
|
|
1231
|
-
"OWNER
|
|
1232
|
-
"description": "
|
|
1233
|
-
"name": "OWNER
|
|
1234
|
-
"required":
|
|
1237
|
+
"OWNER": {
|
|
1238
|
+
"description": "The organization to list projects for on Swaggerhub",
|
|
1239
|
+
"name": "OWNER",
|
|
1240
|
+
"required": false
|
|
1235
1241
|
}
|
|
1236
1242
|
},
|
|
1237
|
-
"description": "
|
|
1243
|
+
"description": "list projects",
|
|
1238
1244
|
"examples": [
|
|
1239
|
-
"swaggerhub
|
|
1245
|
+
"swaggerhub project:list",
|
|
1246
|
+
"swaggerhub project:list organization",
|
|
1247
|
+
"swaggerhub project:list organization --limit 20 --order DESC",
|
|
1248
|
+
"swaggerhub project:list organization --page 2 --limit 20"
|
|
1240
1249
|
],
|
|
1241
1250
|
"flags": {
|
|
1242
1251
|
"help": {
|
|
@@ -1245,11 +1254,37 @@
|
|
|
1245
1254
|
"name": "help",
|
|
1246
1255
|
"allowNo": false,
|
|
1247
1256
|
"type": "boolean"
|
|
1257
|
+
},
|
|
1258
|
+
"limit": {
|
|
1259
|
+
"char": "l",
|
|
1260
|
+
"description": "number of projects per page (1-100)",
|
|
1261
|
+
"name": "limit",
|
|
1262
|
+
"hasDynamicHelp": false,
|
|
1263
|
+
"multiple": false,
|
|
1264
|
+
"type": "option"
|
|
1265
|
+
},
|
|
1266
|
+
"page": {
|
|
1267
|
+
"description": "zero-based page of projects to return",
|
|
1268
|
+
"name": "page",
|
|
1269
|
+
"hasDynamicHelp": false,
|
|
1270
|
+
"multiple": false,
|
|
1271
|
+
"type": "option"
|
|
1272
|
+
},
|
|
1273
|
+
"order": {
|
|
1274
|
+
"description": "sort order of the projects",
|
|
1275
|
+
"name": "order",
|
|
1276
|
+
"hasDynamicHelp": false,
|
|
1277
|
+
"multiple": false,
|
|
1278
|
+
"options": [
|
|
1279
|
+
"ASC",
|
|
1280
|
+
"DESC"
|
|
1281
|
+
],
|
|
1282
|
+
"type": "option"
|
|
1248
1283
|
}
|
|
1249
1284
|
},
|
|
1250
1285
|
"hasDynamicHelp": false,
|
|
1251
1286
|
"hiddenAliases": [],
|
|
1252
|
-
"id": "
|
|
1287
|
+
"id": "project:list",
|
|
1253
1288
|
"pluginAlias": "swaggerhub-cli",
|
|
1254
1289
|
"pluginName": "swaggerhub-cli",
|
|
1255
1290
|
"pluginType": "core",
|
|
@@ -1259,22 +1294,27 @@
|
|
|
1259
1294
|
"relativePath": [
|
|
1260
1295
|
"src",
|
|
1261
1296
|
"commands",
|
|
1262
|
-
"
|
|
1263
|
-
"
|
|
1297
|
+
"project",
|
|
1298
|
+
"list.js"
|
|
1264
1299
|
]
|
|
1265
1300
|
},
|
|
1266
|
-
"
|
|
1301
|
+
"spectral:download": {
|
|
1267
1302
|
"aliases": [],
|
|
1268
1303
|
"args": {
|
|
1269
|
-
"OWNER/
|
|
1270
|
-
"description": "
|
|
1271
|
-
"name": "OWNER/
|
|
1304
|
+
"OWNER/RULESET_NAME": {
|
|
1305
|
+
"description": "Organization's Spectral ruleset to create or update on SwaggerHub",
|
|
1306
|
+
"name": "OWNER/RULESET_NAME",
|
|
1307
|
+
"required": true
|
|
1308
|
+
},
|
|
1309
|
+
"directory": {
|
|
1310
|
+
"description": "Relative path to directory the ruleset files should be saved to",
|
|
1311
|
+
"name": "directory",
|
|
1272
1312
|
"required": true
|
|
1273
1313
|
}
|
|
1274
1314
|
},
|
|
1275
|
-
"description": "
|
|
1315
|
+
"description": "Fetch organization's Spectral ruleset",
|
|
1276
1316
|
"examples": [
|
|
1277
|
-
"swaggerhub
|
|
1317
|
+
"swaggerhub spectral:download my_organization/my_api_ruleset rules/"
|
|
1278
1318
|
],
|
|
1279
1319
|
"flags": {
|
|
1280
1320
|
"help": {
|
|
@@ -1287,7 +1327,7 @@
|
|
|
1287
1327
|
},
|
|
1288
1328
|
"hasDynamicHelp": false,
|
|
1289
1329
|
"hiddenAliases": [],
|
|
1290
|
-
"id": "
|
|
1330
|
+
"id": "spectral:download",
|
|
1291
1331
|
"pluginAlias": "swaggerhub-cli",
|
|
1292
1332
|
"pluginName": "swaggerhub-cli",
|
|
1293
1333
|
"pluginType": "core",
|
|
@@ -1297,33 +1337,29 @@
|
|
|
1297
1337
|
"relativePath": [
|
|
1298
1338
|
"src",
|
|
1299
1339
|
"commands",
|
|
1300
|
-
"
|
|
1301
|
-
"
|
|
1340
|
+
"spectral",
|
|
1341
|
+
"download.js"
|
|
1302
1342
|
]
|
|
1303
1343
|
},
|
|
1304
|
-
"
|
|
1344
|
+
"spectral:upload": {
|
|
1305
1345
|
"aliases": [],
|
|
1306
1346
|
"args": {
|
|
1307
|
-
"OWNER/
|
|
1308
|
-
"description": "
|
|
1309
|
-
"name": "OWNER/
|
|
1347
|
+
"OWNER/RULESET_NAME": {
|
|
1348
|
+
"description": "Organization's Spectral ruleset to create or update on SwaggerHub",
|
|
1349
|
+
"name": "OWNER/RULESET_NAME",
|
|
1350
|
+
"required": true
|
|
1351
|
+
},
|
|
1352
|
+
"directory": {
|
|
1353
|
+
"description": "Relative path to directory with ruleset files",
|
|
1354
|
+
"name": "directory",
|
|
1310
1355
|
"required": true
|
|
1311
1356
|
}
|
|
1312
1357
|
},
|
|
1313
|
-
"description": "
|
|
1358
|
+
"description": "Create or update organization's Spectral ruleset",
|
|
1314
1359
|
"examples": [
|
|
1315
|
-
"swaggerhub
|
|
1360
|
+
"swaggerhub spectral:upload my_organization/my_api_ruleset rules/"
|
|
1316
1361
|
],
|
|
1317
1362
|
"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
|
-
},
|
|
1327
1363
|
"help": {
|
|
1328
1364
|
"char": "h",
|
|
1329
1365
|
"description": "Show CLI help.",
|
|
@@ -1334,7 +1370,7 @@
|
|
|
1334
1370
|
},
|
|
1335
1371
|
"hasDynamicHelp": false,
|
|
1336
1372
|
"hiddenAliases": [],
|
|
1337
|
-
"id": "
|
|
1373
|
+
"id": "spectral:upload",
|
|
1338
1374
|
"pluginAlias": "swaggerhub-cli",
|
|
1339
1375
|
"pluginName": "swaggerhub-cli",
|
|
1340
1376
|
"pluginType": "core",
|
|
@@ -1344,8 +1380,8 @@
|
|
|
1344
1380
|
"relativePath": [
|
|
1345
1381
|
"src",
|
|
1346
1382
|
"commands",
|
|
1347
|
-
"
|
|
1348
|
-
"
|
|
1383
|
+
"spectral",
|
|
1384
|
+
"upload.js"
|
|
1349
1385
|
]
|
|
1350
1386
|
},
|
|
1351
1387
|
"api:validate:download-rules": {
|
|
@@ -1525,23 +1561,23 @@
|
|
|
1525
1561
|
"local.js"
|
|
1526
1562
|
]
|
|
1527
1563
|
},
|
|
1528
|
-
"project:
|
|
1564
|
+
"project:domain:add": {
|
|
1529
1565
|
"aliases": [],
|
|
1530
1566
|
"args": {
|
|
1531
1567
|
"OWNER/PROJECT_NAME": {
|
|
1532
|
-
"description": "The project to add the
|
|
1568
|
+
"description": "The project to add the domain to on Swaggerhub",
|
|
1533
1569
|
"name": "OWNER/PROJECT_NAME",
|
|
1534
1570
|
"required": true
|
|
1535
1571
|
},
|
|
1536
|
-
"
|
|
1537
|
-
"description": "The name of the
|
|
1538
|
-
"name": "
|
|
1572
|
+
"DOMAIN": {
|
|
1573
|
+
"description": "The name of the domain on Swaggerhub to add",
|
|
1574
|
+
"name": "DOMAIN",
|
|
1539
1575
|
"required": true
|
|
1540
1576
|
}
|
|
1541
1577
|
},
|
|
1542
|
-
"description": "Adds
|
|
1578
|
+
"description": "Adds a domain to an existing project.",
|
|
1543
1579
|
"examples": [
|
|
1544
|
-
"swaggerhub project:
|
|
1580
|
+
"swaggerhub project:domain:add organization/project_name my_domain"
|
|
1545
1581
|
],
|
|
1546
1582
|
"flags": {
|
|
1547
1583
|
"help": {
|
|
@@ -1554,7 +1590,7 @@
|
|
|
1554
1590
|
},
|
|
1555
1591
|
"hasDynamicHelp": false,
|
|
1556
1592
|
"hiddenAliases": [],
|
|
1557
|
-
"id": "project:
|
|
1593
|
+
"id": "project:domain:add",
|
|
1558
1594
|
"pluginAlias": "swaggerhub-cli",
|
|
1559
1595
|
"pluginName": "swaggerhub-cli",
|
|
1560
1596
|
"pluginType": "core",
|
|
@@ -1565,27 +1601,27 @@
|
|
|
1565
1601
|
"src",
|
|
1566
1602
|
"commands",
|
|
1567
1603
|
"project",
|
|
1568
|
-
"
|
|
1604
|
+
"domain",
|
|
1569
1605
|
"add.js"
|
|
1570
1606
|
]
|
|
1571
1607
|
},
|
|
1572
|
-
"project:
|
|
1608
|
+
"project:domain:remove": {
|
|
1573
1609
|
"aliases": [],
|
|
1574
1610
|
"args": {
|
|
1575
1611
|
"OWNER/PROJECT_NAME": {
|
|
1576
|
-
"description": "The project to remove the
|
|
1612
|
+
"description": "The project to remove the domain from on Swaggerhub",
|
|
1577
1613
|
"name": "OWNER/PROJECT_NAME",
|
|
1578
1614
|
"required": true
|
|
1579
1615
|
},
|
|
1580
|
-
"
|
|
1581
|
-
"description": "The name of the
|
|
1582
|
-
"name": "
|
|
1616
|
+
"DOMAIN": {
|
|
1617
|
+
"description": "The name of the domain on Swaggerhub to remove",
|
|
1618
|
+
"name": "DOMAIN",
|
|
1583
1619
|
"required": true
|
|
1584
1620
|
}
|
|
1585
1621
|
},
|
|
1586
|
-
"description": "Removes
|
|
1622
|
+
"description": "Removes a domain from a project in SwaggerHub.",
|
|
1587
1623
|
"examples": [
|
|
1588
|
-
"swaggerhub project:
|
|
1624
|
+
"swaggerhub project:domain:remove organization/project_name my_domain"
|
|
1589
1625
|
],
|
|
1590
1626
|
"flags": {
|
|
1591
1627
|
"help": {
|
|
@@ -1598,7 +1634,7 @@
|
|
|
1598
1634
|
},
|
|
1599
1635
|
"hasDynamicHelp": false,
|
|
1600
1636
|
"hiddenAliases": [],
|
|
1601
|
-
"id": "project:
|
|
1637
|
+
"id": "project:domain:remove",
|
|
1602
1638
|
"pluginAlias": "swaggerhub-cli",
|
|
1603
1639
|
"pluginName": "swaggerhub-cli",
|
|
1604
1640
|
"pluginType": "core",
|
|
@@ -1609,22 +1645,27 @@
|
|
|
1609
1645
|
"src",
|
|
1610
1646
|
"commands",
|
|
1611
1647
|
"project",
|
|
1612
|
-
"
|
|
1648
|
+
"domain",
|
|
1613
1649
|
"remove.js"
|
|
1614
1650
|
]
|
|
1615
1651
|
},
|
|
1616
|
-
"project:
|
|
1652
|
+
"project:api:add": {
|
|
1617
1653
|
"aliases": [],
|
|
1618
1654
|
"args": {
|
|
1619
1655
|
"OWNER/PROJECT_NAME": {
|
|
1620
|
-
"description": "
|
|
1656
|
+
"description": "The project to add the API to on Swaggerhub",
|
|
1621
1657
|
"name": "OWNER/PROJECT_NAME",
|
|
1622
1658
|
"required": true
|
|
1659
|
+
},
|
|
1660
|
+
"API": {
|
|
1661
|
+
"description": "The name of the API on Swaggerhub to add",
|
|
1662
|
+
"name": "API",
|
|
1663
|
+
"required": true
|
|
1623
1664
|
}
|
|
1624
1665
|
},
|
|
1625
|
-
"description": "
|
|
1666
|
+
"description": "Adds an API to an existing project.",
|
|
1626
1667
|
"examples": [
|
|
1627
|
-
"swaggerhub project:
|
|
1668
|
+
"swaggerhub project:api:add organization/project_name my_api"
|
|
1628
1669
|
],
|
|
1629
1670
|
"flags": {
|
|
1630
1671
|
"help": {
|
|
@@ -1637,7 +1678,7 @@
|
|
|
1637
1678
|
},
|
|
1638
1679
|
"hasDynamicHelp": false,
|
|
1639
1680
|
"hiddenAliases": [],
|
|
1640
|
-
"id": "project:
|
|
1681
|
+
"id": "project:api:add",
|
|
1641
1682
|
"pluginAlias": "swaggerhub-cli",
|
|
1642
1683
|
"pluginName": "swaggerhub-cli",
|
|
1643
1684
|
"pluginType": "core",
|
|
@@ -1648,27 +1689,27 @@
|
|
|
1648
1689
|
"src",
|
|
1649
1690
|
"commands",
|
|
1650
1691
|
"project",
|
|
1651
|
-
"
|
|
1652
|
-
"
|
|
1692
|
+
"api",
|
|
1693
|
+
"add.js"
|
|
1653
1694
|
]
|
|
1654
1695
|
},
|
|
1655
|
-
"project:
|
|
1696
|
+
"project:api:remove": {
|
|
1656
1697
|
"aliases": [],
|
|
1657
1698
|
"args": {
|
|
1658
1699
|
"OWNER/PROJECT_NAME": {
|
|
1659
|
-
"description": "The project to
|
|
1700
|
+
"description": "The project to remove the API from on Swaggerhub",
|
|
1660
1701
|
"name": "OWNER/PROJECT_NAME",
|
|
1661
1702
|
"required": true
|
|
1662
1703
|
},
|
|
1663
|
-
"
|
|
1664
|
-
"description": "The name of the
|
|
1665
|
-
"name": "
|
|
1704
|
+
"API": {
|
|
1705
|
+
"description": "The name of the API on Swaggerhub to remove",
|
|
1706
|
+
"name": "API",
|
|
1666
1707
|
"required": true
|
|
1667
1708
|
}
|
|
1668
1709
|
},
|
|
1669
|
-
"description": "
|
|
1710
|
+
"description": "Removes an API from a project in SwaggerHub.",
|
|
1670
1711
|
"examples": [
|
|
1671
|
-
"swaggerhub project:
|
|
1712
|
+
"swaggerhub project:api:remove organization/project_name my_api"
|
|
1672
1713
|
],
|
|
1673
1714
|
"flags": {
|
|
1674
1715
|
"help": {
|
|
@@ -1681,7 +1722,7 @@
|
|
|
1681
1722
|
},
|
|
1682
1723
|
"hasDynamicHelp": false,
|
|
1683
1724
|
"hiddenAliases": [],
|
|
1684
|
-
"id": "project:
|
|
1725
|
+
"id": "project:api:remove",
|
|
1685
1726
|
"pluginAlias": "swaggerhub-cli",
|
|
1686
1727
|
"pluginName": "swaggerhub-cli",
|
|
1687
1728
|
"pluginType": "core",
|
|
@@ -1692,27 +1733,22 @@
|
|
|
1692
1733
|
"src",
|
|
1693
1734
|
"commands",
|
|
1694
1735
|
"project",
|
|
1695
|
-
"
|
|
1696
|
-
"
|
|
1736
|
+
"api",
|
|
1737
|
+
"remove.js"
|
|
1697
1738
|
]
|
|
1698
1739
|
},
|
|
1699
|
-
"project:
|
|
1740
|
+
"project:member:list": {
|
|
1700
1741
|
"aliases": [],
|
|
1701
1742
|
"args": {
|
|
1702
1743
|
"OWNER/PROJECT_NAME": {
|
|
1703
|
-
"description": "
|
|
1744
|
+
"description": "Project to list members of on Swaggerhub",
|
|
1704
1745
|
"name": "OWNER/PROJECT_NAME",
|
|
1705
1746
|
"required": true
|
|
1706
|
-
},
|
|
1707
|
-
"DOMAIN": {
|
|
1708
|
-
"description": "The name of the domain on Swaggerhub to remove",
|
|
1709
|
-
"name": "DOMAIN",
|
|
1710
|
-
"required": true
|
|
1711
1747
|
}
|
|
1712
1748
|
},
|
|
1713
|
-
"description": "
|
|
1749
|
+
"description": "list members of a project",
|
|
1714
1750
|
"examples": [
|
|
1715
|
-
"swaggerhub project:
|
|
1751
|
+
"swaggerhub project:member:list organisation/project_name"
|
|
1716
1752
|
],
|
|
1717
1753
|
"flags": {
|
|
1718
1754
|
"help": {
|
|
@@ -1725,7 +1761,7 @@
|
|
|
1725
1761
|
},
|
|
1726
1762
|
"hasDynamicHelp": false,
|
|
1727
1763
|
"hiddenAliases": [],
|
|
1728
|
-
"id": "project:
|
|
1764
|
+
"id": "project:member:list",
|
|
1729
1765
|
"pluginAlias": "swaggerhub-cli",
|
|
1730
1766
|
"pluginName": "swaggerhub-cli",
|
|
1731
1767
|
"pluginType": "core",
|
|
@@ -1736,10 +1772,10 @@
|
|
|
1736
1772
|
"src",
|
|
1737
1773
|
"commands",
|
|
1738
1774
|
"project",
|
|
1739
|
-
"
|
|
1740
|
-
"
|
|
1775
|
+
"member",
|
|
1776
|
+
"list.js"
|
|
1741
1777
|
]
|
|
1742
1778
|
}
|
|
1743
1779
|
},
|
|
1744
|
-
"version": "0.
|
|
1780
|
+
"version": "0.13.0"
|
|
1745
1781
|
}
|