Parcourir la source

Updated documentation

rigwild il y a 5 ans
Parent
commit
f23f03c39c
2 fichiers modifiés avec 2 ajouts et 2 suppressions
  1. 1 1
      server/routes/getImage.js
  2. 1 1
      server/routes/getImageExtracts.js

+ 1 - 1
server/routes/getImage.js

@@ -18,7 +18,7 @@ const router = express.Router()
  * @apiDescription Get an image from a scene with the required quality
  *
  * @apiParam {String} sceneName The selected scene
- * @apiParam {Number|"min"|"max"|"median"} imageQuality The required quality of the image
+ * @apiParam {String="min","max","median", "any integer"} imageQuality The required quality of the image (can be an integer, `min`, `max` or `median`)
  * @apiParam {Boolean} [nearestQuality=false] if selected quality not availabie, select the nearest one
  *
  * @apiExample Usage example

+ 1 - 1
server/routes/getImageExtracts.js

@@ -21,7 +21,7 @@ const router = express.Router()
  * @apiDescription Get an image from a scene with the required quality and cut it with the requested configuration
  *
  * @apiParam {String} sceneName The selected scene
- * @apiParam {Number|"min"|"max"|"median"} imageQuality The required quality of the image
+ * @apiParam {String="min","max","median", "any integer"} imageQuality The required quality of the image (can be an integer, `min`, `max` or `median`)
  * @apiParam {Number} horizontalExtractCount The amount of extracts for the horizontal axis
  * @apiParam {Number} verticalExtractCount The amount of extracts for the vertical axis
  * @apiParam {Boolean} [nearestQuality=false] if selected quality not availabie, select the nearest one