From 5cf5a5947198c00a8e2681aff5516f11b1426f38 Mon Sep 17 00:00:00 2001 From: Thomas Richter Date: Tue, 4 Jun 2013 15:17:10 +0200 Subject: [PATCH] generated examples api-graph.js finished --- js/actions/api-graph.js | 288 +++++++++++++++++++++++++++++++++++++--- 1 file changed, 268 insertions(+), 20 deletions(-) diff --git a/js/actions/api-graph.js b/js/actions/api-graph.js index f63ee4d5f7..884d0d8529 100644 --- a/js/actions/api-graph.js +++ b/js/actions/api-graph.js @@ -319,9 +319,6 @@ function post_graph_graph (req, res) { /// get graph by name /// /// @EXAMPLE_ARANGOSH_RUN{RestGraphGetGraph} -/// db._drop("edges"); -/// db._drop("vertices"); -/// db._graphs.remove("graph"); /// var Graph = require("org/arangodb/graph").Graph; /// var g = new Graph("graph", "vertices", "edges"); /// var url = "/_api/graph/graph"; @@ -491,7 +488,19 @@ function delete_graph_graph (req, res) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-create-vertex +/// @EXAMPLE_ARANGOSH_RUN{RestGraphCreateVertex} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var url = "/_api/graph/graph/vertex"; +/// var response = logCurlRequest('POST', url, {"_key" : "v1", "optional1" : "val1" }); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function post_graph_vertex (req, res, g) { @@ -580,8 +589,20 @@ function post_graph_vertex (req, res, g) { /// /// get vertex properties by name /// -/// @verbinclude api-graph-get-vertex +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetVertex} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// g.addVertex("v1", {"optional1" : "val1" }); +/// var url = "/_api/graph/graph/vertex/v1"; +/// var response = logCurlRequest('GET', url); +/// +/// assert(response.code === 200); /// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function get_graph_vertex (req, res, g) { @@ -636,7 +657,12 @@ function get_graph_vertex (req, res, g) { /// @RESTRETURNCODES /// /// @RESTRETURNCODE{200} -/// is returned if the vertex was deleted +/// is returned if the vertex was deleted and `waitForSync` was +/// `true`. +/// +/// @RESTRETURNCODE{202} +/// is returned if the vertex was deleted and `waitForSync` was +/// `false`. /// /// @RESTRETURNCODE{404} /// is returned if the graph or the vertex was not found. @@ -648,7 +674,20 @@ function get_graph_vertex (req, res, g) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-delete-vertex +/// @EXAMPLE_ARANGOSH_RUN{RestGraphDeleteVertex} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// g.addVertex("v1", {"optional1" : "val1" }); +/// var url = "/_api/graph/graph/vertex/v1"; +/// var response = logCurlRequest('DELETE', url); +/// +/// //assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function delete_graph_vertex (req, res, g) { @@ -797,7 +836,20 @@ function update_graph_vertex (req, res, g, isPatch) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-change-vertex +/// @EXAMPLE_ARANGOSH_RUN{RestGraphChangeVertex} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// g.addVertex("v1", {"optional1" : "val1" }); +/// var url = "/_api/graph/graph/vertex/v1"; +/// var response = logCurlRequest('PUT', url, { "optional1" : "val2" }); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function put_graph_vertex (req, res, g) { @@ -870,7 +922,25 @@ function put_graph_vertex (req, res, g) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-changep-vertex +/// @EXAMPLE_ARANGOSH_RUN{RestGraphChangepVertex} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// g.addVertex("v1", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/vertex/v1"; +/// var response = logCurlRequest('PATCH', url, { "optional1" : "vertexPatch" }); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// var response = logCurlRequest('PATCH', url, { "optional1" : null }); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function patch_graph_vertex (req, res, g) { @@ -997,7 +1067,24 @@ function process_labels_filter (data, labels, collname) { /// /// Select all vertices /// -/// @verbinclude api-graph-get-vertices +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetVertices} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// g.addVertex("v1", { "optional1" : "val1" }); +/// g.addVertex("v2", { "optional1" : "val1" }); +/// g.addVertex("v3", { "optional1" : "val1" }); +/// g.addVertex("v4", { "optional1" : "val1" }); +/// g.addVertex("v5", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/vertices"; +/// var response = logCurlRequest('POST', url, {"batchSize" : 100 }); +/// +/// assert(response.code === 201); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function post_graph_all_vertices (req, res, g) { @@ -1089,13 +1176,56 @@ function post_graph_all_vertices (req, res, g) { /// /// Select all vertices /// -/// @verbinclude api-graph-get-vertex-vertices +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetVertexVertices} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("v1", { "optional1" : "val1" }); +/// var v2 = g.addVertex("v2", { "optional1" : "val1" }); +/// var v3 = g.addVertex("v3", { "optional1" : "val1" }); +/// var v4 = g.addVertex("v4", { "optional1" : "val1" }); +/// var v5 = g.addVertex("v5", { "optional1" : "val1" }); +/// g.addEdge(v1,v5, 1); +/// g.addEdge(v1,v2, 2); +/// g.addEdge(v1,v3, 3); +/// g.addEdge(v2,v4, 4); +/// var url = "/_api/graph/graph/vertices/v2"; +/// var body = '{"batchSize" : 100, "filter" : {"direction" : "any", "properties":'; +/// body += '[] }}'; +/// var response = logCurlRequest('POST', url, body); +/// +/// //assert(response.code === 201); +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN /// /// Select vertices by direction and property filter /// -/// @verbinclude api-graph-get-vertex-vertices2 -/// +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetVertexVertices2} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("v1", { "optional1" : "val1" }); +/// var v2 = g.addVertex("v2", { "optional1" : "val2" }); +/// var v3 = g.addVertex("v3", { "optional1" : "val2" }); +/// var v4 = g.addVertex("v4", { "optional1" : "val2" }); +/// var v5 = g.addVertex("v5", { "optional1" : "val1" }); +/// g.addEdge(v1, v5, 1); +/// g.addEdge(v2, v1, 2); +/// g.addEdge(v1, v3, 3); +/// g.addEdge(v4, v2, 4); +/// var url = "/_api/graph/graph/vertices/v2"; +/// var body = '{"batchSize" : 100, "filter" : {"direction" : "out", "properties":'; +/// body += '[ { "key": "optional1", "value": "val2", "compare" : "==" }, ] }}'; +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 201); /// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function post_graph_vertex_vertices (req, res, g) { @@ -1212,7 +1342,22 @@ function post_graph_vertex_vertices (req, res, g) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-create-edge +/// @EXAMPLE_ARANGOSH_RUN{RestGraphCreateEdge} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var url = "/_api/graph/graph/edge"; +/// g.addVertex("vert1"); +/// g.addVertex("vert2"); +/// var body = {"_key" : "edge1", "_from" : "vert2", "_to" : "vert1", "optional1" : "val1"}; +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function post_graph_edge (req, res, g) { @@ -1304,7 +1449,22 @@ function post_graph_edge (req, res, g) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-get-edge +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetEdge} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var url = "/_api/graph/graph/edge/edge1"; +/// var v1 = g.addVertex("vert1"); +/// var v2 = g.addVertex("vert2"); +/// g.addEdge(v1, v2, "edge1", { "optional1" : "val1" }); +/// var response = logCurlRequest('GET', url); +/// +/// assert(response.code === 200); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function get_graph_edge (req, res, g) { @@ -1375,7 +1535,22 @@ function get_graph_edge (req, res, g) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-delete-edge +/// @EXAMPLE_ARANGOSH_RUN{RestGraphDeleteEdge} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("vert1"); +/// var v2 = g.addVertex("vert2"); +/// g.addEdge(v1, v2, "edge1", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/edge/edge1"; +/// var response = logCurlRequest('DELETE', url); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function delete_graph_edge (req, res, g) { @@ -1526,7 +1701,22 @@ function update_graph_edge (req, res, g, isPatch) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-change-edge +/// @EXAMPLE_ARANGOSH_RUN{RestGraphChangeEdge} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("vert1"); +/// var v2 = g.addVertex("vert2"); +/// g.addEdge(v1, v2, "edge1", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/edge/edge1"; +/// var response = logCurlRequest('PUT', url, { "optional1" : "val2" }); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function put_graph_edge (req, res, g) { @@ -1599,7 +1789,22 @@ function put_graph_edge (req, res, g) { /// /// @EXAMPLES /// -/// @verbinclude api-graph-changep-edge +/// @EXAMPLE_ARANGOSH_RUN{RestGraphChangepEdge} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("vert1"); +/// var v2 = g.addVertex("vert2"); +/// g.addEdge(v1, v2, "edge1", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/edge/edge1"; +/// var response = logCurlRequest('PATCH', url, { "optional3" : "val3" }); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function patch_graph_edge (req, res, g) { @@ -1647,7 +1852,28 @@ function patch_graph_edge (req, res, g) { /// /// Select all edges /// -/// @verbinclude api-graph-get-edges +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetEdges} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("v1", { "optional1" : "val1" }); +/// var v2 = g.addVertex("v2", { "optional1" : "val1" }); +/// var v3 = g.addVertex("v3", { "optional1" : "val1" }); +/// var v4 = g.addVertex("v4", { "optional1" : "val1" }); +/// var v5 = g.addVertex("v5", { "optional1" : "val1" }); +/// g.addEdge(v1, v2, "edge1", { "optional1" : "val1" }); +/// g.addEdge(v1, v3, "edge2", { "optional1" : "val1" }); +/// g.addEdge(v2, v4, "edge3", { "optional1" : "val1" }); +/// g.addEdge(v1, v5, "edge4", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/edges"; +/// var response = logCurlRequest('POST', url, {"batchSize" : 100 }); +/// +/// assert(response.code === 201); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function post_graph_all_edges (req, res, g) { @@ -1752,7 +1978,29 @@ function post_graph_all_edges (req, res, g) { /// /// Select all edges /// -/// @verbinclude api-graph-get-vertex-edges +/// @EXAMPLE_ARANGOSH_RUN{RestGraphGetVertexEdges} +/// var Graph = require("org/arangodb/graph").Graph; +/// var g = new Graph("graph", "vertices", "edges"); +/// var v1 = g.addVertex("v1", { "optional1" : "val1" }); +/// var v2 = g.addVertex("v2", { "optional1" : "val1" }); +/// var v3 = g.addVertex("v3", { "optional1" : "val1" }); +/// var v4 = g.addVertex("v4", { "optional1" : "val1" }); +/// var v5 = g.addVertex("v5", { "optional1" : "val1" }); +/// g.addEdge(v1, v2, "edge1", { "optional1" : "val1" }); +/// g.addEdge(v1, v3, "edge2", { "optional1" : "val1" }); +/// g.addEdge(v2, v4, "edge3", { "optional1" : "val1" }); +/// g.addEdge(v1, v5, "edge4", { "optional1" : "val1" }); +/// var url = "/_api/graph/graph/edges/v2"; +/// var body = '{"batchSize" : 100, "filter" : { "direction" : "any" }}'; +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 201); +/// +/// logJsonResponse(response); +/// db._drop("edges"); +/// db._drop("vertices"); +/// db._graphs.remove("graph"); +/// @END_EXAMPLE_ARANGOSH_RUN //////////////////////////////////////////////////////////////////////////////// function post_graph_vertex_edges (req, res, g) {