mirror of https://gitee.com/bigwinds/arangodb
Moved Edge and Vertex description of gharial to newest version of rest documentation
This commit is contained in:
Michael Hackstein
parent
25ebe7c3a8
commit
5232983bb1
|
|
@ -1,115 +1,151 @@
|
|||
!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
|
||||
@RESTHEADER{POST /system/gharial/graph-name/edge/collection-name, Create an edge}
|
||||
|
||||
@RESTDESCRIPTION
|
||||
Creates a new edge in the collection.
|
||||
Within the body the has to contain a *\_from* and *\_to* value referencing to valid vertices in the graph.
|
||||
Furthermore the edge has to be valid in the definition of this edge collection.
|
||||
|
||||
@RESTURLPARAMS
|
||||
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
@RESTBODYPARAMS
|
||||
@RESTPARAM{_from, string, required}
|
||||
@RESTPARAM{_to, string, required}
|
||||
|
||||
The body has to be the JSON object to be stored.
|
||||
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{201}
|
||||
Returned if the edge could be created.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no edge collection or no edge with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_edge_create_http_examples
|
||||
|
||||
!SECTION Get an edge
|
||||
@RESTHEADER{GET /system/gharial/graph-name/edge/collection-name/edge-key, Get an edge}
|
||||
|
||||
`GET /system/gharial/graph-name/edge/collection-name/edge-key`*(get an edge)*
|
||||
@RESTDESCRIPTION
|
||||
Gets an edge from the given collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`edge-key (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
@RESTPARAM{edge-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the edge could be found.
|
||||
|
||||
Gets an edge from the given collection.
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no edge collection or no edge with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_edge_get_http_examples
|
||||
|
||||
!SECTION Modify an edge
|
||||
@RESTHEADER{PATCH /system/gharial/graph-name/edge/collection-name/edge-key, Modify an edge}
|
||||
|
||||
`PATCH /system/gharial/graph-name/edge/collection-name/edge-key`*(modify an edge)*
|
||||
@RESTDESCRIPTION
|
||||
Updates the data of the specific edge in the collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`edge-key (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
@RESTPARAM{edge-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTBODYPARAMS
|
||||
The body has to be a JSON object containing the attributes to be updated.
|
||||
|
||||
Updates the data of the specific edge in the collection.
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the edge could be updated.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no edge collection or no edge with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_edge_modify_http_examples
|
||||
|
||||
!SECTION Replace an edge
|
||||
@RESTHEADER{PUT /system/gharial/graph-name/edge/collection-name/edge-key, Replace an edge}
|
||||
|
||||
`PATCH /system/gharial/graph-name/edge/collection-name/edge-key`*(replace an edge)*
|
||||
@RESTDESCRIPTION
|
||||
Replaces the data of an edge in the collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`edge-key (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
@RESTPARAM{edge-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTBODYPARAMS
|
||||
The body has to be the JSON object to be stored.
|
||||
|
||||
Replaces the data of an edge in the collection.
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the edge could be replaced.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no edge collection or no edge with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_edge_replace_http_examples
|
||||
|
||||
!SECTION Remove an edge
|
||||
@RESTHEADER{DELETE /system/gharial/graph-name/edge/collection-name/edge-key, Remove an edge}
|
||||
|
||||
`DELETE /system/gharial/graph-name/edge/collection-name/edge-key`*(remove an edge)*
|
||||
@RESTDESCRIPTION
|
||||
Removes an edge from the collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the edge collection the edge belongs to.
|
||||
|
||||
`edge-key (string, required)`
|
||||
The `_key` attribute of the edge.
|
||||
@RESTPARAM{edge-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTRETURNCODES
|
||||
|
||||
Removes an edge from the collection.
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the edge could be removed.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no edge collection or no edge with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
|
|
|
|||
|
|
@ -1,112 +1,146 @@
|
|||
!CHAPTER Handling Vertices
|
||||
|
||||
!SECTION Create a vertex
|
||||
@RESTHEADER{POST /system/gharial/graph-name/vertex/collection-name, Create a vertex}
|
||||
|
||||
`POST /system/gharial/graph-name/vertex/collection-name`*(create a vertex)*
|
||||
@RESTDESCRIPTION
|
||||
Adds a vertex to the given collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
The name of the vertex collection the edge belongs to.
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the vertex collection the vertex belongs to.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTBODYPARAMS
|
||||
The body has to be the JSON object to be stored.
|
||||
|
||||
Adds a vertex to the given collection.
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{201}
|
||||
Returned if the vertex could be added.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph or no vertex collection with this name could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_vertex_create_http_examples
|
||||
|
||||
!SECTION Get a vertex
|
||||
@RESTHEADER{GET /system/gharial/graph-name/vertex/collection-name/vertex-key, Get a vertex}
|
||||
|
||||
`GET /system/gharial/graph-name/vertex/collection-name/vertex-key`*(get a vertex)*
|
||||
@RESTDESCRIPTION
|
||||
Gets a vertex from the given collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the vertex collection the vertex belongs to.
|
||||
|
||||
`vertex-key (string, required)`
|
||||
The `_key` attribute of the vertex.
|
||||
@RESTPARAM{vertex-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTRETURNCODES
|
||||
|
||||
Gets a vertex from the given collection.
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the vertex could be found.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no vertex collection or no vertex with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_vertex_get_http_examples
|
||||
|
||||
!SECTION Modify an vertex
|
||||
@RESTHEADER{PATCH /system/gharial/graph-name/vertex/collection-name/vertex-key, Modify a vertex}
|
||||
|
||||
`PATCH /system/gharial/graph-name/vertex/collection-name/vertex-key`*(modify a vertex)*
|
||||
@RESTDESCRIPTION
|
||||
Updates the data of the specific vertex in the collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the vertex collection the vertex belongs to.
|
||||
|
||||
`vertex-key (string, required)`
|
||||
The `_key` attribute of the vertex.
|
||||
@RESTPARAM{vertex-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTBODYPARAMS
|
||||
The body has to contain a JSON object containing exactly the attributes that should be replaced.
|
||||
|
||||
Updates the data of the specific vertex in the collection.
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the vertex could be updated.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no vertex collection or no vertex with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_vertex_modify_http_examples
|
||||
|
||||
!SECTION Replace an vertex
|
||||
@RESTHEADER{PUT /system/gharial/graph-name/vertex/collection-name/vertex-key, Replace a vertex}
|
||||
|
||||
`PATCH /system/gharial/graph-name/vertex/collection-name/vertex-key`*(replace a vertex)*
|
||||
@RESTDESCRIPTION
|
||||
Replaces the data of a vertex in the collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the vertex collection the vertex belongs to.
|
||||
|
||||
`vertex-key (string, required)`
|
||||
The `_key` attribute of the vertex.
|
||||
@RESTPARAM{vertex-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTBODYPARAMS
|
||||
The body has to be the JSON object to be stored.
|
||||
|
||||
Replaces the data of a vertex in the collection.
|
||||
@RESTRETURNCODES
|
||||
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the vertex could be replaced.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no vertex collection or no vertex with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
@startDocuBlock JSF_general_graph_vertex_replace_http_examples
|
||||
|
||||
!SECTION Remove a vertex
|
||||
@RESTHEADER{DELETE /system/gharial/graph-name/vertex/collection-name/vertex-key, Remove a vertex}
|
||||
|
||||
`DELETE /system/gharial/graph-name/vertex/collection-name/vertex-key`*(remove a vertex)*
|
||||
@RESTDESCRIPTION
|
||||
Removes a vertex from the collection.
|
||||
|
||||
!SUBSECTION URL parameters
|
||||
@RESTURLPARAMS
|
||||
|
||||
`graph-name (string, required)`
|
||||
@RESTPARAM{graph-name, string, required}
|
||||
The name of the graph.
|
||||
|
||||
`collection-name (string, required)`
|
||||
@RESTPARAM{collection-name, string, required}
|
||||
The name of the vertex collection the vertex belongs to.
|
||||
|
||||
`vertex-key (string, required)`
|
||||
The `_key` attribute of the vertex.
|
||||
@RESTPARAM{vertex-key, string, required}
|
||||
The *_key* attribute of the vertex.
|
||||
|
||||
!SUBSECTION Description
|
||||
@RESTRETURNCODES
|
||||
|
||||
Removes a vertex from the collection.
|
||||
@RESTRETURNCODE{200}
|
||||
Returned if the vertex could be removed.
|
||||
|
||||
@RESTRETURNCODE{404}
|
||||
Returned if no graph with this name, no vertex collection or no vertex with this id could be found.
|
||||
|
||||
@EXAMPLES
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue