Skip to content

Commit 6f0546f

Browse files
author
mrwellan
committed
Merged fork
2 parents 8791c26 + da47e5e commit 6f0546f

File tree

3 files changed

+341
-18
lines changed

3 files changed

+341
-18
lines changed

‎docs/api.html

Lines changed: 155 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -824,20 +824,167 @@ <h3 id="_error_format_response">1.1. Error format response</h3>
824824
</div>
825825
<div class="sect2">
826826
<h3 id="_get_list_of_runs">1.2. Get List of Runs</h3>
827-
<div class="paragraph"><p>URL: &lt;base&gt;/get_runs</p></div>
827+
<div class="paragraph"><p>URL: &lt;base&gt;/runs</p></div>
828828
<div class="paragraph"><p>Method: GET</p></div>
829-
<div class="paragraph"><p>Params: target, testpatt, offset, limit</p></div>
829+
<div class="paragraph"><p>Filter Params: target, testpatt, offset, limit</p></div>
830830
<div class="paragraph"><p>Response:</p></div>
831831
<div class="exampleblock">
832832
<div class="content">
833-
<div class="paragraph"><p>{ "<span class="blue">us</span>" : "<span class="red">United States of America</span>" }</p></div>
833+
<div class="paragraph"><p>[
834+
{
835+
"<span class="red">run_id</span>" : "1",
836+
"<span class="red">name</span>" : "runname1",
837+
"<span class="red">target</span>" : "target1",
838+
"<span class="red">tests</span>" :
839+
[
840+
"<span class="green">test</span>":
841+
[
842+
{"<span class="blue">id</span>": 1, "<span class="blue">name</span>":test1, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target1/runname1/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS#"}
843+
{"<span class="blue">id</span>": 2, "<span class="blue">name</span>":test2, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target1/runname1/test2", "<span class="blue">final_logf</span>": "megatest-rollup-test2.html", "<span class="blue">status</span>": "PASS"}
844+
{"<span class="blue">id</span>": 3, "<span class="blue">name</span>":test3, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target1/runname1/test3", "<span class="blue">final_logf</span>": "megatest-rollup-test3.html", "<span class="blue">status</span>": "PASS"}
845+
]
846+
]
847+
},
848+
{
849+
"<span class="red">run_id</span>" : "2",
850+
"<span class="red">name</span>" : "runname2",
851+
"<span class="red">target</span>" : "target2",
852+
"<span class="red">tests</span>" :
853+
[
854+
"<span class="green">test</span>:
855+
[
856+
{"<span class="blue">id</span>": 4, "<span class="blue">name</span>":[blue]test1, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}
857+
{"<span class="blue">id</span>": 5, "<span class="blue">name</span>":[blue]test2, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test2", "<span class="blue">final_logf</span>": "megatest-rollup-test2.html", "<span class="blue">status</span>": "FAIL"}
858+
{"<span class="blue">id</span>": 6, "<span class="blue">name</span>":test3, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test3", "<span class="blue">final_logf</span>": "megatest-rollup-test3.html", "<span class="blue">status</span>": "PASS"}
859+
]
860+
]
861+
}
862+
]</p></div>
834863
</div></div>
835-
<div class="paragraph"><p>Another example &#8230;.</p></div>
864+
</div>
865+
<div class="sect2">
866+
<h3 id="_trigger_a_new_run">1.3. Trigger a new Run</h3>
867+
<div class="paragraph"><p>URL: &lt;base&gt;/runs</p></div>
868+
<div class="paragraph"><p>Method: POST</p></div>
869+
<div class="paragraph"><p>Request Params:</p></div>
870+
<div class="exampleblock">
871+
<div class="content">
872+
<div class="paragraph"><p>{"<span class="blue">target</span>": "target_value", "<span class="blue">runname</span>" : "runname", "<span class="blue">test_pattern</span>": "optional test pattern"}</p></div>
873+
</div></div>
874+
<div class="paragraph"><p>Response:</p></div>
875+
<div class="paragraph"><p>If Error</p></div>
876+
<div class="exampleblock">
877+
<div class="content">
878+
<div class="paragraph"><p>{ "<span class="blue">error</span>" : "<span class="red">Error message</span>" }</p></div>
879+
</div></div>
880+
<div class="paragraph"><p>If Success returns the results of the run</p></div>
881+
<div class="exampleblock">
882+
<div class="content">
883+
<div class="paragraph"><p>[
884+
{
885+
"<span class="red">run_id</span>" : "2",
886+
"<span class="red">name</span>" : "runname2",
887+
"<span class="red">target</span>" : "target2",
888+
"<span class="red">tests</span>" :
889+
[
890+
"<span class="green">test</span>:
891+
[
892+
{"<span class="blue">id</span>": 4, "<span class="blue">name</span>":[blue]test1, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}
893+
{"<span class="blue">id</span>": 5, "<span class="blue">name</span>":[blue]test2, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test2", "<span class="blue">final_logf</span>": "megatest-rollup-test2.html", "<span class="blue">status</span>": "FAIL"}
894+
{"<span class="blue">id</span>": 6, "<span class="blue">name</span>":test3, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test3", "<span class="blue">final_logf</span>": "megatest-rollup-test3.html", "<span class="blue">status</span>": "PASS"}
895+
]
896+
]
897+
}
898+
]</p></div>
899+
</div></div>
900+
</div>
901+
<div class="sect2">
902+
<h3 id="_get_perticular_run">1.4. Get perticular Run</h3>
903+
<div class="paragraph"><p>URL: &lt;base&gt;/runs/:id</p></div>
904+
<div class="paragraph"><p>Method: GET</p></div>
905+
<div class="paragraph"><p>Filter Params: testpatt</p></div>
906+
<div class="paragraph"><p>Response:</p></div>
907+
<div class="exampleblock">
908+
<div class="content">
909+
<div class="paragraph"><p>[
910+
{
911+
"<span class="red">run_id</span>" : "2",
912+
"<span class="red">name</span>" : "runname2",
913+
"<span class="red">target</span>" : "target2",
914+
"<span class="red">tests</span>" :
915+
[
916+
"<span class="green">test</span>":
917+
[
918+
{"<span class="blue">id</span>": 4, "<span class="blue">name</span>":[blue]test1, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}
919+
{"<span class="blue">id</span>": 5, "<span class="blue">name</span>":[blue]test2, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test2", "<span class="blue">final_logf</span>": "megatest-rollup-test2.html", "<span class="blue">status</span>": "FAIL"}
920+
{"<span class="blue">id</span>": 6, "<span class="blue">name</span>":test3, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test3", "<span class="blue">final_logf</span>": "megatest-rollup-test3.html", "<span class="blue">status</span>": "PASS"}
921+
]
922+
]
923+
}
924+
]</p></div>
925+
</div></div>
926+
</div>
927+
<div class="sect2">
928+
<h3 id="_re_execute_a_run">1.5. Re-execute a run</h3>
929+
<div class="paragraph"><p>URL: &lt;base&gt;/runs/:id</p></div>
930+
<div class="paragraph"><p>Method: PUT/PATCH</p></div>
931+
<div class="paragraph"><p>Request Params: {"testpatt" : "pattern"}</p></div>
932+
<div class="paragraph"><p>Response:</p></div>
933+
<div class="exampleblock">
934+
<div class="content">
935+
<div class="paragraph"><p>[
936+
{
937+
"<span class="red">run_id</span>" : "2",
938+
"<span class="red">name</span>" : "runname2",
939+
"<span class="red">target</span>" : "target2",
940+
"<span class="red">tests</span>" :
941+
[
942+
"<span class="green">test</span>":
943+
[
944+
{"<span class="blue">id</span>": 4, "<span class="blue">name</span>":[blue]test1, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}
945+
{"<span class="blue">id</span>": 5, "<span class="blue">name</span>":[blue]test2, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test2", "<span class="blue">final_logf</span>": "megatest-rollup-test2.html", "<span class="blue">status</span>": "FAIL"}
946+
{"<span class="blue">id</span>": 6, "<span class="blue">name</span>":test3, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test3", "<span class="blue">final_logf</span>": "megatest-rollup-test3.html", "<span class="blue">status</span>": "PASS"}
947+
]
948+
]
949+
}
950+
]</p></div>
951+
</div></div>
952+
</div>
953+
<div class="sect2">
954+
<h3 id="_get_list_of_tests_within_a_run">1.6. Get List of tests within a run</h3>
955+
<div class="paragraph"><p>URL: &lt;base&gt;/runs/:id/tests</p></div>
956+
<div class="paragraph"><p>Method: GET</p></div>
957+
<div class="paragraph"><p>Response:</p></div>
958+
<div class="exampleblock">
959+
<div class="content">
960+
<div class="paragraph"><p>[
961+
"<span class="red">tests</span>" :
962+
[
963+
{"<span class="blue">id</span>": 4, "<span class="blue">name</span>":[blue]test1, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}
964+
{"<span class="blue">id</span>": 5, "<span class="blue">name</span>":[blue]test2, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test2", "<span class="blue">final_logf</span>": "megatest-rollup-test2.html", "<span class="blue">status</span>": "FAIL"}
965+
{"<span class="blue">id</span>": 6, "<span class="blue">name</span>":test3, "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test3", "<span class="blue">final_logf</span>": "megatest-rollup-test3.html", "<span class="blue">status</span>": "PASS"}
966+
]
967+
]</p></div>
968+
</div></div>
969+
</div>
970+
<div class="sect2">
971+
<h3 id="_re_execute_a_test_within_a_run">1.7. Re-execute a test within a run</h3>
972+
<div class="paragraph"><p>URL: &lt;base&gt;/runs/:id/tests/:id</p></div>
973+
<div class="paragraph"><p>Method: PUT/PATCH</p></div>
974+
<div class="paragraph"><p>Response:</p></div>
975+
<div class="exampleblock">
976+
<div class="content">
977+
<div class="paragraph"><p>{"<span class="blue">id</span>": "4", "<span class="blue">name</span>":"test1", "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}</p></div>
978+
</div></div>
979+
</div>
980+
<div class="sect2">
981+
<h3 id="_get_perticular_test_that_belongs_to_a_runs">1.8. Get perticular test that belongs to a Runs</h3>
982+
<div class="paragraph"><p>URL: &lt;base&gt;/runs/:id/tests/:id</p></div>
983+
<div class="paragraph"><p>Method: GET</p></div>
984+
<div class="paragraph"><p>Response:</p></div>
836985
<div class="exampleblock">
837986
<div class="content">
838-
<div class="paragraph"><p>{ "<span class="blue">places</span>": [ [ "<span class="red">place_name</span>", "<span class="red">place_description</span> ], &#8230; ],
839-
"<span class="blue">friends</span>": [ [ "<span class="red">short_name</span>", "<span class="red">username</span>", "<span class="red">location</span>", <span class="red">uid</span>, <span class="red">frequency</span> ], &#8230; ],
840-
"<span class="blue">iousum</span>": [ [ "<span class="red">nick:location</span>", <span class="red">est_iou</span> ], &#8230;] }</p></div>
987+
<div class="paragraph"><p>{"<span class="blue">id</span>": "4", "<span class="blue">name</span>":"test1", "<span class="blue">item_path</span>": "", "<span class="blue">shortdir</span>": "/temp/foo/bar/target2/runname2/test1", "<span class="blue">final_logf</span>": "megatest-rollup-test1.html", "<span class="blue">status</span>": "PASS"}</p></div>
841988
</div></div>
842989
</div>
843990
</div>
@@ -865,7 +1012,7 @@ <h2 id="_notes">2. Notes</h2>
8651012
<div id="footer">
8661013
<div id="footer-text">
8671014
Version 1.0<br>
868-
Last updated 2016-07-25 15:03:20 PDT
1015+
Last updated 2016-08-03 14:52:22 PDT
8691016
</div>
8701017
</div>
8711018
</body>

0 commit comments

Comments
 (0)