Browse Source

Fixed documentation uris + readme links

rigwild 1 year ago
parent
commit
2308d4e863

+ 8 - 2
README.md

@@ -9,8 +9,14 @@ git clone https://gogs.univ-littoral.fr/Prise3D/SIN3D.git
 cd SIN3D
 ```
 
+## Application
+See [https://diran.univ-littoral.fr](https://diran.univ-littoral.fr)
+
 ## Developer documentation
-See [`/DOCUMENTATION`](./DOCUMENTATION).
+See [`/DOCUMENTATION`](./DOCUMENTATION)
+
+## API documentation
+See [https://diran.univ-littoral.fr/doc](https://diran.univ-littoral.fr/doc)
 
 ## Data extraction
 You can use the [SIN3D-data-extract](https://gogs.univ-littoral.fr/Prise3D/SIN3D-data-extract) library to easily extract data from this application database.
@@ -163,7 +169,7 @@ The `docker-compose` script will automatically run tests. Use the following comm
 yarn test
 ```
 
-## API Documentation
+## Generate API documentation
 The `docker-compose` script will automatically build the API documentation. Use the following command to build it by hand.
 ```sh
 yarn doc

+ 3 - 3
package.json

@@ -1,6 +1,6 @@
 {
   "name": "sin3d",
-  "description": "Synthesis Image Noise Detection on Distributed Data",
+  "description": "Synthesis Image Noise Detection on Distributed Data : A web app to collect data on noise detection by humans on images.",
   "version": "0.3.0",
   "private": true,
   "keywords": [
@@ -95,8 +95,8 @@
     "not ie <= 8"
   ],
   "apidoc": {
-    "url": "http://diran.univ-littoral.fr/api",
-    "sampleUrl": "http://diran.univ-littoral.fr/api",
+    "url": "https://diran.univ-littoral.fr/api",
+    "sampleUrl": "https://diran.univ-littoral.fr/api",
     "template": {
       "forceLanguage": "en"
     }

+ 1 - 1
server/routes/dataCollect.js

@@ -26,7 +26,7 @@ const router = express.Router()
  * @apiParam {Object} screen Screen data, `window.screen` @see https://developer.mozilla.org/en-US/docs/Web/API/Screen
  *
  * @apiExample Usage example
- * curl -i -L -H "Content-Type: application/json" -X POST "http://diran.univ-littoral.fr/api/dataCollect" -d {"uuid":"test","userId":"rigwild","experimentId":"expe-test","screen":{"width":1920,"height":1024}}
+ * curl -i -L -H "Content-Type: application/json" -X POST "https://diran.univ-littoral.fr/api/dataCollect" -d {"uuid":"test","userId":"rigwild","experimentId":"expe-test","screen":{"width":1920,"height":1024}}
  *
  * @apiSuccessExample {string} Success response example
  * HTTP/1.1 200 OK /api/dataCollect

+ 1 - 1
server/routes/experimentCollect.js

@@ -21,7 +21,7 @@ const router = express.Router()
  * @apiParam {any} Any data that needs to be stored
  *
  * @apiExample Usage example
- * curl -i -L -H "Content-Type: application/json" -X POST "http://diran.univ-littoral.fr/api/experimentCollect" -d {"msgId":"test","msg":{}}
+ * curl -i -L -H "Content-Type: application/json" -X POST "https://diran.univ-littoral.fr/api/experimentCollect" -d {"msgId":"test","msg":{}}
  *
  * @apiSuccessExample {string} Success response example
  * HTTP/1.1 204 OK /api/experimentCollect

+ 1 - 1
server/routes/getImage.js

@@ -23,7 +23,7 @@ const router = express.Router()
  * @apiParam {Boolean} [nearestQuality=false] if selected quality not availabie, select the nearest one
  *
  * @apiExample Usage example
- * curl -i -L -X GET "http://diran.univ-littoral.fr/api/getImage?sceneName=bathroom&imageQuality=200"
+ * curl -i -L -X GET "https://diran.univ-littoral.fr/api/getImage?sceneName=bathroom&imageQuality=200"
  *
  * @apiSuccess {Object} data Informations on the image
  * @apiSuccess {String} data.link Path to the image

+ 1 - 1
server/routes/getImageExtracts.js

@@ -27,7 +27,7 @@ const router = express.Router()
  * @apiParam {Boolean} [nearestQuality=false] if selected quality not availabie, select the nearest one
  *
  * @apiExample Usage example
- * curl -i -L -X GET "http://diran.univ-littoral.fr/api/getImageExtracts?sceneName=bathroom&imageQuality=200&horizontalExtractCount=1&verticalExtractCount=2"
+ * curl -i -L -X GET "https://diran.univ-littoral.fr/api/getImageExtracts?sceneName=bathroom&imageQuality=200&horizontalExtractCount=1&verticalExtractCount=2"
  *
  * @apiSuccess {Object} data Path to the extracted images
  * @apiSuccess {String[]} data.extracts Path to the extracted images

+ 1 - 1
server/routes/listSceneQualities.js

@@ -16,7 +16,7 @@ const router = express.Router()
  * @apiParam {String} sceneName The selected scene
  *
  * @apiExample Usage example
- * curl -i -L -X GET "http://diran.univ-littoral.fr/api/listSceneQualities?sceneName=bathroom"
+ * curl -i -L -X GET "https://diran.univ-littoral.fr/api/listSceneQualities?sceneName=bathroom"
  *
  * @apiSuccess {Number[]} data List of available qualities
  * @apiSuccessExample {json} Success response example

+ 1 - 1
server/routes/listScenes.js

@@ -19,7 +19,7 @@ const router = express.Router()
  * @apiSampleRequest /listScenes
  *
  * @apiExample Usage example
- * curl -i -L -X GET "http://diran.univ-littoral.fr/api/listScenes"
+ * curl -i -L -X GET "https://diran.univ-littoral.fr/api/listScenes"
  *
  * @apiSuccess {String[]} data List of available scenes
  * @apiSuccessExample {json} Success response example

+ 1 - 1
server/routes/ping.js

@@ -13,7 +13,7 @@ const router = express.Router()
  * @apiDescription Check if the API is up
  *
  * @apiExample Usage example
- * curl -i -L -X GET "http://diran.univ-littoral.fr/api/ping"
+ * curl -i -L -X GET "https://diran.univ-littoral.fr/api/ping"
  *
  * @apiSuccessExample {string} Success response example
  * HTTP/1.1 200 OK /api/ping