From 57c3d34c7826e9f7869d9b3f7fe7cc5f0b2c5d8e Mon Sep 17 00:00:00 2001 From: Leo Famulari Date: Wed, 8 Jul 2015 22:57:20 -0400 Subject: [PATCH] Fix REST discovery API documentation Replace reference to nonexistent "hint" URI for POSTing to the discovery cache with correct reference: /rest/system/discovery/hint -> /rest/system/discovery --- rest/system-discovery-hint-post.rst | 11 ----------- rest/system-discovery-post.rst | 11 +++++++++++ 2 files changed, 11 insertions(+), 11 deletions(-) delete mode 100644 rest/system-discovery-hint-post.rst create mode 100644 rest/system-discovery-post.rst diff --git a/rest/system-discovery-hint-post.rst b/rest/system-discovery-hint-post.rst deleted file mode 100644 index ecc19c380..000000000 --- a/rest/system-discovery-hint-post.rst +++ /dev/null @@ -1,11 +0,0 @@ -POST /rest/system/discovery/hint -================================ - -Post with the query parameters ``device`` and ``addr`` to add entries to -the discovery cache. - -.. code-block:: bash - - curl -X POST http://127.0.0.1:8384/rest/system/discovery/hint?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\&addr=192.162.129.11:22000 - # Or with the X-API-Key header: - curl -X POST --header "X-API-Key: TcE28kVPdtJ8COws1JdM0b2nodj77WeQ" http://127.0.0.1:8384/rest/system/discovery/hint?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\&addr=192.162.129.11:22000 diff --git a/rest/system-discovery-post.rst b/rest/system-discovery-post.rst new file mode 100644 index 000000000..937618e8a --- /dev/null +++ b/rest/system-discovery-post.rst @@ -0,0 +1,11 @@ +POST /rest/system/discovery +================================ + +Post with the query parameters ``device`` and ``addr`` to add entries to +the discovery cache. + +.. code-block:: bash + + curl -X POST http://127.0.0.1:8384/rest/system/discovery?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\&addr=192.162.129.11:22000 + # Or with the X-API-Key header: + curl -X POST --header "X-API-Key: TcE28kVPdtJ8COws1JdM0b2nodj77WeQ" http://127.0.0.1:8384/rest/system/discovery?device=LGFPDIT7SKNNJVJZA4FC7QNCRKCE753K72BW5QD2FOZ7FRFEP57Q\&addr=192.162.129.11:22000