Overview
| Comment: | updated the api doc |
|---|---|
| Downloads: | Tarball | ZIP archive | SQL archive |
| Timelines: | family | ancestors | descendants | both | v1.62 |
| Files: | files | file ages | folders |
| SHA1: |
481e6c18c68e113f4e287f9e701d4f16 |
| User & Date: | pjhatwal on 2016-10-03 16:24:57 |
| Other Links: | branch diff | manifest | tags |
Context
|
2016-10-06
| ||
| 11:28 | Merged partial implementation of graph controls and added remote support for load detection check-in: 18599e811e user: mrwellan tags: v1.62 | |
|
2016-10-05
| ||
| 13:34 | merged with latest v1.62 Closed-Leaf check-in: abcfb9550d user: srehman tags: defstruct-srehman | |
|
2016-10-03
| ||
| 16:24 | updated the api doc check-in: 481e6c18c6 user: pjhatwal tags: v1.62 | |
| 15:49 | Fixed read-only access issues. However it still fails if the db is old (i.e. is missing last_update field). check-in: 7a7ceab729 user: mrwellan tags: v1.62 | |
Changes
Modified docs/api.html from [c2276e6b3d] to [b7a1558ae4].
| ︙ | ︙ | |||
823 824 825 826 827 828 829 830 831 832 833 834 835 836 |
</div></div>
</div>
<div class="sect2">
<h3 id="_get_list_of_runs">1.2. Get List of Runs</h3>
<div class="paragraph"><p>URL: <base>/runs</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Filter Params: target, testpatt, offset, limit</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>[
{
"<span class="red">run_id</span>" : "1",
"<span class="red">name</span>" : "runname1",
| > | 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 |
</div></div>
</div>
<div class="sect2">
<h3 id="_get_list_of_runs">1.2. Get List of Runs</h3>
<div class="paragraph"><p>URL: <base>/runs</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Filter Params: target, testpatt, offset, limit</p></div>
<div class="paragraph"><p>Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs % -target % -dumpmode json -fields runs:runname,id+tests:state,status:id</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>[
{
"<span class="red">run_id</span>" : "1",
"<span class="red">name</span>" : "runname1",
|
| ︙ | ︙ | |||
862 863 864 865 866 867 868 869 870 871 872 873 874 875 |
]</p></div>
</div></div>
</div>
<div class="sect2">
<h3 id="_trigger_a_new_run">1.3. Trigger a new Run</h3>
<div class="paragraph"><p>URL: <base>/runs</p></div>
<div class="paragraph"><p>Method: POST</p></div>
<div class="paragraph"><p>Request Params:</p></div>
<div class="exampleblock">
<div class="content">
<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>
</div></div>
<div class="paragraph"><p>Response:</p></div>
<div class="paragraph"><p>If Error</p></div>
| > | 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 |
]</p></div>
</div></div>
</div>
<div class="sect2">
<h3 id="_trigger_a_new_run">1.3. Trigger a new Run</h3>
<div class="paragraph"><p>URL: <base>/runs</p></div>
<div class="paragraph"><p>Method: POST</p></div>
<div class="paragraph"><p>Megatest Cmd: megatest -runtests % -target <target> :runname <run_name> -run</p></div>
<div class="paragraph"><p>Request Params:</p></div>
<div class="exampleblock">
<div class="content">
<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>
</div></div>
<div class="paragraph"><p>Response:</p></div>
<div class="paragraph"><p>If Error</p></div>
|
| ︙ | ︙ | |||
899 900 901 902 903 904 905 906 907 908 909 910 911 912 |
</div></div>
</div>
<div class="sect2">
<h3 id="_get_perticular_run">1.4. Get perticular Run</h3>
<div class="paragraph"><p>URL: <base>/runs/:id</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Filter Params: testpatt</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>[
{
"<span class="red">run_id</span>" : "2",
"<span class="red">name</span>" : "runname2",
| > | 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 |
</div></div>
</div>
<div class="sect2">
<h3 id="_get_perticular_run">1.4. Get perticular Run</h3>
<div class="paragraph"><p>URL: <base>/runs/:id</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Filter Params: testpatt</p></div>
<div class="paragraph"><p>Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs <runname> -target % -dumpmode json -fields runs:runname,id+tests:state,status:id</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>[
{
"<span class="red">run_id</span>" : "2",
"<span class="red">name</span>" : "runname2",
|
| ︙ | ︙ | |||
950 951 952 953 954 955 956 957 958 959 960 961 962 963 |
]</p></div>
</div></div>
</div>
<div class="sect2">
<h3 id="_get_list_of_tests_within_a_run">1.6. Get List of tests within a run</h3>
<div class="paragraph"><p>URL: <base>/runs/:id/tests</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>[
"<span class="red">tests</span>" :
[
{"<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"}
| > | 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 |
]</p></div>
</div></div>
</div>
<div class="sect2">
<h3 id="_get_list_of_tests_within_a_run">1.6. Get List of tests within a run</h3>
<div class="paragraph"><p>URL: <base>/runs/:id/tests</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs <runname> -target % -dumpmode json -fields runs:runname,id+tests:state,status:id</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<div class="paragraph"><p>[
"<span class="red">tests</span>" :
[
{"<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"}
|
| ︙ | ︙ | |||
977 978 979 980 981 982 983 984 985 986 987 988 989 990 |
<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>
</div></div>
</div>
<div class="sect2">
<h3 id="_get_perticular_test_that_belongs_to_a_runs">1.8. Get perticular test that belongs to a Runs</h3>
<div class="paragraph"><p>URL: <base>/runs/:id/tests/:id</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<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>
</div></div>
</div>
</div>
| > | 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 |
<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>
</div></div>
</div>
<div class="sect2">
<h3 id="_get_perticular_test_that_belongs_to_a_runs">1.8. Get perticular test that belongs to a Runs</h3>
<div class="paragraph"><p>URL: <base>/runs/:id/tests/:id</p></div>
<div class="paragraph"><p>Method: GET</p></div>
<div class="paragraph"><p>Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs <runname> -target % -testpattern <pattern> -dumpmode json -fields runs:runname,id+tests:state,status:id</p></div>
<div class="paragraph"><p>Response:</p></div>
<div class="exampleblock">
<div class="content">
<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>
</div></div>
</div>
</div>
|
| ︙ | ︙ | |||
1008 1009 1010 1011 1012 1013 1014 | </div> </div> </div> <div id="footnotes"><hr></div> <div id="footer"> <div id="footer-text"> Version 1.0<br> | | | 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 | </div> </div> </div> <div id="footnotes"><hr></div> <div id="footer"> <div id="footer-text"> Version 1.0<br> Last updated 2016-08-22 14:16:39 PDT </div> </div> </body> </html> |
Modified docs/api.txt from [bcdb746fea] to [22dea6c059].
| ︙ | ︙ | |||
38 39 40 41 42 43 44 45 46 47 48 49 50 51 |
URL: <base>/runs
Method: GET
Filter Params: target, testpatt, offset, limit
Response:
==================
[
{
"[red]#run_id#" : "1",
| > > | 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 |
URL: <base>/runs
Method: GET
Filter Params: target, testpatt, offset, limit
Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs % -target % -dumpmode json -fields runs:runname,id+tests:state,status:id
Response:
==================
[
{
"[red]#run_id#" : "1",
|
| ︙ | ︙ | |||
82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
Trigger a new Run
~~~~~~~~~~~~~~~~~~
URL: <base>/runs
Method: POST
Request Params:
==================
{"[blue]#target#": "target_value", "[blue]#runname#" : "runname", "[blue]#test_pattern#": "optional test pattern"}
==================
Response:
| > > | 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
Trigger a new Run
~~~~~~~~~~~~~~~~~~
URL: <base>/runs
Method: POST
Megatest Cmd: megatest -runtests % -target <target> :runname <run_name> -run
Request Params:
==================
{"[blue]#target#": "target_value", "[blue]#runname#" : "runname", "[blue]#test_pattern#": "optional test pattern"}
==================
Response:
|
| ︙ | ︙ | |||
125 126 127 128 129 130 131 132 133 134 135 136 137 138 |
~~~~~~~~~~~~~~~~~~~
URL: <base>/runs/:id
Method: GET
Filter Params: testpatt
Response:
==================
[
{
"[red]#run_id#" : "2",
| > > > | 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
~~~~~~~~~~~~~~~~~~~
URL: <base>/runs/:id
Method: GET
Filter Params: testpatt
Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs <runname> -target % -dumpmode json -fields runs:runname,id+tests:state,status:id
Response:
==================
[
{
"[red]#run_id#" : "2",
|
| ︙ | ︙ | |||
186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
Get List of tests within a run
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
URL: <base>/runs/:id/tests
Method: GET
Response:
==================
[
"[red]#tests#" :
[
{"[blue]#id#": 4, "[blue]#name#":[blue]#test1#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test1", "[blue]#final_logf#": "megatest-rollup-test1.html", "[blue]#status#": "PASS"}
| > > > | 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
Get List of tests within a run
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
URL: <base>/runs/:id/tests
Method: GET
Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs <runname> -target % -dumpmode json -fields runs:runname,id+tests:state,status:id
Response:
==================
[
"[red]#tests#" :
[
{"[blue]#id#": 4, "[blue]#name#":[blue]#test1#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test1", "[blue]#final_logf#": "megatest-rollup-test1.html", "[blue]#status#": "PASS"}
|
| ︙ | ︙ | |||
220 221 222 223 224 225 226 227 228 229 230 231 232 233 |
Get perticular test that belongs to a Runs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
URL: <base>/runs/:id/tests/:id
Method: GET
Response:
==================
{"[blue]#id#": "4", "[blue]#name#":"test1", "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test1", "[blue]#final_logf#": "megatest-rollup-test1.html", "[blue]#status#": "PASS"}
==================
| > > > | 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
Get perticular test that belongs to a Runs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
URL: <base>/runs/:id/tests/:id
Method: GET
Megatest Cmd: megatest -start-dir <path to megatest area> -list-runs <runname> -target % -testpattern <pattern> -dumpmode json -fields runs:runname,id+tests:state,status:id
Response:
==================
{"[blue]#id#": "4", "[blue]#name#":"test1", "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test1", "[blue]#final_logf#": "megatest-rollup-test1.html", "[blue]#status#": "PASS"}
==================
|
| ︙ | ︙ |