You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/iot-platform-sdk/development-guide.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,9 +7,9 @@ The implementation of these REST contracts in an OCS can be done in any programm
7
7
!!! Note
8
8
The implementation of the pre-defined contracts can be backed by non-REST interfaces as well. However, this would invlove updates to both OPS and To0Scheduler to facilitate communication with the newly defined interface at OCS. Such a change would involve, but is not limited to, updates to existing class `RestClient.java` at both OPS and To0Scheduler.
9
9
10
-
## Rest Contracts between OCS (server) and OPS/To0Scheduler (client)
10
+
## Rest Contracts between OCS(Server) and OPS/To0Scheduler(Client)
11
11
12
-
Following are the pre-defined REST API specifications for all the resource paths that must be implemented and exposed by an OCS implementation. Both, OPS and To0Scheduler make requests to the OCS implementation, as clients, using this format.
12
+
The following are the pre-defined REST API specifications for all the resource paths that must be implemented and exposed by an OCS implementation. Both, OPS and To0Scheduler make requests to the OCS implementation, as clients, using this format.
13
13
14
14
| Operation | Description | Path/Query Parameters | Request Body | Response Body |
@@ -35,7 +35,7 @@ Following are the pre-defined REST API specifications for all the resource paths
35
35
|`DELETE` /v1/devices/{deviceId}/sessioninfo | Delete the TO2 session info corresponding to the `deviceId`. | Path: `deviceId`: Device identifier |||
36
36
|`GET` /devices/{deviceId}/resale | Get the `resale` flag indicating owner's support for resale of the corresponding `deviceId`. | Path: `deviceId`: Device identifier || Boolean |
37
37
38
-
## Rest Contracts between To0Scheduler (server) and OCS (client)
38
+
## Rest Contracts between To0Scheduler(Server) and OCS(Client)
39
39
40
40
An OCS implementation must, also, act as a client to trigger TO0 for set of devices, by making the following request to To0Scheduler. To0Scheduler accepts the request from OCS to initiate TO0 for the list of devices.
41
41
@@ -46,7 +46,7 @@ An OCS implementation must, also, act as a client to trigger TO0 for set of devi
46
46
47
47
## Message Types
48
48
49
-
Following is a list of message types that are sent in the message body of each request/response. Each message type follows the standard JSON* schema. Statements after '#' inside the JavaScript Object Notation (JSON), represents the purpose of the field.
49
+
Following is a list of message types that are sent in the message body of each request/response. Each message type follows the standard JSON\* schema. Statements after '#' inside the JavaScript* Object Notation (JSON), represents the purpose of the field.
50
50
51
51
### DeviceState
52
52
This JSON* structure represents the state information of the device.
@@ -243,4 +243,4 @@ This JSON* structure represents the request message that is sent from the OCS to
243
243
],
244
244
"waitSeconds": String # Suggested number of seconds for which TO0 will be valid
Copy file name to clipboardExpand all lines: docs/iot-platform-sdk/introduction.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,4 +117,4 @@ Limitations of This Release
117
117
118
118
- The number of concurrent TO0 sessions are limited by a configuration property. TO0 requests for any numbers of devices may be dropped if this limit is reached.
119
119
120
-
- The keystore and truststore passwords are present in the configuration files as plain text. Special care must be taken to secure the configuration files.
120
+
- The keystore and truststore passwords are present in the configuration files as plain text. Special care must be taken to secure the configuration files.
0 commit comments