Skip to content

Commit e1dee85

Browse files
committed
Add describe command docs
1 parent 06bb0ff commit e1dee85

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

api-test.sh

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,23 @@ function usage() {
9797
echo "'api-test -f test.json test test_case_1 test_case_2', 'api-test -f test.json test all'"
9898
exit
9999
;;
100+
describe)
101+
echo "List test cases or describe the contents in a test case."
102+
echo ""
103+
echo "USAGE: $COMMAND_NAME [-v] -f file_name describe [ARGS]"
104+
echo ""
105+
echo "OPTIONS:"
106+
echo " -h (--help) print this message"
107+
echo ""
108+
echo "ARGS:"
109+
echo " <empty> List all test case."
110+
echo " <test_case_name> Describe a test case."
111+
echo " <test_case_name> <path> Describe a test case property using json path."
112+
echo ""
113+
echo "EXAMPLE:"
114+
echo "'api-test -f test.json describe', 'api-test -f test.json describe test_case_1', 'api-test -f test.json describe test_case_1 body' "
115+
exit
116+
;;
100117
*)
101118
echo "A simple program to test JSON APIs."
102119
echo ""
@@ -111,6 +128,7 @@ function usage() {
111128
echo "COMMANDS:"
112129
echo " run Run test cases specified in the test file."
113130
echo " test Run automated test in the test file."
131+
echo " describe List test cases or describe the contents in a test case."
114132
echo ""
115133
echo "Run 'api-test COMMAND --help' for more information on a command."
116134
exit

0 commit comments

Comments
 (0)