mirror of https://gitee.com/bigwinds/arangodb
documentation updates
This commit is contained in:
parent
206681159f
commit
d4ea6bfa31
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 57595391
|
||||||
|
|
||||||
{
|
{
|
||||||
"edge": {
|
"edge": {
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 24332190
|
||||||
|
|
||||||
{
|
{
|
||||||
"vertex": {
|
"vertex": {
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 57595398
|
||||||
|
|
||||||
{
|
{
|
||||||
"edge": {
|
"edge": {
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 24332193
|
||||||
|
|
||||||
{
|
{
|
||||||
"vertex": {
|
"vertex": {
|
||||||
|
@ -21,6 +22,7 @@ content-type: application/json; charset=utf-8
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 24332199
|
||||||
|
|
||||||
{
|
{
|
||||||
"vertex": {
|
"vertex": {
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 201 Created
|
HTTP/1.1 201 Created
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 57595366
|
||||||
|
|
||||||
{
|
{
|
||||||
"edge": {
|
"edge": {
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 201 Created
|
HTTP/1.1 201 Created
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 11767958
|
||||||
|
|
||||||
{
|
{
|
||||||
"graph": {
|
"graph": {
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
|
|
||||||
HTTP/1.1 201 Created
|
HTTP/1.1 201 Created
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 24332177
|
||||||
|
|
||||||
{
|
{
|
||||||
"vertex": {
|
"vertex": {
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 57595366
|
||||||
|
|
||||||
{
|
{
|
||||||
"edge": {
|
"edge": {
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 11767958
|
||||||
|
|
||||||
{
|
{
|
||||||
"graph": {
|
"graph": {
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
|
|
||||||
HTTP/1.1 200 OK
|
HTTP/1.1 200 OK
|
||||||
content-type: application/json; charset=utf-8
|
content-type: application/json; charset=utf-8
|
||||||
|
etag: 24332177
|
||||||
|
|
||||||
{
|
{
|
||||||
"vertex": {
|
"vertex": {
|
||||||
|
|
|
@ -680,7 +680,7 @@ function update_graph_vertex (req, res, g, isPatch) {
|
||||||
/// @RESTQUERYPARAMETERS
|
/// @RESTQUERYPARAMETERS
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
||||||
/// Wait until document has been sync to disk.
|
/// Wait until vertex has been sync to disk.
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{rev,string,optional}
|
/// @RESTQUERYPARAM{rev,string,optional}
|
||||||
/// Revision of a vertex
|
/// Revision of a vertex
|
||||||
|
@ -733,7 +733,7 @@ function put_graph_vertex (req, res, g) {
|
||||||
/// @RESTQUERYPARAMETERS
|
/// @RESTQUERYPARAMETERS
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
||||||
/// Wait until document has been sync to disk.
|
/// Wait until vertex has been sync to disk.
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{rev,string,optional}
|
/// @RESTQUERYPARAM{rev,string,optional}
|
||||||
/// Revision of a vertex
|
/// Revision of a vertex
|
||||||
|
@ -892,6 +892,11 @@ function process_labels_filter (data, labels) {
|
||||||
/// - @LIT{value}: the value of the @LIT{key}
|
/// - @LIT{value}: the value of the @LIT{key}
|
||||||
/// - @LIT{compare}: a compare operator
|
/// - @LIT{compare}: a compare operator
|
||||||
//
|
//
|
||||||
|
/// @RESTRETURNCODES
|
||||||
|
///
|
||||||
|
/// @RESTRETURNCODE{201}
|
||||||
|
/// is returned if the cursor was created
|
||||||
|
///
|
||||||
/// @EXAMPLES
|
/// @EXAMPLES
|
||||||
///
|
///
|
||||||
/// Select all vertices
|
/// Select all vertices
|
||||||
|
@ -950,8 +955,7 @@ function post_graph_all_vertices (req, res, g) {
|
||||||
///
|
///
|
||||||
/// @RESTHEADER{POST /_api/graph/@FA{graph-name}/vertices/@FA{vertice-name},get vertices}
|
/// @RESTHEADER{POST /_api/graph/@FA{graph-name}/vertices/@FA{vertice-name},get vertices}
|
||||||
///
|
///
|
||||||
/// @REST{POST /_api/graph/@FA{graph-name}/vertices/@FA{vertice-name}}
|
/// @RESTDESCRIPTION
|
||||||
///
|
|
||||||
/// Returns a cursor.
|
/// Returns a cursor.
|
||||||
///
|
///
|
||||||
/// The call expects a JSON hash array as body to filter the result:
|
/// The call expects a JSON hash array as body to filter the result:
|
||||||
|
@ -972,6 +976,11 @@ function post_graph_all_vertices (req, res, g) {
|
||||||
/// - @LIT{value}: the value of the @LIT{key}
|
/// - @LIT{value}: the value of the @LIT{key}
|
||||||
/// - @LIT{compare}: a compare operator
|
/// - @LIT{compare}: a compare operator
|
||||||
///
|
///
|
||||||
|
/// @RESTRETURNCODES
|
||||||
|
///
|
||||||
|
/// @RESTRETURNCODE{201}
|
||||||
|
/// is returned if the cursor was created
|
||||||
|
///
|
||||||
/// @EXAMPLES
|
/// @EXAMPLES
|
||||||
///
|
///
|
||||||
/// Select all vertices
|
/// Select all vertices
|
||||||
|
@ -1076,7 +1085,7 @@ function post_graph_vertex_vertices (req, res, g) {
|
||||||
/// @RESTQUERYPARAMETERS
|
/// @RESTQUERYPARAMETERS
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
||||||
/// Wait until document has been sync to disk.
|
/// Wait until edge has been sync to disk.
|
||||||
///
|
///
|
||||||
/// @RESTDESCRIPTION
|
/// @RESTDESCRIPTION
|
||||||
/// Creates an edge in a graph.
|
/// Creates an edge in a graph.
|
||||||
|
@ -1217,7 +1226,7 @@ function get_graph_edge (req, res, g) {
|
||||||
/// @RESTQUERYPARAMETERS
|
/// @RESTQUERYPARAMETERS
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
||||||
/// Wait until document has been sync to disk.
|
/// Wait until edge has been sync to disk.
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{rev,string,optional}
|
/// @RESTQUERYPARAM{rev,string,optional}
|
||||||
/// Revision of an edge
|
/// Revision of an edge
|
||||||
|
@ -1352,7 +1361,7 @@ function update_graph_edge (req, res, g, isPatch) {
|
||||||
/// @RESTQUERYPARAMETERS
|
/// @RESTQUERYPARAMETERS
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
||||||
/// Wait until document has been sync to disk.
|
/// Wait until edge has been sync to disk.
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{rev,string,optional}
|
/// @RESTQUERYPARAM{rev,string,optional}
|
||||||
/// Revision of an edge
|
/// Revision of an edge
|
||||||
|
@ -1405,7 +1414,7 @@ function put_graph_edge (req, res, g) {
|
||||||
/// @RESTQUERYPARAMETERS
|
/// @RESTQUERYPARAMETERS
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
|
||||||
/// Wait until document has been sync to disk.
|
/// Wait until edge has been sync to disk.
|
||||||
///
|
///
|
||||||
/// @RESTQUERYPARAM{rev,string,optional}
|
/// @RESTQUERYPARAM{rev,string,optional}
|
||||||
/// Revision of an edge
|
/// Revision of an edge
|
||||||
|
@ -1466,8 +1475,7 @@ function patch_graph_edge (req, res, g) {
|
||||||
///
|
///
|
||||||
/// @RESTHEADER{POST /_api/graph/@FA{graph-name}/edges,get edges}
|
/// @RESTHEADER{POST /_api/graph/@FA{graph-name}/edges,get edges}
|
||||||
///
|
///
|
||||||
/// @REST{POST /_api/graph/@FA{graph-name}/edges}
|
/// @RESTDESCRIPTION
|
||||||
///
|
|
||||||
/// Returns a cursor.
|
/// Returns a cursor.
|
||||||
///
|
///
|
||||||
/// The call expects a JSON hash array as body to filter the result:
|
/// The call expects a JSON hash array as body to filter the result:
|
||||||
|
@ -1486,6 +1494,11 @@ function patch_graph_edge (req, res, g) {
|
||||||
/// - @LIT{value}: the value of the @LIT{key}
|
/// - @LIT{value}: the value of the @LIT{key}
|
||||||
/// - @LIT{compare}: a compare operator
|
/// - @LIT{compare}: a compare operator
|
||||||
///
|
///
|
||||||
|
/// @RESTRETURNCODES
|
||||||
|
///
|
||||||
|
/// @RESTRETURNCODE{201}
|
||||||
|
/// is returned if the cursor was created
|
||||||
|
///
|
||||||
/// @EXAMPLES
|
/// @EXAMPLES
|
||||||
///
|
///
|
||||||
/// Select all edges
|
/// Select all edges
|
||||||
|
@ -1577,6 +1590,11 @@ function post_graph_all_edges (req, res, g) {
|
||||||
/// - @LIT{value}: the value of the @LIT{key}
|
/// - @LIT{value}: the value of the @LIT{key}
|
||||||
/// - @LIT{compare}: a compare operator
|
/// - @LIT{compare}: a compare operator
|
||||||
///
|
///
|
||||||
|
/// @RESTRETURNCODES
|
||||||
|
///
|
||||||
|
/// @RESTRETURNCODE{201}
|
||||||
|
/// is returned if the cursor was created
|
||||||
|
///
|
||||||
/// @EXAMPLES
|
/// @EXAMPLES
|
||||||
///
|
///
|
||||||
/// Select all edges
|
/// Select all edges
|
||||||
|
|
Loading…
Reference in New Issue