Commit ddedb507069d8966f5f1b33316b1ed19de138bcb
1 parent
d867b5fd
Exists in
master
and in
108 other branches
layout for apidoc
Showing
8 changed files
with
10 additions
and
14 deletions
Show diff stats
php/rest/getDataset.php
... | ... | @@ -17,17 +17,15 @@ |
17 | 17 | * @apiParam {String} [timeFormat] Format of time in the data files. Two options: `ISO8601` and `UNIXTIME`. |
18 | 18 | * @apiParam {String} [gzip] `1` if the file must be compressed before delivery. |
19 | 19 | * |
20 | - * @apiParamExample | |
21 | - | |
22 | 20 | * @apiSuccess {String} success `true` |
23 | 21 | * @apiSuccess {String} dataFileURLs URL of the files matching the criteria. If the file is empty, there is no data |
24 | 22 | * matching these criteria. |
25 | 23 | * |
26 | - * @apiSuccessExample | |
24 | + * @apiSuccessExample Success-Response: | |
27 | 25 | * HTTP/1.1 200 OK |
28 | 26 | * http://amda.irap.omp.eu/AMDA/data/WSRESULT/getdataset_ace-imf-all_20130923T090000_20130924T130000.txt |
29 | 27 | * |
30 | - * @apiErrorExample | |
28 | + * @apiErrorExample Error-Response: | |
31 | 29 | * {"error":"Cannot find info file for dataset ace-imf-any"} |
32 | 30 | |
33 | 31 | */ | ... | ... |
php/rest/getObsDataTree.php
... | ... | @@ -14,7 +14,7 @@ |
14 | 14 | * HTTP/1.1 200 OK |
15 | 15 | * http://amda.irap.omp.eu/AMDA/data/WSRESULT/obsdatatree_impex_20180727_AmdaLocalDataBaseParameters.xml |
16 | 16 | * |
17 | - * @apiErrorExample | |
17 | + * @apiErrorExample Error-Response: | |
18 | 18 | * {"error":"No Amda Local DataBase Parameters description file"} |
19 | 19 | */ |
20 | 20 | ... | ... |
php/rest/getOrbites.php
... | ... | @@ -37,7 +37,7 @@ |
37 | 37 | * HTTP/1.1 200 OK |
38 | 38 | * http://amda.irap.omp.eu/AMDA//data/WSRESULT/getorbites_ace_xyz_gse_km_20130923T090000_20130924T130000.txt |
39 | 39 | * |
40 | - * @apiErrorExample | |
40 | + * @apiErrorExample Error-Response: | |
41 | 41 | * {"error":"Cannot find orbit data for ACE1 for 2013-09-23T09:00-2013-09-24T13:00 in km GSE( - )"} |
42 | 42 | */ |
43 | 43 | ... | ... |
php/rest/getParameter.php
... | ... | @@ -19,17 +19,15 @@ |
19 | 19 | * @apiParam {String} [timeFormat] Format of time in the data files. Two options: `ISO8601` and `UNIXTIME`. |
20 | 20 | * @apiParam {String} [gzip] `1` if the file must be compressed before delivery. |
21 | 21 | * |
22 | - * @apiParamExample | |
23 | - | |
24 | 22 | * @apiSuccess {String} success `true` |
25 | 23 | * @apiSuccess {String} dataFileURLs URL of the files matching the criteria. If the file is empty, there is no data |
26 | 24 | * matching these criteria. |
27 | 25 | * |
28 | - * @apiSuccessExample | |
26 | + * @apiSuccessExample Success-Response: | |
29 | 27 | * HTTP/1.1 200 OK |
30 | 28 | * http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20130923T090000_20130924T130000.txt |
31 | 29 | * |
32 | - * @apiErrorExample | |
30 | + * @apiErrorExample Error-Response: | |
33 | 31 | * {"error":"Exception detected : Cannot find parameter local file c1_hia_dens1"} |
34 | 32 | |
35 | 33 | */ | ... | ... |
php/rest/getParameterList.php
... | ... | @@ -17,7 +17,7 @@ |
17 | 17 | * HTTP/1.1 200 OK |
18 | 18 | * http://amda.irap.omp.eu/AMDA//data/WSRESULT/parameterlist_impex_20180912_AmdaLocalDataBaseParameters.xml |
19 | 19 | * |
20 | - * @apiErrorExample | |
20 | + * @apiErrorExample Error-Response: | |
21 | 21 | * {"error":"Login procedure failed for impex1 : Check your password"} |
22 | 22 | */ |
23 | 23 | ... | ... |
php/rest/getStatus.php
... | ... | @@ -18,7 +18,7 @@ |
18 | 18 | * {"success":true,"status":"in progress"} |
19 | 19 | * {"success":true,"status":"done","dataFileURLs":"http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20010923T090000_20130924T130000.txt"} |
20 | 20 | * |
21 | - * @apiErrorExample | |
21 | + * @apiErrorExample Error-Response: | |
22 | 22 | * {"success":false,"message":"You must provide a job id"} |
23 | 23 | */ |
24 | 24 | ... | ... |
php/rest/getTimeTable.php
... | ... | @@ -17,7 +17,7 @@ |
17 | 17 | * HTTP/1.1 200 OK |
18 | 18 | * http://amda.irap.omp.eu/AMDA/data/WSRESULT/timetable_impex_20180912_sharedtimeTable_0.xml |
19 | 19 | * |
20 | - * @apiErrorExample | |
20 | + * @apiErrorExample Error-Response: | |
21 | 21 | * {"error":"No such table sharedtimeTable_100 for user impex"} |
22 | 22 | */ |
23 | 23 | ... | ... |
php/rest/getTimeTablesList.php