Skip to content

Commit eeb8abb

Browse files
committed
[docs] Fixed minor issues in REST API docs
Improved clarity of parameters in URL paths and minor improvements. [skip ci]
1 parent 694a763 commit eeb8abb

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/user/rest-api.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -275,28 +275,28 @@ Get Device Connection Detail
275275

276276
.. code-block:: text
277277
278-
GET /api/v1/controller/device/{id}/connection/{id}/
278+
GET /api/v1/controller/device/{device_id}/connection/{connection_id}/
279279
280280
Change Device Connection Detail
281281
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
282282

283283
.. code-block:: text
284284
285-
PUT /api/v1/controller/device/{id}/connection/{id}/
285+
PUT /api/v1/controller/device/{device_id}/connection/{connection_id}/
286286
287287
Patch Device Connection Detail
288288
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
289289

290290
.. code-block:: text
291291
292-
PATCH /api/v1/controller/device/{id}/connection/{id}/
292+
PATCH /api/v1/controller/device/{device_id}/connection/{connection_id}/
293293
294294
Delete Device Connection
295295
~~~~~~~~~~~~~~~~~~~~~~~~
296296

297297
.. code-block:: text
298298
299-
DELETE /api/v1/controller/device/{id}/connection/{id}/
299+
DELETE /api/v1/controller/device/{device_id}/connection/{connection_id}/
300300
301301
List Credentials
302302
~~~~~~~~~~~~~~~~
@@ -345,14 +345,14 @@ List Commands of a Device
345345

346346
.. code-block:: text
347347
348-
GET /api/v1/controller/device/{id}/command/
348+
GET /api/v1/controller/device/{device_id}/command/
349349
350-
Execute a Command a Device
351-
~~~~~~~~~~~~~~~~~~~~~~~~~~
350+
Execute a Command on a Device
351+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
352352

353353
.. code-block:: text
354354
355-
POST /api/v1/controller/device/{id}/command/
355+
POST /api/v1/controller/device/{device_id}/command/
356356
357357
Get Command Details
358358
~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)