mirror of https://gitee.com/bigwinds/arangodb
Started adding links for the graph http module in the gitbook
This commit is contained in:
Michael Hackstein
parent
b986d7baf6
commit
5c994b6fbf
|
|
@ -0,0 +1,103 @@
|
|||
!CHAPTER Handling Edges
|
||||
|
||||
!SECTION Create an edge
|
||||
|
||||
`POST /system/gharial/graph-name/edge/collection-name`*(create an edge)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_create_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_create_http_examples -->
|
||||
|
||||
!SECTION Get an edge
|
||||
|
||||
`GET /system/gharial/graph-name/edge/collection-name/edge-key`*(get an edge)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_get_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_get_http_examples -->
|
||||
|
||||
!SECTION Modify an edge
|
||||
|
||||
`PATCH /system/gharial/graph-name/edge/collection-name/edge-key`*(modify an edge)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_modify_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_modify_http_examples -->
|
||||
|
||||
!SECTION Replace an edge
|
||||
|
||||
`PATCH /system/gharial/graph-name/edge/collection-name/edge-key`*(replace an edge)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_replace_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_replace_http_examples -->
|
||||
|
||||
!SECTION Remove an edge
|
||||
|
||||
`DELETE /system/gharial/graph-name/edge/collection-name/edge-key`*(remove an edge)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_delete_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_delete_http_examples -->
|
||||
|
|
@ -0,0 +1,150 @@
|
|||
!CHAPTER Manage your graphs
|
||||
|
||||
!SECTION List all graphs
|
||||
|
||||
`GET /system/gharial/`*(lists all graphs)*
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_list_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_list_http_examples -->
|
||||
|
||||
!SECTION Create a graph
|
||||
|
||||
`POST /system/gharial/`*(create a graph)*
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_create_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_create_http_examples -->
|
||||
|
||||
!SECTION Drop a graph
|
||||
|
||||
`DELETE /system/gharial/graph-name`*(drop a graph)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
|
||||
The name of the graph.
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_create_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_create_http_examples -->
|
||||
|
||||
!SECTION List all vertex collections in the graph
|
||||
|
||||
`GET /system/gharial/graph-name/vertex`*(lists all vertex collections)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_list_vertex_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_list_vertex_http_examples -->
|
||||
|
||||
!SECTION Add a new vertex collection to the graph
|
||||
|
||||
`POST /system/gharial/graph-name/vertex`*(add a new vertex collection)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_vertex_collection_add_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_vertex_collection_add_http_examples -->
|
||||
|
||||
!SECTION Remove a vertex collection form the graph
|
||||
|
||||
`DELETE /system/gharial/graph-name/vertex/collection-name`*(remove a vertex collection)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the vertex collection.
|
||||
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_vertex_collection_remove_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_vertex_collection_remove_http_examples -->
|
||||
|
||||
!SECTION List all edge definitions in the graph
|
||||
|
||||
`GET /system/gharial/graph-name/edge`*(lists all edge definitions)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_list_edge_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_list_edge_http_examples -->
|
||||
|
||||
!SECTION Add a new edge definition to the graph
|
||||
|
||||
`POST /system/gharial/graph-name/edge`*(add a new edge definition)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_definition_add_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_definition_add_http_examples -->
|
||||
|
||||
!SECTION Modify an edge definition
|
||||
|
||||
`DELETE /system/gharial/graph-name/edge/definition-name`*(remove a vertex collection)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`definition-name (string, required)`
|
||||
The name of the edge collection used in the definition.
|
||||
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_definition_modify_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_definition_modify_http_examples -->
|
||||
|
||||
!SECTION Remove an edge definition form the graph
|
||||
|
||||
`DELETE /system/gharial/graph-name/edge/definition-name`*(remove a vertex collection)*
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
|
||||
`graph-name (string, required)`
|
||||
The name of the graph.
|
||||
|
||||
`definition-name (string, required)`
|
||||
The name of the edge collection used in the definition.
|
||||
|
||||
|
||||
!SUBSECTION Description
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_definition_remove_info -->
|
||||
|
||||
<!-- @startDocuBlock JSF_general_graph_edge_definition_remove_http_examples -->
|
||||
|
|
@ -167,6 +167,10 @@
|
|||
* [Graphs](HttpGraphs/README.md)
|
||||
* [Vertex](HttpGraphs/Vertex.md)
|
||||
* [Edges](HttpGraphs/Edge.md)
|
||||
* [General Graph](HttpGharial/README.md)
|
||||
* [Management](HttpGharial/Management.md)
|
||||
* [Vertices](HttpGharial/Vertices.md)
|
||||
* [Edges](HttpGharial/Edges.md)
|
||||
* [Traversals](HttpTraversal/README.md)
|
||||
* [Replication](HttpReplications/README.md)
|
||||
* [Replication Dump](HttpReplications/ReplicationDump.md)
|
||||
|
|
|
|||
Loading…
Reference in New Issue