Overview
Comment: | updated web api |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | v1.61 |
Files: | files | file ages | folders |
SHA1: |
f8b41f4fe3a75280eb07bc64f0ac6595 |
User & Date: | pjhatwal on 2016-08-03 15:54:56 |
Other Links: | branch diff | manifest | tags |
Context
2016-08-04
| ||
10:39 | Merged fork check-in: 1fb216bede user: mrwellan tags: v1.61 | |
2016-08-03
| ||
15:54 | updated web api check-in: f8b41f4fe3 user: pjhatwal tags: v1.61 | |
14:43 | Added changes for lines to graph check-in: d681096cd6 user: ritikaag tags: v1.61 | |
Changes
Modified docs/api.html from [9c5eea8f2c] to [a8c82235d6].
︙ | ︙ | |||
820 821 822 823 824 825 826 | <div class="exampleblock"> <div class="content"> <div class="paragraph"><p>{ "<span class="blue">error</span>" : "<span class="red">Error message</span>" }</p></div> </div></div> </div> <div class="sect2"> <h3 id="_get_list_of_runs">1.2. Get List of Runs</h3> | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > | > > > > > > > > > > > > > > > > > > > > > > > < < | < < < < < | 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 | <div class="exampleblock"> <div class="content"> <div class="paragraph"><p>{ "<span class="blue">error</span>" : "<span class="red">Error message</span>" }</p></div> </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", "<span class="red">target</span>" : "target1", "<span class="red">tests</span>" : [ "<span class="green">test</span>": [ {"<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#"} {"<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"} {"<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"} ] ] }, { "<span class="red">run_id</span>" : "2", "<span class="red">name</span>" : "runname2", "<span class="red">target</span>" : "target2", "<span class="red">tests</span>" : [ "<span class="green">test</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"} {"<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"} {"<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"} ] ] } ]</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> <div class="exampleblock"> <div class="content"> <div class="paragraph"><p>{ "<span class="blue">error</span>" : "<span class="red">Error message</span>" }</p></div> </div></div> <div class="paragraph"><p>If Success returns the results of the run</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", "<span class="red">target</span>" : "target2", "<span class="red">tests</span>" : [ "<span class="green">test</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"} {"<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"} {"<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"} ] ] } ]</p></div> </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", "<span class="red">target</span>" : "target2", "<span class="red">tests</span>" : [ "<span class="green">test</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"} {"<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"} {"<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"} ] ] } ]</p></div> </div></div> </div> <div class="sect2"> <h3 id="_re_execute_a_run">1.5. Re-execute a run</h3> <div class="paragraph"><p>URL: <base>/runs/:id</p></div> <div class="paragraph"><p>Method: PUT/PATCH</p></div> <div class="paragraph"><p>Request Params: {"testpatt" : "pattern"}</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", "<span class="red">target</span>" : "target2", "<span class="red">tests</span>" : [ "<span class="green">test</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"} {"<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"} {"<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"} ] ] } ]</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"} {"<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"} {"<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"} ] ]</p></div> </div></div> </div> <div class="sect2"> <h3 id="_re_execute_a_test_within_a_run">1.7. Re-execute a test within a run</h3> <div class="paragraph"><p>URL: <base>/runs/:id/tests/:id</p></div> <div class="paragraph"><p>Method: PUT/PATCH</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 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> </div> <div class="sect1"> <h2 id="_notes">2. Notes</h2> <div class="sectionbody"> |
︙ | ︙ | |||
861 862 863 864 865 866 867 | </div> </div> </div> <div id="footnotes"><hr></div> <div id="footer"> <div id="footer-text"> Version 1.0<br> | | | 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 | </div> </div> </div> <div id="footnotes"><hr></div> <div id="footer"> <div id="footer-text"> Version 1.0<br> Last updated 2016-08-03 14:52:22 PDT </div> </div> </body> </html> |
Modified docs/api.txt from [09c8728734] to [bcdb746fea].
︙ | ︙ | |||
32 33 34 35 36 37 38 | =================== { "[blue]#error#" : "[red]#Error message#" } =================== Get List of Runs ~~~~~~~~~~~~~~~~ | | | > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | > > > > > > > > > | > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | < < > | 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | =================== { "[blue]#error#" : "[red]#Error message#" } =================== Get List of Runs ~~~~~~~~~~~~~~~~ URL: <base>/runs Method: GET Filter Params: target, testpatt, offset, limit Response: ================== [ { "[red]#run_id#" : "1", "[red]#name#" : "runname1", "[red]#target#" : "target1", "[red]#tests#" : [ "[green]#test#": [ {"[blue]#id#": 1, "[blue]#name#":test1, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target1/runname1/test1", "[blue]#final_logf#": "megatest-rollup-test1.html", "[blue]#status#": "PASS#"} {"[blue]#id#": 2, "[blue]#name#":test2, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target1/runname1/test2", "[blue]#final_logf#": "megatest-rollup-test2.html", "[blue]#status#": "PASS"} {"[blue]#id#": 3, "[blue]#name#":test3, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target1/runname1/test3", "[blue]#final_logf#": "megatest-rollup-test3.html", "[blue]#status#": "PASS"} ] ] }, { "[red]#run_id#" : "2", "[red]#name#" : "runname2", "[red]#target#" : "target2", "[red]#tests#" : [ "[green]#test#: [ {"[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"} {"[blue]#id#": 5, "[blue]#name#":[blue]#test2#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test2", "[blue]#final_logf#": "megatest-rollup-test2.html", "[blue]#status#": "FAIL"} {"[blue]#id#": 6, "[blue]#name#":test3, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test3", "[blue]#final_logf#": "megatest-rollup-test3.html", "[blue]#status#": "PASS"} ] ] } ] ================== 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: If Error =================== { "[blue]#error#" : "[red]#Error message#" } =================== If Success returns the results of the run ================== [ { "[red]#run_id#" : "2", "[red]#name#" : "runname2", "[red]#target#" : "target2", "[red]#tests#" : [ "[green]#test#: [ {"[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"} {"[blue]#id#": 5, "[blue]#name#":[blue]#test2#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test2", "[blue]#final_logf#": "megatest-rollup-test2.html", "[blue]#status#": "FAIL"} {"[blue]#id#": 6, "[blue]#name#":test3, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test3", "[blue]#final_logf#": "megatest-rollup-test3.html", "[blue]#status#": "PASS"} ] ] } ] ================== Get perticular Run ~~~~~~~~~~~~~~~~~~~ URL: <base>/runs/:id Method: GET Filter Params: testpatt Response: ================== [ { "[red]#run_id#" : "2", "[red]#name#" : "runname2", "[red]#target#" : "target2", "[red]#tests#" : [ "[green]#test#": [ {"[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"} {"[blue]#id#": 5, "[blue]#name#":[blue]#test2#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test2", "[blue]#final_logf#": "megatest-rollup-test2.html", "[blue]#status#": "FAIL"} {"[blue]#id#": 6, "[blue]#name#":test3, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test3", "[blue]#final_logf#": "megatest-rollup-test3.html", "[blue]#status#": "PASS"} ] ] } ] ================== Re-execute a run ~~~~~~~~~~~~~~~~~ URL: <base>/runs/:id Method: PUT/PATCH Request Params: {"testpatt" : "pattern"} Response: ================== [ { "[red]#run_id#" : "2", "[red]#name#" : "runname2", "[red]#target#" : "target2", "[red]#tests#" : [ "[green]#test#": [ {"[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"} {"[blue]#id#": 5, "[blue]#name#":[blue]#test2#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test2", "[blue]#final_logf#": "megatest-rollup-test2.html", "[blue]#status#": "FAIL"} {"[blue]#id#": 6, "[blue]#name#":test3, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test3", "[blue]#final_logf#": "megatest-rollup-test3.html", "[blue]#status#": "PASS"} ] ] } ] ================== 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"} {"[blue]#id#": 5, "[blue]#name#":[blue]#test2#, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test2", "[blue]#final_logf#": "megatest-rollup-test2.html", "[blue]#status#": "FAIL"} {"[blue]#id#": 6, "[blue]#name#":test3, "[blue]#item_path#": "", "[blue]#shortdir#": "/temp/foo/bar/target2/runname2/test3", "[blue]#final_logf#": "megatest-rollup-test3.html", "[blue]#status#": "PASS"} ] ] ================== Re-execute a test within a run ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ URL: <base>/runs/:id/tests/:id Method: PUT/PATCH 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"} ================== 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"} ================== Notes ----- Misc ... |
︙ | ︙ |