diff --git a/php/rest/getDataset.php b/php/rest/getDataset.php index 0323d12..7ce4cba 100644 --- a/php/rest/getDataset.php +++ b/php/rest/getDataset.php @@ -17,17 +17,15 @@ * @apiParam {String} [timeFormat] Format of time in the data files. Two options: `ISO8601` and `UNIXTIME`. * @apiParam {String} [gzip] `1` if the file must be compressed before delivery. * - * @apiParamExample - * @apiSuccess {String} success `true` * @apiSuccess {String} dataFileURLs URL of the files matching the criteria. If the file is empty, there is no data * matching these criteria. * - * @apiSuccessExample + * @apiSuccessExample Success-Response: * HTTP/1.1 200 OK * http://amda.irap.omp.eu/AMDA/data/WSRESULT/getdataset_ace-imf-all_20130923T090000_20130924T130000.txt * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error":"Cannot find info file for dataset ace-imf-any"} */ diff --git a/php/rest/getObsDataTree.php b/php/rest/getObsDataTree.php index fcb7f98..6f42fc6 100644 --- a/php/rest/getObsDataTree.php +++ b/php/rest/getObsDataTree.php @@ -14,7 +14,7 @@ * HTTP/1.1 200 OK * http://amda.irap.omp.eu/AMDA/data/WSRESULT/obsdatatree_impex_20180727_AmdaLocalDataBaseParameters.xml * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error":"No Amda Local DataBase Parameters description file"} */ diff --git a/php/rest/getOrbites.php b/php/rest/getOrbites.php index 71141ea..a4c7bcb 100644 --- a/php/rest/getOrbites.php +++ b/php/rest/getOrbites.php @@ -37,7 +37,7 @@ * HTTP/1.1 200 OK * http://amda.irap.omp.eu/AMDA//data/WSRESULT/getorbites_ace_xyz_gse_km_20130923T090000_20130924T130000.txt * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error":"Cannot find orbit data for ACE1 for 2013-09-23T09:00-2013-09-24T13:00 in km GSE( - )"} */ diff --git a/php/rest/getParameter.php b/php/rest/getParameter.php index 943f6c7..3947be6 100644 --- a/php/rest/getParameter.php +++ b/php/rest/getParameter.php @@ -19,17 +19,15 @@ * @apiParam {String} [timeFormat] Format of time in the data files. Two options: `ISO8601` and `UNIXTIME`. * @apiParam {String} [gzip] `1` if the file must be compressed before delivery. * - * @apiParamExample - * @apiSuccess {String} success `true` * @apiSuccess {String} dataFileURLs URL of the files matching the criteria. If the file is empty, there is no data * matching these criteria. * - * @apiSuccessExample + * @apiSuccessExample Success-Response: * HTTP/1.1 200 OK * http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20130923T090000_20130924T130000.txt * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error":"Exception detected : Cannot find parameter local file c1_hia_dens1"} */ diff --git a/php/rest/getParameterList.php b/php/rest/getParameterList.php index af4174a..a0d7cd8 100644 --- a/php/rest/getParameterList.php +++ b/php/rest/getParameterList.php @@ -17,7 +17,7 @@ * HTTP/1.1 200 OK * http://amda.irap.omp.eu/AMDA//data/WSRESULT/parameterlist_impex_20180912_AmdaLocalDataBaseParameters.xml * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error":"Login procedure failed for impex1 : Check your password"} */ diff --git a/php/rest/getStatus.php b/php/rest/getStatus.php index 6f84bb6..a145a02 100644 --- a/php/rest/getStatus.php +++ b/php/rest/getStatus.php @@ -18,7 +18,7 @@ * {"success":true,"status":"in progress"} * {"success":true,"status":"done","dataFileURLs":"http://amda.irap.omp.eu/AMDA/data/WSRESULT/getparameter_c1_hia_dens_20010923T090000_20130924T130000.txt"} * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"success":false,"message":"You must provide a job id"} */ diff --git a/php/rest/getTimeTable.php b/php/rest/getTimeTable.php index ab6b212..0df6e62 100644 --- a/php/rest/getTimeTable.php +++ b/php/rest/getTimeTable.php @@ -17,7 +17,7 @@ * HTTP/1.1 200 OK * http://amda.irap.omp.eu/AMDA/data/WSRESULT/timetable_impex_20180912_sharedtimeTable_0.xml * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error":"No such table sharedtimeTable_100 for user impex"} */ diff --git a/php/rest/getTimeTablesList.php b/php/rest/getTimeTablesList.php index ba2b5a7..a0e3953 100644 --- a/php/rest/getTimeTablesList.php +++ b/php/rest/getTimeTablesList.php @@ -18,7 +18,7 @@ * HTTP/1.1 200 OK * http://amda.irap.omp.eu/data/WSRESULT/timetables_impex_20180905.xml * - * @apiErrorExample + * @apiErrorExample Error-Response: * {"error": "Workspace Error : Cannot load TimeTable list for userID"} */ -- libgit2 0.21.2