Add node details api doc
@@ -186,7 +186,7 @@ These endpoints allow to read the current configuration tree
Endpoint: get the current configuration tree of the root node.
- HTTP Method: **GET**
-- path : **/api/v2/config/active/tree**
+- path : **/api/v2_beta/config/active/tree**
- response type: **JSON**
- response example:
@@ -206,7 +206,7 @@ Endpoint: get the current configuration tree of a specific node.
Node names must be separated by a comma.
- HTTP Method: **GET**
-- path : **/api/v2/config/active/tree/root,foo**
+- path : **/api/v2_beta/config/active/tree/root,foo**
- response type: **JSON**
- response example:
@@ -222,6 +222,37 @@ Node names must be separated by a comma.
}
]
+Tornado 'Node Details' Backend API Version 2
+++++++++++++++++++++++++++++++++++++++
+
+The 'node details' APIs require the caller to pass an authorization token in
+the headers as in the 'auth' API.
+
+.. rubric:: Reading the current configuration details
+
+These endpoints allow to read the current configuration tree nodes details
+
+Endpoint: get the node details of the current configuration tree
+
+- HTTP Method: **GET**
+- path : **/api/v2/config/active/tree/root,foo/details**
+- response type: **JSON**
+- response example:
+
+ .. code:: json
+
+ {
+ "type":"Filter",
+ "name":"foo",
+ "description":"This filter allows events for Linux hosts",
+ "active":true,
+ "filter":{
+ "type":"equals",
+ "first":"${event.metadata.os}",
+ "second":"linux"
+ }
+ }
+
Tornado 'Event' Backend API
+++++++++++++++++++++++++++
