diff --git a/docs/api.rst b/docs/api.rst --- a/docs/api.rst +++ b/docs/api.rst @@ -118,15 +118,15 @@ :param string src: starting node specified as a SWH PID :param string dst: destination node, either as a node PID or a node type. - The traversal will stop at the first node encountered matching the - desired destination. + The traversal will stop at the first node encountered matching the + desired destination. :query string edges: edges types the traversal can follow; default to - ``"*"`` + ``"*"`` :query string traversal: traversal algorithm; can be either ``dfs`` or - ``bfs``, default to ``dfs`` + ``bfs``, default to ``dfs`` :query string direction: direction in which graph edges will be followed; - can be either ``forward`` or ``backward``, default to ``forward`` + can be either ``forward`` or ``backward``, default to ``forward`` :statuscode 200: success :statuscode 400: invalid query string provided @@ -134,15 +134,15 @@ .. sourcecode:: http - HTTP/1.1 200 OK - Content-Type: text/plain - Transfer-Encoding: chunked + HTTP/1.1 200 OK + Content-Type: text/plain + Transfer-Encoding: chunked - swh:1:rev:f39d7d78b70e0f39facb1e4fab77ad3df5c52a35 - swh:1:rev:52c90f2d32bfa7d6eccd66a56c44ace1f78fbadd - swh:1:rev:cea92e843e40452c08ba313abc39f59efbb4c29c - swh:1:rev:8d517bdfb57154b8a11d7f1682ecc0f79abf8e02 - ... + swh:1:rev:f39d7d78b70e0f39facb1e4fab77ad3df5c52a35 + swh:1:rev:52c90f2d32bfa7d6eccd66a56c44ace1f78fbadd + swh:1:rev:cea92e843e40452c08ba313abc39f59efbb4c29c + swh:1:rev:8d517bdfb57154b8a11d7f1682ecc0f79abf8e02 + ... .. http:get:: /graph/randomwalk/:src/:dst