Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API documentation #931

Merged
merged 1 commit into from
Jul 18, 2022
Merged

Update API documentation #931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 12 additions & 6 deletions open-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ None
> 200 Response

```
{"deviceID":"","deviceName":"string","modelId":"string","imageUrl":"http://example.com","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","tags":{"property1":"string","property2":"string"}}
{"deviceID":"","deviceName":"string","modelId":"string","imageUrl":"http://example.com","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","tags":{"property1":"string","property2":"string"},"isLoraWan":true}
```

```json
Expand All @@ -534,7 +534,8 @@ None
"tags": {
"property1": "string",
"property2": "string"
}
},
"isLoraWan": true
}
```

Expand Down Expand Up @@ -2077,7 +2078,7 @@ None
> 200 Response

```
{"deviceName":"string","modelId":"string","imageUrl":"http://example.com","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","tags":{"property1":"string","property2":"string"},"deviceID":"","classType":"A","useOTAA":true,"appEUI":"string","sensorDecoder":"string","gatewayID":"string","downlink":true,"preferredWindow":1,"deduplication":"None","rX1DROffset":0,"rX2DataRate":0,"rxDelay":0,"abpRelaxMode":true,"fCntUpStart":0,"fCntDownStart":0,"supports32BitFCnt":true,"fCntResetCounter":0,"keepAliveTimeout":null,"appKey":"string","appSKey":"string","nwkSKey":"string","devAddr":"string","alreadyLoggedInOnce":true,"dataRate":"string","txPower":"string","nbRep":"string","reportedRX2DataRate":"string","reportedRX1DROffset":"string","reportedRXDelay":"string"}
{"deviceName":"string","modelId":"string","imageUrl":"http://example.com","isConnected":true,"isEnabled":true,"statusUpdatedTime":"2019-08-24T14:15:22Z","tags":{"property1":"string","property2":"string"},"deviceID":"","classType":"A","useOTAA":true,"appEUI":"string","sensorDecoder":"string","gatewayID":"string","downlink":true,"preferredWindow":1,"deduplication":"None","rX1DROffset":0,"rX2DataRate":0,"rxDelay":0,"abpRelaxMode":true,"fCntUpStart":0,"fCntDownStart":0,"supports32BitFCnt":true,"fCntResetCounter":0,"keepAliveTimeout":null,"appKey":"string","appSKey":"string","nwkSKey":"string","devAddr":"string","alreadyLoggedInOnce":true,"dataRate":"string","txPower":"string","nbRep":"string","reportedRX2DataRate":"string","reportedRX1DROffset":"string","reportedRXDelay":"string","isLoraWan":true}
```

```json
Expand Down Expand Up @@ -2120,7 +2121,8 @@ None
"nbRep": "string",
"reportedRX2DataRate": "string",
"reportedRX1DROffset": "string",
"reportedRXDelay": "string"
"reportedRXDelay": "string",
"isLoraWan": true
}
```

Expand Down Expand Up @@ -3917,7 +3919,8 @@ IoT Edge configuration list item.
"tags": {
"property1": "string",
"property2": "string"
}
},
"isLoraWan": true
}

```
Expand All @@ -3937,6 +3940,7 @@ Device details.
|statusUpdatedTime|string(date-time)|false|none|The status updated time.|
|tags|object¦null|false|none|List of custom device tags and their values.|
|» **additionalProperties**|string¦null|false|none|none|
|isLoraWan|boolean|false|read-only|`true` if this instance is lorawan; otherwise, `false`.|

<h2 id="tocS_DeviceListItem">DeviceListItem</h2>
<!-- backwards compatibility -->
Expand Down Expand Up @@ -4484,7 +4488,8 @@ IoT Edge module.
"nbRep": "string",
"reportedRX2DataRate": "string",
"reportedRX1DROffset": "string",
"reportedRXDelay": "string"
"reportedRXDelay": "string",
"isLoraWan": true
}

```
Expand Down Expand Up @@ -4532,6 +4537,7 @@ LoRa WAN Device details.
|reportedRX2DataRate|string¦null|false|none|The Device Current Rx2Datarate.|
|reportedRX1DROffset|string¦null|false|none|The Device Current RX1DROffset.|
|reportedRXDelay|string¦null|false|none|The Device Current RXDelay.|
|isLoraWan|boolean|false|read-only|none|

#### Enumerated Values

Expand Down
9 changes: 9 additions & 0 deletions swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3375,6 +3375,11 @@
},
"description": "List of custom device tags and their values.",
"nullable": true
},
"isLoraWan": {
"type": "boolean",
"description": "`true` if this instance is lorawan; otherwise, `false`.",
"readOnly": true
}
},
"additionalProperties": false,
Expand Down Expand Up @@ -4118,6 +4123,10 @@
"type": "string",
"description": "The Device Current RXDelay.",
"nullable": true
},
"isLoraWan": {
"type": "boolean",
"readOnly": true
}
},
"additionalProperties": false,
Expand Down