Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Added documentation for get graph in gharial

This commit is contained in:
Michael Hackstein 2014-07-02 14:20:03 +02:00
parent de1c3836aa
commit bdfe2b518e
1 changed files with 24 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
Documentation/Books/Users/HttpGharial/Management.mdpp
View File

@ -58,7 +58,30 @@ This can occur either if a graph with this name is already stored, or if there i
@startDocuBlock JSF_general_graph_create_http_examples
@brief Remove a graph from the graph module. Optionally drop all collections.
@brief Get a graph from the graph module.
@RESTHEADER{GET /_api/gharial/graph-name, Get a graph}
@RESTDESCRIPTION
Gets a graph from the collection *\_graphs*.
Returns the definition content of this graph.
@RESTURLPARAMS
@RESTPARAM{graph-name, string, required}
The name of the graph.
@RESTRETURNCODES
@RESTRETURNCODE{200}
Returned if the graph could be found.
@RESTRETURNCODE{404}
Returned if no graph with this name could be found.
@EXAMPLES
@startDocuBlock JSF_general_graph_get_http_examples
@RESTHEADER{DELETE /_api/gharial/graph-name, Drop a graph}