fix(docs): wrong arguments in models' getDevice request (#310)

Fixes incorrect arguments in the request to retrieve a device's model. --------- Co-authored-by: Rémi <97107909+GuinierRemi@users.noreply.github.com> Co-authored-by: Théo Dislay <44380410+tdislay@users.noreply.github.com>
kuzzleio · Jul 24, 2023 · 028c65c · 028c65c
1 parent 487c1e8
commit 028c65c
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 22 deletions.
diff --git a/doc/2/controllers/assets/get-measures/index.md b/doc/2/controllers/assets/get-measures/index.md
@@ -2,12 +2,12 @@
 code: true
 type: page
 title: getMeasures
-description: Retrieves measure from an asset
+description: Retrieves measures from an asset
 ---
 
 # getMeasures
 
-Retrieves measure from an asset.
+Retrieves measures from an asset.
 
 ---
 
@@ -51,13 +51,12 @@ Method: GET or POST
 ## Arguments
 
 - `engineId`: engine id
-- `_id`: asset id
-  ISO_8601
-- `from`: paginates search results by defining the offset from the first result you want to fetch. Usually used with the `size` argument
-- `size`: set the maximum number of documents returned per result page
-- `startAt`: beginning of time range (ISO 8601)
-- `endAt`: end of time range (ISO 8601)
-- `type`: measure type
+- `_id`: asset id (ISO_8601)
+- `from` (optional): paginates search results by defining the offset from the first result you want to fetch. Usually used with the `size` argument
+- `size` (optional): set the maximum number of documents returned per result page
+- `startAt` (optional): beginning of time range (ISO 8601)
+- `endAt` (optional): end of time range (ISO 8601)
+- `type` (optional): measure type
 
 ## Body properties
 
@@ -73,7 +72,7 @@ Method: GET or POST
   "status": 200,
   "error": null,
   "controller": "device-manager/assets",
-  "action": "search",
+  "action": "getMeasures",
   "requestId": "<unique request identifier>",
   "result": {
     "measures": [

diff --git a/doc/2/controllers/models/get-asset/index.md b/doc/2/controllers/models/get-asset/index.md
@@ -24,10 +24,10 @@ Method: GET
 
 ```js
 {
-  "controller": "device-manager/assets",
+  "controller": "device-manager/models",
   "action": "getAsset",
   "engineGroup": "<engineGroup>",
-  "_id": "<modelId>"
+  "model": "<asset model>"
 }
 ```
 
@@ -36,7 +36,7 @@ Method: GET
 ## Arguments
 
 - `engineGroup`: name of the engine group
-- `_id`: asset model id
+- `model`: asset model
 
 ---
 

diff --git a/doc/2/controllers/models/get-device/index.md b/doc/2/controllers/models/get-device/index.md
@@ -7,7 +7,7 @@ description: Gets an device model
 
 # getDevice
 
-Gets an device model.
+Gets a device model.
 
 ---
 
@@ -16,7 +16,7 @@ Gets an device model.
 ### HTTP
 
 ```http
-URL: http://kuzzle:7512/_/device-manager/models/device/:_id
+URL: http://kuzzle:7512/_/device-manager/models/device/:id
 Method: GET
 ```
 
@@ -26,17 +26,15 @@ Method: GET
 {
   "controller": "device-manager/models",
   "action": "getDevice",
-  "engineId": "<engineId>",
-  "_id": "<modelId>"
+  "model": "<device model>"
 }
 ```
 
 ---
 
 ## Arguments
 
-- `engineId`: engine id
-- `_id`: device model id
+- `model`: device model
 
 ---
 

diff --git a/doc/2/controllers/models/get-measure/index.md b/doc/2/controllers/models/get-measure/index.md
@@ -26,16 +26,15 @@ Method: GET
 {
   "controller": "device-manager/models",
   "action": "getMeasure",
-  "_id": "<modelId>"
+  "type": "<measure type>"
 }
 ```
 
 ---
 
 ## Arguments
 
-- `engineId`: engine id
-- `_id`: measure model id
+- `type`: measure type
 
 ---