Feat/add m detach #33
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| code: true | ||
| type: page | ||
| title: mAttach | ||
| description: Attach multiple sensors to multiple tenants index | ||
| --- | ||
|
|
||
| # mAttachTenant | ||
|
|
||
| Attach multiple sensors to multiple tenants. | ||
|
|
||
| The sensor document will be duplicated inside the tenant "sensors" collection. | ||
|
|
||
| --- | ||
|
|
||
| ## Query Syntax | ||
|
|
||
| ### HTTP | ||
|
|
||
| ``` http | ||
| URL: http://kuzzle:7512/_/device-manager/sensors/_mAttach | ||
| Method: PUT | ||
| Body: | ||
| ``` | ||
|
|
||
| ``` js | ||
| { | ||
| // Using JSON | ||
| "records" [{ | ||
| "tenantId": "tenant-kuzzle", | ||
| "sensorId": "test-id" | ||
| }], | ||
| // Using CSV syntax | ||
| "csv": "tenant,id\ntenant-kuzzle,test-id" | ||
| } | ||
| ``` | ||
|
|
||
| ### Other protocols | ||
|
|
||
| ``` js | ||
| { | ||
| "controller": "device-manager/sensor", | ||
| "action": "mAttach", | ||
| "body": { | ||
| // Using JSON | ||
| "records" [{ | ||
| "tenantId": "tenant-kuzzle", | ||
| "sensorId": "test-id" | ||
| }], | ||
| // Using CSV syntax | ||
| "csv": "tenantId,sensorId\ntenant-kuzzle,test-id", | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Body properties | ||
|
|
||
| Body properties, must contain at least one of | ||
|
|
||
| - `records`: an array of object containing `tenantId` and `sensorId` | ||
| - `csv`: a csv syntax compatible containing at least this two headers `tenantId,sensorId` with their corresponding values | ||
| - `strict`: a boolean value that indicate if the process should fail at first error | ||
|
|
||
| --- | ||
|
|
||
| ### Optional: | ||
|
|
||
| * `refresh`: if set to `wait_for`, Kuzzle will not respond until the documents are indexed | ||
|
|
||
| --- | ||
|
|
||
| ## Response | ||
|
|
||
| ``` js | ||
| { | ||
| "status": 200, | ||
| "error": null, | ||
| "controller": "device-manager/sensor", | ||
| "action": "mAttach", | ||
| "requestId": "<unique request identifier>", | ||
| "result": { | ||
| "errors": [], | ||
| "successes": [] | ||
| } | ||
| } | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,89 @@ | ||||||
| --- | ||||||
| code: true | ||||||
| type: page | ||||||
| title: detach | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| description: Detach multiple sensors from multiple tenants | ||||||
| --- | ||||||
|
|
||||||
| # detach | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| Detach multiple sensors from multiple tenants. | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Query Syntax | ||||||
|
|
||||||
| ### HTTP | ||||||
|
|
||||||
| ``` http | ||||||
| URL: http://kuzzle:7512/_/device-manager/device-manager/sensors/_mDetach[?refresh=wait_for] | ||||||
| Method: PUT | ||||||
| Body: | ||||||
| ``` | ||||||
|
|
||||||
| ``` js | ||||||
| { | ||||||
| // Using JSON | ||||||
| "records" [{ | ||||||
|
There was a problem hiding this comment. The |
||||||
| "tenant": "tenant-kuzzle", | ||||||
| "id": "test-id" | ||||||
| }], | ||||||
| // Using CSV syntax | ||||||
| "csv": "tenant,id\ntenant-kuzzle,test-id" | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| ### Other protocols | ||||||
|
|
||||||
| ``` js | ||||||
| { | ||||||
| "controller": "device-manager/sensor", | ||||||
| "action": "mAttachTenant", | ||||||
| "body": { | ||||||
| // Using JSON | ||||||
| "records" [{ | ||||||
| "tenantId": "tenant-kuzzle", | ||||||
| "sensorId": "test-id" | ||||||
| }], | ||||||
| // Using CSV syntax | ||||||
| "csv": "tenantId,sensorId\ntenant-kuzzle,test-id", | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Body properties | ||||||
|
|
||||||
| Body properties, must contain at least one of | ||||||
|
|
||||||
| * `records`: an array of object containing `tenantId` and `sensorId` | ||||||
| * `csv`: a csv syntax compatible containing at least this two headers `tenantId,sensorId` with their corresponding values | ||||||
| * `strict`: a boolean value that indicate if the process should fail at first error | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Arguments | ||||||
|
|
||||||
| ### Optional: | ||||||
|
|
||||||
| * `refresh`: if set to `wait_for`, Kuzzle will not respond until the documents are indexed | ||||||
|
|
||||||
| --- | ||||||
|
|
||||||
| ## Response | ||||||
|
|
||||||
| ``` js | ||||||
| { | ||||||
| "status": 200, | ||||||
| "error": null, | ||||||
| "index": "<index>", | ||||||
| "controller": "device-manager/sensor", | ||||||
| "action": "mDetach", | ||||||
| "requestId": "<unique request identifier>", | ||||||
| "result": { | ||||||
| "errors": [], | ||||||
| "successes": [] | ||||||
| } | ||||||
| } | ||||||
| ``` | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| const sensors = []; | ||
| for (let i = 0; i < 50; i++) { | ||
| sensors.push({ index: { _id: `DummyTemp_detached-${i}` } }); | ||
| sensors.push({ | ||
| reference: 'detached', | ||
| model: `DummyTemp-${i}`, | ||
| measures: {}, | ||
| metadata: {}, | ||
| tenantId: null, | ||
| assetId: null | ||
| }); | ||
| } | ||
|
|
||
| const sensorsTests = sensors.filter(test => test.model); | ||
|
|
||
| module.exports = { sensors, sensorsTests }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file should be name
m-detach