Skip to content

Commit 3545bfd

Browse files
authored
RDKEMW-5807 Update the LEDControl plugin entservice-apis doc (#349)
Reason for change: Updated the document as per latest result Test Procedure: None Priority: P2 Signed-off-by:Dineshkumar P [email protected]
1 parent 3edd623 commit 3545bfd

File tree

2 files changed

+15
-19
lines changed

2 files changed

+15
-19
lines changed

docs/apis/LEDControlPlugin.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,8 @@ This method takes no parameters.
6969
| Name | Type | Description |
7070
| :-------- | :-------- | :-------- |
7171
| result | object | |
72+
| result.supportedLEDStates | array | Returns all the LED states available on the platform |
73+
| result.supportedLEDStates[#] | string | |
7274
| result.success | boolean | Whether the request succeeded |
7375

7476
### Example
@@ -90,6 +92,9 @@ This method takes no parameters.
9092
"jsonrpc": "2.0",
9193
"id": 42,
9294
"result": {
95+
"supportedLEDStates": [
96+
"`ACTIVE`, `STANDBY`, `WPS_CONNECTING`, `WPS_CONNECTED`, `WPS_ERROR`, `FACTORY_RESET', 'USB_UPGRADE', 'DOWNLOAD_ERROR'"
97+
],
9398
"success": true
9499
}
95100
}
@@ -114,7 +119,6 @@ This method takes no parameters.
114119
| :-------- | :-------- | :-------- |
115120
| result | object | |
116121
| result.state | string | Indicates a platform supported LED state |
117-
| result.success | boolean | Whether the request succeeded |
118122

119123
### Example
120124

@@ -135,8 +139,7 @@ This method takes no parameters.
135139
"jsonrpc": "2.0",
136140
"id": 42,
137141
"result": {
138-
"state": "ACTIVE",
139-
"success": true
142+
"state": "ACTIVE"
140143
}
141144
}
142145
```
@@ -161,8 +164,7 @@ No Events
161164

162165
| Name | Type | Description |
163166
| :-------- | :-------- | :-------- |
164-
| result | object | |
165-
| result.success | boolean | Whether the request succeeded |
167+
| result | boolean | Whether the request succeeded |
166168

167169
### Example
168170

@@ -185,9 +187,7 @@ No Events
185187
{
186188
"jsonrpc": "2.0",
187189
"id": 42,
188-
"result": {
189-
"success": true
190-
}
190+
"result": true
191191
}
192192
```
193193

tools/json_generator/output/LEDControl/LEDControl.json

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,11 @@
1212
"definitions": {
1313
"supportedLEDStates": {
1414
"summary": "Returns all the LED states available on the platform.",
15-
"type":"string array",
16-
"example": "[\"ACTIVE\",\"STANDBY\",\"WPS_CONNECTING\",\"WPS_CONNECTED\",\"WPS_ERROR\",\"FACTORY_RESET\",\"USB_UPGRADE\",\"DOWNLOAD_ERROR\"]"
15+
"type":"array",
16+
"items": {
17+
"type": "string",
18+
"example": "`ACTIVE`, `STANDBY`, `WPS_CONNECTING`, `WPS_CONNECTED`, `WPS_ERROR`, `FACTORY_RESET', 'USB_UPGRADE', 'DOWNLOAD_ERROR'"
19+
}
1720
},
1821
"state": {
1922
"summary": "Indicates a platform supported LED state",
@@ -38,9 +41,6 @@
3841
"supportedLEDStates",
3942
"success"
4043
]
41-
},
42-
"result": {
43-
"$ref": "#/common/result"
4444
}
4545
},
4646
"getLEDState": {
@@ -50,14 +50,10 @@
5050
"properties": {
5151
"state": {
5252
"$ref": "#/definitions/state"
53-
},
54-
"success": {
55-
"$ref": "#/common/success"
5653
}
5754
},
5855
"required": [
59-
"state",
60-
"success"
56+
"state"
6157
]
6258
}
6359
},
@@ -75,7 +71,7 @@
7571
]
7672
},
7773
"result": {
78-
"$ref": "#/common/result"
74+
"$ref": "#/common/success"
7975
}
8076
}
8177
}

0 commit comments

Comments
 (0)