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

documentation updates

This commit is contained in:
a-brandt 2013-03-11 13:01:17 +01:00
parent 206681159f
commit d4ea6bfa31
11 changed files with 39 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
Documentation/Examples/api-graph-change-edge
View File

@ -3,6 +3,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 57595391
{
"edge": {

1
Documentation/Examples/api-graph-change-vertex
View File

@ -3,6 +3,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 24332190
{
"vertex": {

1
Documentation/Examples/api-graph-changep-edge
View File

@ -3,6 +3,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 57595398
{
"edge": {

2
Documentation/Examples/api-graph-changep-vertex
View File

@ -3,6 +3,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 24332193
{
"vertex": {
@ -21,6 +22,7 @@ content-type: application/json; charset=utf-8
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 24332199
{
"vertex": {

1
Documentation/Examples/api-graph-create-edge
View File

@ -3,6 +3,7 @@
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
etag: 57595366
{
"edge": {

1
Documentation/Examples/api-graph-create-graph
View File

@ -3,6 +3,7 @@
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
etag: 11767958
{
"graph": {

1
Documentation/Examples/api-graph-create-vertex
View File

@ -3,6 +3,7 @@
HTTP/1.1 201 Created
content-type: application/json; charset=utf-8
etag: 24332177
{
"vertex": {

1
Documentation/Examples/api-graph-get-edge
View File

@ -2,6 +2,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 57595366
{
"edge": {

1
Documentation/Examples/api-graph-get-graph
View File

@ -2,6 +2,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 11767958
{
"graph": {

1
Documentation/Examples/api-graph-get-vertex
View File

@ -2,6 +2,7 @@
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8
etag: 24332177
{
"vertex": {

38
js/actions/system/api-graph.js
View File

@ -680,7 +680,7 @@ function update_graph_vertex (req, res, g, isPatch) {
/// @RESTQUERYPARAMETERS
///
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
/// Wait until document has been sync to disk.
/// Wait until vertex has been sync to disk.
///
/// @RESTQUERYPARAM{rev,string,optional}
/// Revision of a vertex
@ -733,7 +733,7 @@ function put_graph_vertex (req, res, g) {
/// @RESTQUERYPARAMETERS
///
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
/// Wait until document has been sync to disk.
/// Wait until vertex has been sync to disk.
///
/// @RESTQUERYPARAM{rev,string,optional}
/// Revision of a vertex
@ -892,6 +892,11 @@ function process_labels_filter (data, labels) {
/// - @LIT{value}: the value of the @LIT{key}
/// - @LIT{compare}: a compare operator
//
/// @RESTRETURNCODES
///
/// @RESTRETURNCODE{201}
/// is returned if the cursor was created
///
/// @EXAMPLES
///
/// 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}
///
/// @REST{POST /_api/graph/@FA{graph-name}/vertices/@FA{vertice-name}}
///
/// @RESTDESCRIPTION
/// Returns a cursor.
///
/// 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{compare}: a compare operator
///
/// @RESTRETURNCODES
///
/// @RESTRETURNCODE{201}
/// is returned if the cursor was created
///
/// @EXAMPLES
///
/// Select all vertices
@ -1076,7 +1085,7 @@ function post_graph_vertex_vertices (req, res, g) {
/// @RESTQUERYPARAMETERS
///
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
/// Wait until document has been sync to disk.
/// Wait until edge has been sync to disk.
///
/// @RESTDESCRIPTION
/// Creates an edge in a graph.
@ -1217,7 +1226,7 @@ function get_graph_edge (req, res, g) {
/// @RESTQUERYPARAMETERS
///
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
/// Wait until document has been sync to disk.
/// Wait until edge has been sync to disk.
///
/// @RESTQUERYPARAM{rev,string,optional}
/// Revision of an edge
@ -1352,7 +1361,7 @@ function update_graph_edge (req, res, g, isPatch) {
/// @RESTQUERYPARAMETERS
///
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
/// Wait until document has been sync to disk.
/// Wait until edge has been sync to disk.
///
/// @RESTQUERYPARAM{rev,string,optional}
/// Revision of an edge
@ -1405,7 +1414,7 @@ function put_graph_edge (req, res, g) {
/// @RESTQUERYPARAMETERS
///
/// @RESTQUERYPARAM{waitForSync,boolean,optional}
/// Wait until document has been sync to disk.
/// Wait until edge has been sync to disk.
///
/// @RESTQUERYPARAM{rev,string,optional}
/// 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}
///
/// @REST{POST /_api/graph/@FA{graph-name}/edges}
///
/// @RESTDESCRIPTION
/// Returns a cursor.
///
/// 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{compare}: a compare operator
///
/// @RESTRETURNCODES
///
/// @RESTRETURNCODE{201}
/// is returned if the cursor was created
///
/// @EXAMPLES
///
/// Select all edges
@ -1577,6 +1590,11 @@ function post_graph_all_edges (req, res, g) {
/// - @LIT{value}: the value of the @LIT{key}
/// - @LIT{compare}: a compare operator
///
/// @RESTRETURNCODES
///
/// @RESTRETURNCODE{201}
/// is returned if the cursor was created
///
/// @EXAMPLES
///
/// Select all edges