From 53e977895fbf5820a32c014be69ad7c5db99a5ce Mon Sep 17 00:00:00 2001 From: Marco Emilio Poleggi <marco-emilio.poleggi@hesge.ch> Date: Mon, 9 Sep 2019 17:55:18 +0200 Subject: [PATCH] ApiDoc updated --- apidoc.json | 2 +- doc/api_data.js | 26 +++++++++++++------------- doc/api_data.json | 26 +++++++++++++------------- doc/api_project.js | 4 ++-- doc/api_project.json | 4 ++-- 5 files changed, 31 insertions(+), 31 deletions(-) diff --git a/apidoc.json b/apidoc.json index cd6270c..b640fe6 100644 --- a/apidoc.json +++ b/apidoc.json @@ -2,5 +2,5 @@ "name": "Smart Building", "description": "A Flask-based server for hepia's LSDS IoT Z-Wave Lab", "title": "Smart Building REST API", - "url" : "https://githepia.hesge.ch/lsds/Smart-building" + "url" : "http://192.168.1.2:5000" } diff --git a/doc/api_data.js b/doc/api_data.js index 067c57d..0212d65 100644 --- a/doc/api_data.js +++ b/doc/api_data.js @@ -68,7 +68,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"dimmer\": 4,\n \"type\": \"Level\",\n \"updateTime\": 1454682996,\n \"value\": 50\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"dimmer\": 4, \n \"type\": \"Level\", \n \"updateTime\": 1454682996, \n \"value\": 50\n}", "type": "json" } ] @@ -113,7 +113,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"4\": \"ZE27\",\n \"6\": \"ZE27\"\n}", + "content": "{ \n \"4\": \"ZE27\",\n \"6\": \"ZE27\"\n}", "type": "json" } ] @@ -442,7 +442,7 @@ define({ "api": [ "examples": [ { "title": "Request-Exemple :", - "content": "{\n 'Group_Interval' : '224',\n 'Group_Reports' : '480',\n 'Wake-up_Interval' : '480'\n}", + "content": "{\n 'Group_Interval' : '480',\n 'Group_Reports' : '241',\n 'Wake-up_Interval' : '480'\n}", "type": "json" } ] @@ -606,7 +606,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"battery\",\n \"updateTime\": 1454684168,\n \"value\": 100\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"battery\", \n \"updateTime\": 1454684168, \n \"value\": 100\n}", "type": "json" } ] @@ -748,7 +748,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"1\": \"Z-Stick Gen5\",\n \"2\": \"MultiSensor 6\",\n \"3\": \"ZE27\"\n}", + "content": "{\n \"1\": \"Z-Stick Gen5\", \n \"2\": \"MultiSensor 6\",\n \"3\": \"ZE27\" \n}", "type": "json" } ] @@ -1083,7 +1083,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"battery\": 100,\n \"controller\": \"Pi lab1\",\n \"humidity\": 22,\n \"location\": \"Room A401\",\n \"luminance\": 60,\n \"motion\": false,\n \"sensor\": 2,\n \"temperature\": 30.0,\n \"updateTime\": 1454682568\n}", + "content": "{\n \"battery\": 100, \n \"controller\": \"Pi lab1\", \n \"humidity\": 22, \n \"location\": \"Room A401\",\n \"luminance\": 60, \n \"motion\": false, \n \"sensor\": 2, \n \"temperature\": 30.0, \n \"updateTime\": 1454682568\n}", "type": "json" } ] @@ -1176,7 +1176,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"relative humidity\",\n \"updateTime\": 1454682996,\n \"value\": 21\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"relative humidity\", \n \"updateTime\": 1454682996, \n \"value\": 21\n}", "type": "json" } ] @@ -1269,7 +1269,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"luminance\",\n \"updateTime\": 1454682996,\n \"value\": 49\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"luminance\", \n \"updateTime\": 1454682996, \n \"value\": 49\n}", "type": "json" } ] @@ -1362,7 +1362,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"sensor\",\n \"updateTime\": 1454682996,\n \"value\": true\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"sensor\", \n \"updateTime\": 1454682996, \n \"value\": true\n}", "type": "json" } ] @@ -1407,7 +1407,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"2\": \"MultiSensor 6\",\n \"3\": \"MultiSensor 6\"\n}", + "content": "{ \n \"2\": \"MultiSensor 6\",\n \"3\": \"MultiSensor 6\"\n}", "type": "json" } ] @@ -1486,7 +1486,7 @@ define({ "api": [ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"temperature\",\n \"updateTime\": 1454682568,\n \"value\": 30.4\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"temperature\", \n \"updateTime\": 1454682568, \n \"value\": 30.4\n}", "type": "json" } ] @@ -1534,8 +1534,8 @@ define({ "api": [ "url": "", "version": "0.0.0", "filename": "./doc/main.js", - "group": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_Building_Complete_doc_main_js", - "groupTitle": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_Building_Complete_doc_main_js", + "group": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_building_doc_main_js", + "groupTitle": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_building_doc_main_js", "name": "" } ] }); diff --git a/doc/api_data.json b/doc/api_data.json index 5297193..bfa609e 100644 --- a/doc/api_data.json +++ b/doc/api_data.json @@ -68,7 +68,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"dimmer\": 4,\n \"type\": \"Level\",\n \"updateTime\": 1454682996,\n \"value\": 50\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"dimmer\": 4, \n \"type\": \"Level\", \n \"updateTime\": 1454682996, \n \"value\": 50\n}", "type": "json" } ] @@ -113,7 +113,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"4\": \"ZE27\",\n \"6\": \"ZE27\"\n}", + "content": "{ \n \"4\": \"ZE27\",\n \"6\": \"ZE27\"\n}", "type": "json" } ] @@ -442,7 +442,7 @@ "examples": [ { "title": "Request-Exemple :", - "content": "{\n 'Group_Interval' : '224',\n 'Group_Reports' : '480',\n 'Wake-up_Interval' : '480'\n}", + "content": "{\n 'Group_Interval' : '480',\n 'Group_Reports' : '241',\n 'Wake-up_Interval' : '480'\n}", "type": "json" } ] @@ -606,7 +606,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"battery\",\n \"updateTime\": 1454684168,\n \"value\": 100\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"battery\", \n \"updateTime\": 1454684168, \n \"value\": 100\n}", "type": "json" } ] @@ -748,7 +748,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"1\": \"Z-Stick Gen5\",\n \"2\": \"MultiSensor 6\",\n \"3\": \"ZE27\"\n}", + "content": "{\n \"1\": \"Z-Stick Gen5\", \n \"2\": \"MultiSensor 6\",\n \"3\": \"ZE27\" \n}", "type": "json" } ] @@ -1083,7 +1083,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"battery\": 100,\n \"controller\": \"Pi lab1\",\n \"humidity\": 22,\n \"location\": \"Room A401\",\n \"luminance\": 60,\n \"motion\": false,\n \"sensor\": 2,\n \"temperature\": 30.0,\n \"updateTime\": 1454682568\n}", + "content": "{\n \"battery\": 100, \n \"controller\": \"Pi lab1\", \n \"humidity\": 22, \n \"location\": \"Room A401\",\n \"luminance\": 60, \n \"motion\": false, \n \"sensor\": 2, \n \"temperature\": 30.0, \n \"updateTime\": 1454682568\n}", "type": "json" } ] @@ -1176,7 +1176,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"relative humidity\",\n \"updateTime\": 1454682996,\n \"value\": 21\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"relative humidity\", \n \"updateTime\": 1454682996, \n \"value\": 21\n}", "type": "json" } ] @@ -1269,7 +1269,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"luminance\",\n \"updateTime\": 1454682996,\n \"value\": 49\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"luminance\", \n \"updateTime\": 1454682996, \n \"value\": 49\n}", "type": "json" } ] @@ -1362,7 +1362,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"sensor\",\n \"updateTime\": 1454682996,\n \"value\": true\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"sensor\", \n \"updateTime\": 1454682996, \n \"value\": true\n}", "type": "json" } ] @@ -1407,7 +1407,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"2\": \"MultiSensor 6\",\n \"3\": \"MultiSensor 6\"\n}", + "content": "{ \n \"2\": \"MultiSensor 6\",\n \"3\": \"MultiSensor 6\"\n}", "type": "json" } ] @@ -1486,7 +1486,7 @@ "examples": [ { "title": "Example of result in case of success:", - "content": "{\n \"controller\": \"Pi lab1\",\n \"location\": \"Room A401\",\n \"sensor\": 2,\n \"type\": \"temperature\",\n \"updateTime\": 1454682568,\n \"value\": 30.4\n}", + "content": "{\n \"controller\": \"Pi lab1\", \n \"location\": \"Room A401\",\n \"sensor\": 2, \n \"type\": \"temperature\", \n \"updateTime\": 1454682568, \n \"value\": 30.4\n}", "type": "json" } ] @@ -1534,8 +1534,8 @@ "url": "", "version": "0.0.0", "filename": "./doc/main.js", - "group": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_Building_Complete_doc_main_js", - "groupTitle": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_Building_Complete_doc_main_js", + "group": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_building_doc_main_js", + "groupTitle": "_home_marcoep_data_nextcloud_switch_edu_id_Institution_HEPIA_labo_IoT_Master_Module_code_nosync_Smart_building_doc_main_js", "name": "" } ] diff --git a/doc/api_project.js b/doc/api_project.js index de1448b..b3b57eb 100644 --- a/doc/api_project.js +++ b/doc/api_project.js @@ -3,13 +3,13 @@ define({ "version": "0.0.0", "description": "A Flask-based server for hepia's LSDS IoT Z-Wave Lab", "title": "Smart Building REST API", - "url": "https://githepia.hesge.ch/lsds/Smart-building", + "url": "http://192.168.1.2:5000", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2019-09-09T13:44:48.136Z", + "time": "2019-09-09T15:54:26.397Z", "url": "http://apidocjs.com", "version": "0.17.7" } diff --git a/doc/api_project.json b/doc/api_project.json index 3e39026..26b9f0d 100644 --- a/doc/api_project.json +++ b/doc/api_project.json @@ -3,13 +3,13 @@ "version": "0.0.0", "description": "A Flask-based server for hepia's LSDS IoT Z-Wave Lab", "title": "Smart Building REST API", - "url": "https://githepia.hesge.ch/lsds/Smart-building", + "url": "http://192.168.1.2:5000", "sampleUrl": false, "defaultVersion": "0.0.0", "apidoc": "0.3.0", "generator": { "name": "apidoc", - "time": "2019-09-09T13:44:48.136Z", + "time": "2019-09-09T15:54:26.397Z", "url": "http://apidocjs.com", "version": "0.17.7" } -- GitLab