[LNT] r308332 - Add info about auth keys and DELETE in the API

[Chris Matthews via llvm-commits]

Author: cmatthews
Date: Tue Jul 18 11:24:40 2017
New Revision: 308332

URL: http://llvm.org/viewvc/llvm-project?rev=308332&view=rev
Log:
Add info about auth keys and DELETE in the API

Modified:
    lnt/trunk/docs/api.rst

Modified: lnt/trunk/docs/api.rst
URL: http://llvm.org/viewvc/llvm-project/lnt/trunk/docs/api.rst?rev=308332&r1=308331&r2=308332&view=diff
==============================================================================
--- lnt/trunk/docs/api.rst (original)
+++ lnt/trunk/docs/api.rst Tue Jul 18 11:24:40 2017
@@ -37,6 +37,17 @@ once.
 | /samples/`id`             | Get all non-empty sample info for Sample `id`.                                           |
 +---------------------------+------------------------------------------------------------------------------------------+
 
-Examples
---------
+Write Operations
+----------------
 
+The machines, orders and runs endpoints also support the DELETE http method.  The user must include a http header called
+"AuthToken" which has the API auth token set in the LNT instance configuration.
+
+The API Auth token can be set by adding `api_auth_token` to the instnaces lnt.cfg config file::
+
+    # API Auth Token
+    api_auth_token = "SomeSecret"
+
+Example::
+
+    curl --request DELETE --header "AuthToken: SomeSecret" http://localhost:8000/api/db_default/v4/nts/runs/1