diff --git a/.gitignore b/.gitignore index 200e5b7fbb..88365820c8 100644 --- a/.gitignore +++ b/.gitignore @@ -63,8 +63,6 @@ arangosh/cmake_install.cmake cmake_install.cmake lib/cmake_install.cmake -Documentation/Examples/*.generated - arangod/Aql/grammar.output UnitTests/HttpInterface/logs/ diff --git a/Documentation/Examples/RestDocumentHandlerPostOverwrite.generated b/Documentation/Examples/RestDocumentHandlerPostOverwrite.generated new file mode 100644 index 0000000000..ab318d10b2 --- /dev/null +++ b/Documentation/Examples/RestDocumentHandlerPostOverwrite.generated @@ -0,0 +1,31 @@ +shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF +{ "Hello": "World", "_key" : "lock" } +EOF + +HTTP/1.1 201 Created +content-type: application/json; charset=utf-8 +x-content-type-options: nosniff +etag: "_W3YeJtq--_" +location: /_db/_system/_api/document/products/lock + +{ + "_id" : "products/lock", + "_key" : "lock", + "_rev" : "_W3YeJtq--_" +} +shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?overwrite=true <<EOF +{ "Hello": "Universe", "_key" : "lock" } +EOF + +HTTP/1.1 201 Created +content-type: application/json; charset=utf-8 +x-content-type-options: nosniff +etag: "_W3YeJuG--B" +location: /_db/_system/_api/document/products/lock + +{ + "_id" : "products/lock", + "_key" : "lock", + "_rev" : "_W3YeJuG--B", + "_oldRev" : "_W3YeJtq--_" +} diff --git a/Documentation/Examples/documentsCollectionInsertSingleOverwrite.generated b/Documentation/Examples/documentsCollectionInsertSingleOverwrite.generated new file mode 100644 index 0000000000..f67b1b276a --- /dev/null +++ b/Documentation/Examples/documentsCollectionInsertSingleOverwrite.generated @@ -0,0 +1,19 @@ +arangosh> db.example.insert({ _key : "666", Hello : "World" }); +{ + "_id" : "example/666", + "_key" : "666", + "_rev" : "_W3YhC2i--_" +} +arangosh> db.example.insert({ _key : "666", Hello : "Universe" }, {overwrite: true, returnOld: true}); +{ + "_id" : "example/666", + "_key" : "666", + "_rev" : "_W3YhC2q--B", + "_oldRev" : "_W3YhC2i--_", + "old" : { + "_key" : "666", + "_id" : "example/666", + "_rev" : "_W3YhC2i--_", + "Hello" : "World" + } +} diff --git a/js/apps/system/_admin/aardvark/APP/api-docs.json b/js/apps/system/_admin/aardvark/APP/api-docs.json index 62d07f30d5..5a1c690210 100644 --- a/js/apps/system/_admin/aardvark/APP/api-docs.json +++ b/js/apps/system/_admin/aardvark/APP/api-docs.json @@ -72,7 +72,7 @@ "startVertex" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph Traversal/HTTP_API_TRAVERSAL.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph Traversal/HTTP_API_TRAVERSAL.md" }, "PostApiQueryProperties": { "properties": { @@ -85,7 +85,7 @@ "query" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md" }, "PutApiQueryCacheProperties": { "properties": { @@ -104,7 +104,7 @@ "maxResults" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md" }, "PutApiQueryProperties": { "properties": { @@ -148,7 +148,7 @@ "maxQueryStringLength" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md" }, "RestLookupByKeys": { "properties": { @@ -169,7 +169,7 @@ "keys" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" }, "RestRemoveByKeys": { "properties": { @@ -193,7 +193,7 @@ "keys" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md" }, "UserHandling_create": { "properties": { @@ -221,7 +221,7 @@ "passwd" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_grantCollection": { "properties": { @@ -234,7 +234,7 @@ "grant" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_grantDatabase": { "properties": { @@ -247,7 +247,7 @@ "grant" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_modify": { "properties": { @@ -270,7 +270,7 @@ "passwd" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_replace": { "properties": { @@ -293,7 +293,7 @@ "passwd" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "admin_echo_client_struct": { "description": "attributes of the client connection\n\n", @@ -302,7 +302,7 @@ "client" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" }, "admin_echo_server_struct": { "description": "\n", @@ -326,7 +326,7 @@ "server" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" }, "admin_statistics_figures_struct": { "description": "", @@ -480,7 +480,7 @@ "bytesReceived" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "cluster_endpoints_struct": { "description": "", @@ -554,7 +554,7 @@ "indexes" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_alive": { "description": "the currently active figures\n\n", @@ -571,7 +571,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_compactors": { "description": "\n", @@ -588,7 +588,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_datafiles": { "description": "Metrics regarding the datafiles\n\n", @@ -605,7 +605,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_dead": { "description": "the items waiting to be swept away by the cleaner\n\n", @@ -627,7 +627,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_indexes": { "description": "", @@ -644,7 +644,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_journals": { "description": "Metrics regarding the journal files\n\n", @@ -661,7 +661,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_readcache": { "description": "\n", @@ -678,7 +678,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "collection_figures_revisions": { "description": "\n", @@ -695,7 +695,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "compactionStatus_attributes": { "description": "", @@ -710,7 +710,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "delete_api_aqlfunction_rc_200": { "properties": { @@ -736,7 +736,7 @@ "deletedCount" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" }, "delete_api_aqlfunction_rc_400": { "properties": { @@ -767,7 +767,7 @@ "errorMessage" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" }, "delete_api_aqlfunction_rc_404": { "properties": { @@ -798,7 +798,7 @@ "errorMessage" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" }, "delete_api_tasks_rc_200": { "properties": { @@ -818,7 +818,7 @@ "error" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md" }, "delete_api_tasks_rc_404": { "properties": { @@ -843,7 +843,7 @@ "errorMessage" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md" }, "explain_options": { "description": "Options for the query\n\n", @@ -867,7 +867,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md" }, "general_graph_create_http_examples": { "properties": { @@ -896,7 +896,7 @@ "name" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md" }, "general_graph_edge_definition_add_http_examples": { "properties": { @@ -925,7 +925,7 @@ "to" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md" }, "general_graph_edge_definition_modify_http_examples": { "properties": { @@ -954,7 +954,7 @@ "to" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md" }, "get_admin_log_rc_200": { "properties": { @@ -999,7 +999,7 @@ "totalAmount" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" }, "get_admin_server_role_rc_200": { "properties": { @@ -1030,7 +1030,7 @@ "role" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md" }, "get_admin_statistics_description_rc_200": { "properties": { @@ -1066,7 +1066,7 @@ "error" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md" }, "get_admin_statistics_rc_200": { "properties": { @@ -1115,7 +1115,7 @@ "enabled" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "get_admin_time_rc_200": { "properties": { @@ -1141,7 +1141,7 @@ "time" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md" }, "get_api_aqlfunction_rc_200": { "properties": { @@ -1169,7 +1169,7 @@ "result" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md" }, "get_api_aqlfunction_rc_400": { "properties": { @@ -1200,7 +1200,7 @@ "errorMessage" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md" }, "get_api_cluster_endpoints_rc_200": { "properties": { @@ -1228,7 +1228,7 @@ "endpoints" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md" }, "get_api_collection_figures_rc_200": { "properties": { @@ -1251,7 +1251,7 @@ "journalSize" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" }, "get_api_database_new": { "properties": { @@ -1271,7 +1271,7 @@ "name" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md" }, "get_api_database_new_USERS": { "description": "", @@ -1315,7 +1315,7 @@ "version" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_return.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_return.md" }, "get_api_tasks_all_rc_200": { "description": "a list of all tasks\n\n", @@ -1335,7 +1335,7 @@ "name" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_engine.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_engine.md" }, "http_statistics_struct": { "description": "the numbers of requests by Verb\n\n", @@ -1395,7 +1395,7 @@ "http" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "patch_api_view_link_props": { "description": "The link properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n", @@ -1421,7 +1421,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_link_props_field_props": { "description": "The field properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n", @@ -1448,7 +1448,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_links": { "description": "The set of collection names associated with the properties.\n\n", @@ -1458,7 +1458,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_properties_iresearch": { "properties": { @@ -1484,7 +1484,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_props_commit": { "description": "Commit options for regular operations.\n\n", @@ -1499,7 +1499,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_props_consolidation": { "description": "\n", @@ -1534,7 +1534,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_props_consolidation_bytes_accum": { "description": "Use empty object for default values, i.e. {}\n\n", @@ -1551,7 +1551,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_props_consolidation_count": { "description": "Use empty object for default values, i.e. {}\n\n", @@ -1568,7 +1568,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "patch_api_view_props_consolidation_fill": { "description": "Use empty object for default values, i.e. {}\n\n", @@ -1585,7 +1585,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "post_admin_echo_rc_200": { "properties": { @@ -1688,7 +1688,7 @@ "rawRequestBody" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" }, "post_api_aqlfunction": { "properties": { @@ -1711,7 +1711,7 @@ "code" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" }, "post_api_aqlfunction_rc_200": { "properties": { @@ -1731,7 +1731,7 @@ "code" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" }, "post_api_aqlfunction_rc_201": { "properties": { @@ -1751,7 +1751,7 @@ "code" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" }, "post_api_aqlfunction_rc_400": { "properties": { @@ -1782,7 +1782,7 @@ "errorMessage" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" }, "post_api_collection": { "properties": { @@ -1851,7 +1851,7 @@ "name" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md" }, "post_api_collection_opts": { "description": "additional options for key generation. If specified, then *keyOptions*\nshould be a JSON array containing the following attributes:\n\n", @@ -1876,7 +1876,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md" }, "post_api_cursor": { "properties": { @@ -1925,7 +1925,7 @@ "query" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" }, "post_api_cursor_opts": { "description": "key/value object with extra options for the query.\n\n", @@ -1990,7 +1990,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" }, "post_api_cursor_rc_201": { "properties": { @@ -2045,7 +2045,7 @@ "cached" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" }, "post_api_cursor_rc_400": { "properties": { @@ -2076,7 +2076,7 @@ "errorMessage" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" }, "post_api_explain": { "properties": { @@ -2100,7 +2100,7 @@ "query" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md" }, "post_api_export": { "properties": { @@ -2147,7 +2147,7 @@ "ttl" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md" }, "post_api_export_restrictions": { "description": "an object containing an array of attribute names that will be \nincluded or excluded when returning result documents.\n\nNot specifying *restrict* will by default return all attributes of each document.\n\n", @@ -2166,7 +2166,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md" }, "post_api_gharial_create_opts": { "description": "a JSON object which is only useful in Enterprise version and with isSmart set to true.\nIt can contain the following attributes:\n\n", @@ -2182,7 +2182,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md" }, "post_api_index_fulltext": { "properties": { @@ -2209,7 +2209,7 @@ "minLength" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md" }, "post_api_index_geo": { "properties": { @@ -2235,7 +2235,7 @@ "geoJson" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md" }, "post_api_index_hash": { "properties": { @@ -2273,7 +2273,7 @@ "sparse" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md" }, "post_api_index_persistent": { "properties": { @@ -2306,7 +2306,7 @@ "sparse" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md" }, "post_api_index_skiplist": { "properties": { @@ -2344,7 +2344,7 @@ "sparse" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md" }, "post_api_new_tasks": { "properties": { @@ -2377,7 +2377,7 @@ "params" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md" }, "post_api_new_tasks_rc_200": { "properties": { @@ -2435,7 +2435,7 @@ "error" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md" }, "post_api_transaction": { "properties": { @@ -2482,7 +2482,7 @@ "action" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Transactions/post_api_transaction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Transactions/post_api_transaction.md" }, "post_api_view_iresearch": { "properties": { @@ -2503,7 +2503,7 @@ "type" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" }, "post_api_view_link_props": { "description": "The link properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n", @@ -2529,7 +2529,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_link_props_field_props": { "description": "The field properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n", @@ -2556,7 +2556,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_links": { "description": "The set of collection names associated with the properties.\n\n", @@ -2566,7 +2566,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_props": { "description": "The view properties. If specified, then *properties*\nshould be a JSON object containing the following attributes:\n\n", @@ -2594,7 +2594,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" }, "post_api_view_props_commit": { "description": "Commit options for regular operations.\n\nCommit options for regular operations.\n\n", @@ -2614,7 +2614,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_props_consolidation": { "description": "\n\n", @@ -2649,7 +2649,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_props_consolidation_bytes_accum": { "description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n", @@ -2666,7 +2666,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_props_consolidation_count": { "description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n", @@ -2683,7 +2683,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_api_view_props_consolidation_fill": { "description": "Use empty object for default values, i.e. {}\n\nUse empty object for default values, i.e. {}\n\n", @@ -2700,7 +2700,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "post_batch_replication": { "properties": { @@ -2714,7 +2714,7 @@ "ttl" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md" }, "put_admin_loglevel": { "properties": { @@ -2876,7 +2876,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" }, "put_api_new_tasks": { "properties": { @@ -2909,7 +2909,7 @@ "params" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md" }, "put_api_replication_applier_adjust": { "properties": { @@ -3032,7 +3032,7 @@ "restrictType" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md" }, "put_api_replication_makeSlave": { "properties": { @@ -3141,7 +3141,7 @@ "includeSystem" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md" }, "put_api_replication_synchronize": { "properties": { @@ -3193,7 +3193,7 @@ "password" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md" }, "put_api_simple_any": { "properties": { @@ -3206,7 +3206,7 @@ "collection" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_any.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_any.md" }, "put_api_simple_by_example": { "properties": { @@ -3239,7 +3239,7 @@ "limit" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_by_example.md" }, "put_api_simple_first_example": { "properties": { @@ -3257,7 +3257,7 @@ "example" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_first_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_first_example.md" }, "put_api_simple_fulltext": { "properties": { @@ -3295,7 +3295,7 @@ "index" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_fulltext.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_fulltext.md" }, "put_api_simple_near": { "properties": { @@ -3338,7 +3338,7 @@ "geo" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_near.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_near.md" }, "put_api_simple_range": { "properties": { @@ -3382,7 +3382,7 @@ "skip" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_range.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_range.md" }, "put_api_simple_remove_by_example": { "properties": { @@ -3403,7 +3403,7 @@ "example" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_remove_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_remove_by_example.md" }, "put_api_simple_remove_by_example_opts": { "description": "a json object which can contains following attributes:\n\n", @@ -3418,7 +3418,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_remove_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_remove_by_example.md" }, "put_api_simple_remove_by_keys_opts": { "description": "a json object which can contains following attributes:\n\n", @@ -3437,7 +3437,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md" }, "put_api_simple_replace_by_example": { "properties": { @@ -3463,7 +3463,7 @@ "newValue" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_replace_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_replace_by_example.md" }, "put_api_simple_replace_by_example_options": { "description": "a json object which can contain following attributes\n\n", @@ -3478,7 +3478,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_replace_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_replace_by_example.md" }, "put_api_simple_update_by_example": { "properties": { @@ -3505,7 +3505,7 @@ "newValue" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_update_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_update_by_example.md" }, "put_api_simple_update_by_example_options": { "description": "a json object which can contains following attributes:\n\n", @@ -3529,7 +3529,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_update_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_update_by_example.md" }, "put_api_simple_within": { "properties": { @@ -3577,7 +3577,7 @@ "geo" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within.md" }, "put_api_simple_within_rectangle": { "properties": { @@ -3625,7 +3625,7 @@ "geo" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within_rectangle.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within_rectangle.md" }, "put_api_view_properties_iresearch": { "properties": { @@ -3651,7 +3651,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" }, "put_batch_replication": { "properties": { @@ -3665,7 +3665,7 @@ "ttl" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md" }, "put_read_all_documents": { "properties": { @@ -3682,7 +3682,7 @@ "collection" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/put_read_all_documents.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/put_read_all_documents.md" }, "server_statistics_struct": { "description": "statistics of the server\n\n", @@ -3710,7 +3710,7 @@ "threads" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "server_threads_struct": { "description": "Statistics about the server worker threads (excluding V8 specific or jemalloc specific threads and system threads)\n\n", @@ -3737,7 +3737,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "setof_statistics_struct": { "description": "total connection times\n\nthe system time \n\nthe request times\n\nthe time requests were queued waiting for processing\n\nIO Time\n\nnumber of bytes sent to the clients\n\nnumber of bytes received from the clients\n\n\n", @@ -3811,7 +3811,7 @@ "system" ], "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "v8_context_struct": { "description": "Statistics about the V8 javascript contexts\n\n", @@ -3843,7 +3843,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" }, "version_details_struct": { "description": "an optional JSON object with additional details. This is\nreturned only if the *details* query parameter is set to *true* in the\nrequest.\n\n", @@ -3982,7 +3982,7 @@ } }, "type": "object", - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_return.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_return.md" } }, "info": { @@ -4008,7 +4008,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cluster/get_cluster_health.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cluster/get_cluster_health.md" } }, "/_admin/clusterStatistics": { @@ -4039,7 +4039,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cluster/get_cluster_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cluster/get_cluster_statistics.md" } }, "/_admin/database/target-version": { @@ -4056,7 +4056,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_database_version.md" } }, "/_admin/echo": { @@ -4092,7 +4092,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_admin_echo.md" } }, "/_admin/execute": { @@ -4127,7 +4127,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_admin_execute.md" } }, "/_admin/log": { @@ -4207,7 +4207,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" } }, "/_admin/log/level": { @@ -4227,7 +4227,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" }, "put": { "description": "\n\nModifies and returns the server's current loglevel settings.\nThe request body must be a JSON object with the log topics being the object keys\nand the log levels being the object values.\n\nThe result is a JSON object with the adjusted log topics being the object keys, and\nthe adjusted log levels being the object values.\n\nIt can set the loglevel of all facilities by only specifying the loglevel as string without json.\n\nPossible loglevels are:\n - FATAL - There will be no way out of this. ArangoDB will go down after this message.\n - ERROR - This is an error. you should investigate and fix it. It may harm your production.\n - WARNING - This may be serious application-wise, but we don't know.\n - INFO - Something has happened, take notice, but no drama attached.\n - DEBUG - output debug messages\n - TRACE - trace - prepare your log to be flooded - don't use in production.\n\n\n**A JSON object with these properties is required:**\n\n - **audit-service**: One of the possible loglevels.\n - **cache**: One of the possible loglevels.\n - **syscall**: One of the possible loglevels.\n - **communication**: One of the possible loglevels.\n - **audit-authentication**: One of the possible loglevels.\n - **agencycomm**: One of the possible loglevels.\n - **startup**: One of the possible loglevels.\n - **general**: One of the possible loglevels.\n - **cluster**: One of the possible loglevels.\n - **audit-view**: One of the possible loglevels.\n - **collector**: One of the possible loglevels.\n - **audit-documentation**: One of the possible loglevels.\n - **engines**: One of the possible loglevels.\n - **trx**: One of the possible loglevels.\n - **mmap**: One of the possible loglevels.\n - **agency**: One of the possible loglevels.\n - **authentication**: One of the possible loglevels.\n - **memory**: One of the possible loglevels.\n - **performance**: One of the possible loglevels.\n - **config**: One of the possible loglevels.\n - **authorization**: One of the possible loglevels.\n - **development**: One of the possible loglevels.\n - **datafiles**: One of the possible loglevels.\n - **views**: One of the possible loglevels.\n - **ldap**: One of the possible loglevels.\n - **replication**: One of the possible loglevels.\n - **threads**: One of the possible loglevels.\n - **audit-database**: One of the possible loglevels.\n - **v8**: One of the possible loglevels.\n - **ssl**: One of the possible loglevels.\n - **pregel**: One of the possible loglevels.\n - **audit-collection**: One of the possible loglevels.\n - **rocksdb**: One of the possible loglevels.\n - **supervision**: One of the possible loglevels.\n - **graphs**: One of the possible loglevels.\n - **compactor**: One of the possible loglevels.\n - **queries**: One of the possible loglevels.\n - **heartbeat**: One of the possible loglevels.\n - **requests**: One of the possible loglevels.\n\n\n", @@ -4261,7 +4261,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_modules_flush.md" } }, "/_admin/routing/reload": { @@ -4278,7 +4278,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_routing_reloads.md" } }, "/_admin/server/availability": { @@ -4298,7 +4298,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_server_availability.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_server_availability.md" } }, "/_admin/server/id": { @@ -4318,7 +4318,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_server_id.md" } }, "/_admin/server/role": { @@ -4342,7 +4342,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_server_role.md" } }, "/_admin/shutdown": { @@ -4359,7 +4359,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/delete_api_shutdown.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/delete_api_shutdown.md" } }, "/_admin/statistics": { @@ -4383,7 +4383,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics.md" } }, "/_admin/statistics-description": { @@ -4407,7 +4407,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_statistics_description.md" } }, "/_admin/status": { @@ -4424,7 +4424,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_status.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_status.md" } }, "/_admin/time": { @@ -4448,7 +4448,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_admin_time.md" } }, "/_admin/wal/flush": { @@ -4483,7 +4483,7 @@ "wal" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/wal/put_admin_wal_flush.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/wal/put_admin_wal_flush.md" } }, "/_admin/wal/properties": { @@ -4503,7 +4503,7 @@ "wal" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/wal/get_admin_wal_properties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/wal/get_admin_wal_properties.md" }, "put": { "description": "\n\nConfigures the behavior of the write-ahead log. The body of the request\nmust be a JSON object with the following attributes:\n- *allowOversizeEntries*: whether or not operations that are bigger than a\n single logfile can be executed and stored\n- *logfileSize*: the size of each write-ahead logfile\n- *historicLogfiles*: the maximum number of historic logfiles to keep\n- *reserveLogfiles*: the maximum number of reserve logfiles that ArangoDB\n allocates in the background\n- *throttleWait*: the maximum wait time that operations will wait before\n they get aborted if case of write-throttling (in milliseconds)\n- *throttleWhenPending*: the number of unprocessed garbage-collection\n operations that, when reached, will activate write-throttling. A value of\n *0* means that write-throttling will not be triggered.\n\nSpecifying any of the above attributes is optional. Not specified attributes\nwill be ignored and the configuration for them will not be modified.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_admin/wal/properties <<EOF\n{ \n  \"logfileSize\" : 33554432, \n  \"allowOversizeEntries\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"allowOversizeEntries\" : true, \n  \"logfileSize\" : 33554432, \n  \"historicLogfiles\" : 10, \n  \"reserveLogfiles\" : 3, \n  \"syncInterval\" : 100, \n  \"throttleWait\" : 15000, \n  \"throttleWhenPending\" : 0 \n}\n
\n\n\n\n\n", @@ -4521,7 +4521,7 @@ "wal" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/wal/put_admin_wal_properties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/wal/put_admin_wal_properties.md" } }, "/_admin/wal/transactions": { @@ -4541,7 +4541,7 @@ "wal" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/wal/get_admin_wal_transactions.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/wal/get_admin_wal_transactions.md" } }, "/_api/aqlfunction": { @@ -4580,7 +4580,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/get_api_aqlfunction.md" }, "post": { "description": "\n**A JSON object with these properties is required:**\n\n - **isDeterministic**: an optional boolean value to indicate whether the function\n results are fully deterministic (function return value solely depends on\n the input value and return value is the same for repeated calls with same\n input). The *isDeterministic* attribute is currently not used but may be\n used later for optimisations.\n - **code**: a string representation of the function body.\n - **name**: the fully qualified name of the user functions.\n\n\n\n\n\nIn case of success, HTTP 200 is returned.\nIf the function isn't valid etc. HTTP 400 including a detailed error message will be returned.\n\n\n#### HTTP 200\n*A json document with these Properties is returned:*\n\nIf the function already existed and was replaced by the\ncall, the server will respond with *HTTP 200*.\n\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*false* in this case)\n\n\n#### HTTP 201\n*A json document with these Properties is returned:*\n\nIf the function can be registered by the server, the server will respond with\n*HTTP 201*.\n\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*false* in this case)\n\n\n#### HTTP 400\n*A json document with these Properties is returned:*\n\nIf the JSON representation is malformed or mandatory data is missing from the\nrequest, the server will respond with *HTTP 400*.\n\n- **errorMessage**: a descriptive error message\n- **errorNum**: the server error number\n- **code**: the HTTP status code\n- **error**: boolean flag to indicate whether an error occurred (*true* in this case)\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/aqlfunction <<EOF\n{ \n  \"name\" : \"myfunctions::temperature::celsiustofahrenheit\", \n  \"code\" : \"function (celsius) { return celsius * 1.8 + 32; }\", \n  \"isDeterministic\" : true \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", @@ -4626,7 +4626,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_aqlfunction.md" } }, "/_api/aqlfunction/{name}": { @@ -4680,7 +4680,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/delete_api_aqlfunction.md" } }, "/_api/batch": { @@ -4715,7 +4715,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Bulk/batch_processing.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Bulk/batch_processing.md" } }, "/_api/cluster/endpoints": { @@ -4742,7 +4742,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_cluster_endpoints.md" } }, "/_api/collection": { @@ -4767,7 +4767,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collections.md" }, "post": { "description": "\n\nCreates a new collection with a given name. The request must contain an\nobject with the following attributes.\n\n\n**A JSON object with these properties is required:**\n\n - **journalSize**: The maximal size of a journal or datafile in bytes. The value\n must be at least `1048576` (1 MiB). (The default is a configuration parameter)\n This option is meaningful for the MMFiles storage engine only.\n - **replicationFactor**: (The default is *1*): in a cluster, this attribute determines how many copies\n of each shard are kept on different DBServers. The value 1 means that only one\n copy (no synchronous replication) is kept. A value of k means that k-1 replicas\n are kept. Any two copies reside on different DBServers. Replication between them is \n synchronous, that is, every write operation to the \"leader\" copy will be replicated \n to all \"follower\" replicas, before the write operation is reported successful.\n If a server fails, this is detected automatically and one of the servers holding \n copies take over, usually without an error being reported.\n - **keyOptions**:\n - **allowUserKeys**: if set to *true*, then it is allowed to supply own key values in the\n *_key* attribute of a document. If set to *false*, then the key generator\n will solely be responsible for generating keys and supplying own key values\n in the *_key* attribute of documents is considered an error.\n - **type**: specifies the type of the key generator. The currently available generators are\n *traditional* and *autoincrement*.\n - **increment**: increment value for *autoincrement* key generator. Not used for other key\n generator types.\n - **offset**: Initial offset value for *autoincrement* key generator.\n Not used for other key generator types.\n - **name**: The name of the collection.\n - **waitForSync**: If *true* then the data is synchronized to disk before returning from a\n document create, update, replace or removal operation. (default: false)\n - **doCompact**: whether or not the collection will be compacted (default is *true*)\n This option is meaningful for the MMFiles storage engine only.\n - **isVolatile**: If *true* then the collection data is kept in-memory only and not made persistent.\n Unloading the collection will cause the collection data to be discarded. Stopping\n or re-starting the server will also cause full loss of data in the\n collection. Setting this option will make the resulting collection be\n slightly faster than regular collections because ArangoDB does not\n enforce any synchronization to disk and does not calculate any CRC\n checksums for datafiles (as there are no datafiles). This option\n should therefore be used for cache-type collections only, and not\n for data that cannot be re-created otherwise.\n (The default is *false*)\n This option is meaningful for the MMFiles storage engine only.\n - **shardKeys**: (The default is *[ \"_key\" ]*): in a cluster, this attribute determines\n which document attributes are used to determine the target shard for documents.\n Documents are sent to shards based on the values of their shard key attributes.\n The values of all shard key attributes in a document are hashed,\n and the hash value is used to determine the target shard.\n **Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n - **numberOfShards**: (The default is *1*): in a cluster, this value determines the\n number of shards to create for the collection. In a single\n server setup, this option is meaningless.\n - **isSystem**: If *true*, create a system collection. In this case *collection-name*\n should start with an underscore. End users should normally create non-system\n collections only. API implementors may be required to create system\n collections in very special occasions, but normally a regular collection will do.\n (The default is *false*)\n - **type**: (The default is *2*): the type of the collection to create.\n The following values for *type* are valid:\n - *2*: document collection\n - *3*: edges collection\n - **indexBuckets**: The number of buckets into which indexes using a hash\n table are split. The default is 16 and this number has to be a\n power of 2 and less than or equal to 1024.\n For very large collections one should increase this to avoid long pauses\n when the hash table has to be initially built or resized, since buckets\n are resized individually and can be initially built in parallel. For\n example, 64 might be a sensible value for a collection with 100\n 000 000 documents. Currently, only the edge index respects this\n value, but other index types might follow in future ArangoDB versions.\n Changes (see below) are applied when the collection is loaded the next\n time.\n This option is meaningful for the MMFiles storage engine only.\n - **distributeShardsLike**: (The default is *\"\"*): in an enterprise cluster, this attribute binds\n the specifics of sharding for the newly created collection to follow that of a\n specified existing collection.\n **Note**: Using this parameter has consequences for the prototype\n collection. It can no longer be dropped, before sharding imitating\n collections are dropped. Equally, backups and restores of imitating\n collections alone will generate warnings, which can be overridden,\n about missing sharding prototype.\n\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionBasics\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"status\" : 3, \n  \"statusString\" : \"loaded\", \n  \"name\" : \"testCollectionBasics\", \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true, \n    \"lastValue\" : 0 \n  }, \n  \"type\" : 2, \n  \"indexBuckets\" : 8, \n  \"globallyUniqueId\" : \"h1AA24B099AC2/11464\", \n  \"doCompact\" : true, \n  \"waitForSync\" : false, \n  \"id\" : \"11464\", \n  \"isSystem\" : false, \n  \"journalSize\" : 33554432, \n  \"isVolatile\" : false \n}\nshell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionEdges\", \n  \"type\" : 3 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"status\" : 3, \n  \"statusString\" : \"loaded\", \n  \"name\" : \"testCollectionEdges\", \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true, \n    \"lastValue\" : 0 \n  }, \n  \"type\" : 3, \n  \"indexBuckets\" : 8, \n  \"globallyUniqueId\" : \"h1AA24B099AC2/11467\", \n  \"doCompact\" : true, \n  \"waitForSync\" : false, \n  \"id\" : \"11467\", \n  \"isSystem\" : false, \n  \"journalSize\" : 33554432, \n  \"isVolatile\" : false \n}\n
\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionUsers\", \n  \"keyOptions\" : { \n    \"type\" : \"autoincrement\", \n    \"increment\" : 5, \n    \"allowUserKeys\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"status\" : 3, \n  \"statusString\" : \"loaded\", \n  \"name\" : \"testCollectionUsers\", \n  \"keyOptions\" : { \n    \"type\" : \"autoincrement\", \n    \"allowUserKeys\" : true, \n    \"offset\" : 0, \n    \"increment\" : 5, \n    \"lastValue\" : 0 \n  }, \n  \"type\" : 2, \n  \"indexBuckets\" : 8, \n  \"globallyUniqueId\" : \"h1AA24B099AC2/11472\", \n  \"doCompact\" : true, \n  \"waitForSync\" : false, \n  \"id\" : \"11472\", \n  \"isSystem\" : false, \n  \"journalSize\" : 33554432, \n  \"isVolatile\" : false \n}\n
\n\n\n\n\n", @@ -4809,7 +4809,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/post_api_collection.md" } }, "/_api/collection/{collection-name}": { @@ -4845,7 +4845,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/delete_api_collection.md" }, "get": { "description": "\n\nThe result is an object describing the collection with the following\nattributes:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *status*: The status of the collection as number.\n - 1: new born collection\n - 2: unloaded\n - 3: loaded\n - 4: in the process of being unloaded\n - 5: deleted\n - 6: loading\n\nEvery other status indicates a corrupted collection.\n\n- *type*: The type of the collection as number.\n - 2: document collection (normal case)\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n", @@ -4869,7 +4869,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_name.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_name.md" } }, "/_api/collection/{collection-name}/checksum": { @@ -4912,7 +4912,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_checksum.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_checksum.md" } }, "/_api/collection/{collection-name}/count": { @@ -4941,7 +4941,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_count.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_count.md" } }, "/_api/collection/{collection-name}/figures": { @@ -4980,7 +4980,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_figures.md" } }, "/_api/collection/{collection-name}/load": { @@ -5009,7 +5009,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load.md" } }, "/_api/collection/{collection-name}/loadIndexesIntoMemory": { @@ -5041,7 +5041,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_load_indexes_in_memory.md" } }, "/_api/collection/{collection-name}/properties": { @@ -5070,7 +5070,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_properties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_properties.md" }, "put": { "description": "\n\nChanges the properties of a collection. Expects an object with the\nattribute(s)\n\n- *waitForSync*: If *true* then creating or changing a\n document will wait until the data has been synchronized to disk.\n\n- *journalSize*: The maximal size of a journal or datafile in bytes. \n The value must be at least `1048576` (1 MB). Note that when\n changing the journalSize value, it will only have an effect for\n additional journals or datafiles that are created. Already\n existing journals or datafiles will not be affected.\n\nOn success an object with the following attributes is returned:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *waitForSync*: The new value.\n\n- *journalSize*: The new value.\n\n- *status*: The status of the collection as number.\n\n- *type*: The collection type. Valid types are:\n - 2: document collection\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional* and *autoincrement*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n**Note**: except for *waitForSync*, *journalSize* and *name*, collection\nproperties **cannot be changed** once a collection is created. To rename\na collection, the rename endpoint must be used.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/properties <<EOF\n{ \n  \"waitForSync\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\nlocation: /_api/collection/products/properties\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"status\" : 3, \n  \"statusString\" : \"loaded\", \n  \"name\" : \"products\", \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true, \n    \"lastValue\" : 0 \n  }, \n  \"type\" : 2, \n  \"indexBuckets\" : 8, \n  \"globallyUniqueId\" : \"h1AA24B099AC2/11863\", \n  \"doCompact\" : true, \n  \"waitForSync\" : true, \n  \"id\" : \"11863\", \n  \"isSystem\" : false, \n  \"journalSize\" : 33554432, \n  \"isVolatile\" : false \n}\n
\n\n\n\n\n", @@ -5097,7 +5097,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_properties.md" } }, "/_api/collection/{collection-name}/rename": { @@ -5126,7 +5126,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rename.md" } }, "/_api/collection/{collection-name}/revision": { @@ -5155,7 +5155,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/get_api_collection_revision.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/get_api_collection_revision.md" } }, "/_api/collection/{collection-name}/rotate": { @@ -5184,7 +5184,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/truncate": { @@ -5213,7 +5213,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_truncate.md" } }, "/_api/collection/{collection-name}/unload": { @@ -5242,7 +5242,7 @@ "Collections" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Collections/put_api_collection_unload.md" } }, "/_api/cursor": { @@ -5289,7 +5289,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor.md" } }, "/_api/cursor/{cursor-identifier}": { @@ -5318,7 +5318,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_delete.md" }, "put": { "description": "\n\nIf the cursor is still alive, returns an object with the following\nattributes:\n\n- *id*: the *cursor-identifier*\n- *result*: a list of documents for the current batch\n- *hasMore*: *false* if this was the last batch\n- *count*: if present the total number of elements\n\nNote that even if *hasMore* returns *true*, the next call might\nstill return no documents. If, however, *hasMore* is *false*, then\nthe cursor is exhausted. Once the *hasMore* attribute has a value of\n*false*, the client can stop.\n\n\n\n\n**Example:**\n Valid request for next batch\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 5 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/cursor/12019\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"result\" : [ \n    { \n      \"_key\" : \"12013\", \n      \"_id\" : \"products/12013\", \n      \"_rev\" : \"_WnWW0km--F\", \n      \"hello4\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"12003\", \n      \"_id\" : \"products/12003\", \n      \"_rev\" : \"_WnWW0km--_\", \n      \"hello1\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"12019\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00010180473327636719 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false \n}\n
\n\n\n\n\n**Example:**\n Missing identifier\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting PUT /_api/cursor/<cursor-id>\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n**Example:**\n Unknown identifier\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/cursor/123123\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cursor not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1600 \n}\n
\n\n\n\n\n", @@ -5348,7 +5348,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Cursors/post_api_cursor_identifier.md" } }, "/_api/database": { @@ -5371,7 +5371,7 @@ "Database" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Database/get_api_database_list.md" }, "post": { "description": "\n**A JSON object with these properties is required:**\n\n - **name**: Has to contain a valid database name.\n - **users**: Has to be an array of user objects to initially create for the new database.\n User information will not be changed for users that already exist.\n If *users* is not specified or does not contain any users, a default user\n *root* will be created with an empty string password. This ensures that the\n new database will be accessible after it is created.\n Each user object can contain the following attributes:\n - **username**: Loginname of the user to be created\n - **passwd**: The user password as a string. If not specified, it will default to an empty string.\n - **active**: A flag indicating whether the user account should be activated or not.\n The default value is *true*. If set to *false*, the user won't be able to\n log into the database.\n - **extra**: A JSON object with extra user information. The data contained in *extra*\n will be stored for the user but not be interpreted further by ArangoDB.\n\n\n\n\nCreates a new database\n\nThe response is a JSON object with the attribute *result* set to *true*.\n\n**Note**: creating a new database is only possible from within the *_system* database.\n\n\n\n\n**Example:**\n Creating a database named *example*.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database <<EOF\n{ \n  \"name\" : \"example\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : true \n}\n
\n\n\n\n\n**Example:**\n Creating a database named *mydb* with two users.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database <<EOF\n{ \n  \"name\" : \"mydb\", \n  \"users\" : [ \n    { \n      \"username\" : \"admin\", \n      \"passwd\" : \"secret\", \n      \"active\" : true \n    }, \n    { \n      \"username\" : \"tester\", \n      \"passwd\" : \"test001\", \n      \"active\" : false \n    } \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : true \n}\n
\n\n\n\n\n", @@ -5405,7 +5405,7 @@ "Database" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Database/get_api_database_new.md" } }, "/_api/database/current": { @@ -5428,7 +5428,7 @@ "Database" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Database/get_api_database_current.md" } }, "/_api/database/user": { @@ -5448,7 +5448,7 @@ "Database" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Database/get_api_database_user.md" } }, "/_api/database/{database-name}": { @@ -5483,7 +5483,7 @@ "Database" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Database/get_api_database_delete.md" } }, "/_api/document/{collection}": { @@ -5547,7 +5547,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/delete_mutliple_documents.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/delete_mutliple_documents.md" }, "patch": { "description": "\n\nPartially updates documents, the documents to update are specified\nby the *_key* attributes in the body objects. The body of the\nrequest must contain a JSON array of document updates with the\nattributes to patch (the patch documents). All attributes from the\npatch documents will be added to the existing documents if they do\nnot yet exist, and overwritten in the existing documents if they do\nexist there.\n\nSetting an attribute value to *null* in the patch documents will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a\ndocument in the body and its value does not match the revision of\nthe corresponding document in the database, the precondition is\nviolated.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nThe body of the response contains a JSON array of the same length\nas the input array with the information about the handle and the\nrevision of the updated documents. In each entry, the attribute\n*_id* contains the known *document-handle* of each updated document,\n*_key* contains the key which uniquely identifies a document in a\ngiven collection, and the attribute *_rev* contains the new document\nrevision. In case of an error or violated precondition, an error\nobject with the attribute *error* set to *true* and the attribute\n*errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each\ngenerated document, the complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 201 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n", @@ -5633,10 +5633,10 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/patch_update_multiple_documents.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/patch_update_multiple_documents.md" }, "post": { - "description": "\n\nCreates a new document from the document given in the body, unless there\nis already a document with the *_key* given. If no *_key* is given, a new\nunique *_key* is generated automatically.\n\nThe body can be an array of documents, in which case all\ndocuments in the array are inserted with the same semantics as for a\nsingle document. The result body will contain a JSON array of the\nsame length as the input array, and each entry contains the result\nof the operation for the corresponding input. In case of an error\nthe entry is a document with attributes *error* set to *true* and\nerrorCode set to the error code that has happened.\n\nPossibly given *_id* and *_rev* attributes in the body are always ignored,\nthe URL part or the query parameter collection respectively counts.\n\nIf the document was created successfully, then the *Location* header\ncontains the path to the newly created document. The *Etag* header field\ncontains the revision of the document. Both are only set in the single\ndocument case.\n\nIf *silent* is not set to *true*, the body of the response contains a \nJSON object (single document case) with the following attributes:\n\n - *_id* contains the document handle of the newly created document\n - *_key* contains the document key\n - *_rev* contains the document revision\n\nIn the multi case the body is an array of such objects.\n\nIf the collection parameter *waitForSync* is *false*, then the call\nreturns as soon as the document has been accepted. It will not wait\nuntil the documents have been synced to disk.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document creation operation to disk even in\ncase that the *waitForSync* flag had been disabled for the entire\ncollection. Thus, the *waitForSync* query parameter can be used to\nforce synchronization of just this specific operations. To use this,\nset the *waitForSync* parameter to *true*. If the *waitForSync*\nparameter is not specified or set to *false*, then the collection's\ndefault *waitForSync* behavior is applied. The *waitForSync* query\nparameter cannot be used to disable synchronization for collections\nthat have a default *waitForSync* value of *true*.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\n\n\n\n**Example:**\n Create a document in a collection named *products*. Note that the\nrevision identifier might or might not by equal to the auto-generated\nkey.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1Ey--_\"\nlocation: /_db/_system/_api/document/products/12271\n\n{ \n  \"_id\" : \"products/12271\", \n  \"_key\" : \"12271\", \n  \"_rev\" : \"_WnWW1Ey--_\" \n}\n
\n\n\n\n\n**Example:**\n Create a document in a collection named *products* with a collection-level\n*waitForSync* value of *false*.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1DC--_\"\nlocation: /_db/_system/_api/document/products/12259\n\n{ \n  \"_id\" : \"products/12259\", \n  \"_key\" : \"12259\", \n  \"_rev\" : \"_WnWW1DC--_\" \n}\n
\n\n\n\n\n**Example:**\n Create a document in a collection with a collection-level *waitForSync*\nvalue of *false*, but using the *waitForSync* query parameter.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?waitForSync=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1G6--_\"\nlocation: /_db/_system/_api/document/products/12301\n\n{ \n  \"_id\" : \"products/12301\", \n  \"_key\" : \"12301\", \n  \"_rev\" : \"_WnWW1G6--_\" \n}\n
\n\n\n\n\n**Example:**\n Unknown collection name\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection or view not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n**Example:**\n Illegal document\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"VPackError error: Expecting '\\\"' or '}'\", \n  \"code\" : 400, \n  \"errorNum\" : 600 \n}\n
\n\n\n\n\n**Example:**\n Insert multiple documents:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n[{\"Hello\":\"Earth\"}, {\"Hello\":\"Venus\"}, {\"Hello\":\"Mars\"}]\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"_id\" : \"products/12279\", \n    \"_key\" : \"12279\", \n    \"_rev\" : \"_WnWW1Fm--_\" \n  }, \n  { \n    \"_id\" : \"products/12283\", \n    \"_key\" : \"12283\", \n    \"_rev\" : \"_WnWW1Fm--B\" \n  }, \n  { \n    \"_id\" : \"products/12285\", \n    \"_key\" : \"12285\", \n    \"_rev\" : \"_WnWW1Fm--D\" \n  } \n]\n
\n\n\n\n\n**Example:**\n Use of returnNew:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?returnNew=true <<EOF\n{\"Hello\":\"World\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1GO--_\"\nlocation: /_db/_system/_api/document/products/12293\n\n{ \n  \"_id\" : \"products/12293\", \n  \"_key\" : \"12293\", \n  \"_rev\" : \"_WnWW1GO--_\", \n  \"new\" : { \n    \"_key\" : \"12293\", \n    \"_id\" : \"products/12293\", \n    \"_rev\" : \"_WnWW1GO--_\", \n    \"Hello\" : \"World\" \n  } \n}\n
\n\n\n\n\n", + "description": "\n\nCreates a new document from the document given in the body, unless there\nis already a document with the *_key* given. If no *_key* is given, a new\nunique *_key* is generated automatically.\n\nThe body can be an array of documents, in which case all\ndocuments in the array are inserted with the same semantics as for a\nsingle document. The result body will contain a JSON array of the\nsame length as the input array, and each entry contains the result\nof the operation for the corresponding input. In case of an error\nthe entry is a document with attributes *error* set to *true* and\nerrorCode set to the error code that has happened.\n\nPossibly given *_id* and *_rev* attributes in the body are always ignored,\nthe URL part or the query parameter collection respectively counts.\n\nIf the document was created successfully, then the *Location* header\ncontains the path to the newly created document. The *Etag* header field\ncontains the revision of the document. Both are only set in the single\ndocument case.\n\nIf *silent* is not set to *true*, the body of the response contains a \nJSON object (single document case) with the following attributes:\n\n - *_id* contains the document handle of the newly created document\n - *_key* contains the document key\n - *_rev* contains the document revision\n\nIn the multi case the body is an array of such objects.\n\nIf the collection parameter *waitForSync* is *false*, then the call\nreturns as soon as the document has been accepted. It will not wait\nuntil the documents have been synced to disk.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document creation operation to disk even in\ncase that the *waitForSync* flag had been disabled for the entire\ncollection. Thus, the *waitForSync* query parameter can be used to\nforce synchronization of just this specific operations. To use this,\nset the *waitForSync* parameter to *true*. If the *waitForSync*\nparameter is not specified or set to *false*, then the collection's\ndefault *waitForSync* behavior is applied. The *waitForSync* query\nparameter cannot be used to disable synchronization for collections\nthat have a default *waitForSync* value of *true*.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\n\n\n\n**Example:**\n Create a document in a collection named *products*. Note that the\nrevision identifier might or might not by equal to the auto-generated\nkey.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1Ey--_\"\nlocation: /_db/_system/_api/document/products/12271\n\n{ \n  \"_id\" : \"products/12271\", \n  \"_key\" : \"12271\", \n  \"_rev\" : \"_WnWW1Ey--_\" \n}\n
\n\n\n\n\n**Example:**\n Create a document in a collection named *products* with a collection-level\n*waitForSync* value of *false*.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1DC--_\"\nlocation: /_db/_system/_api/document/products/12259\n\n{ \n  \"_id\" : \"products/12259\", \n  \"_key\" : \"12259\", \n  \"_rev\" : \"_WnWW1DC--_\" \n}\n
\n\n\n\n\n**Example:**\n Create a document in a collection with a collection-level *waitForSync*\nvalue of *false*, but using the *waitForSync* query parameter.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?waitForSync=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1G6--_\"\nlocation: /_db/_system/_api/document/products/12301\n\n{ \n  \"_id\" : \"products/12301\", \n  \"_key\" : \"12301\", \n  \"_rev\" : \"_WnWW1G6--_\" \n}\n
\n\n\n\n\n**Example:**\n Unknown collection name\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection or view not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n**Example:**\n Illegal document\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"VPackError error: Expecting '\\\"' or '}'\", \n  \"code\" : 400, \n  \"errorNum\" : 600 \n}\n
\n\n\n\n\n**Example:**\n Insert multiple documents:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n[{\"Hello\":\"Earth\"}, {\"Hello\":\"Venus\"}, {\"Hello\":\"Mars\"}]\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"_id\" : \"products/12279\", \n    \"_key\" : \"12279\", \n    \"_rev\" : \"_WnWW1Fm--_\" \n  }, \n  { \n    \"_id\" : \"products/12283\", \n    \"_key\" : \"12283\", \n    \"_rev\" : \"_WnWW1Fm--B\" \n  }, \n  { \n    \"_id\" : \"products/12285\", \n    \"_key\" : \"12285\", \n    \"_rev\" : \"_WnWW1Fm--D\" \n  } \n]\n
\n\n\n\n\n**Example:**\n Use of returnNew:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?returnNew=true <<EOF\n{\"Hello\":\"World\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1GO--_\"\nlocation: /_db/_system/_api/document/products/12293\n\n{ \n  \"_id\" : \"products/12293\", \n  \"_key\" : \"12293\", \n  \"_rev\" : \"_WnWW1GO--_\", \n  \"new\" : { \n    \"_key\" : \"12293\", \n    \"_id\" : \"products/12293\", \n    \"_rev\" : \"_WnWW1GO--_\", \n    \"Hello\" : \"World\" \n  } \n}\n
\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\", \"_key\" : \"lock\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_W3YeJtq--_\"\nlocation: /_db/_system/_api/document/products/lock\n\n{ \n  \"_id\" : \"products/lock\", \n  \"_key\" : \"lock\", \n  \"_rev\" : \"_W3YeJtq--_\" \n}\nshell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?overwrite=true <<EOF\n{ \"Hello\": \"Universe\", \"_key\" : \"lock\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_W3YeJuG--B\"\nlocation: /_db/_system/_api/document/products/lock\n\n{ \n  \"_id\" : \"products/lock\", \n  \"_key\" : \"lock\", \n  \"_rev\" : \"_W3YeJuG--B\", \n  \"_oldRev\" : \"_W3YeJtq--_\" \n}\n
\n\n\n\n\n\n", "parameters": [ { "description": "The *collection* in which the collection is to be created.\n\n", @@ -5678,12 +5678,26 @@ "required": false, "type": "boolean" }, + { + "description": "Additionally return the complete old document under the attribute *old*\nin the result. Only available if the overwrite option is used.\n\n", + "in": "query", + "name": "returnOld", + "required": false, + "type": "boolean" + }, { "description": "If set to *true*, an empty object will be returned as response. No meta-data \nwill be returned for the created document. This option can be used to\nsave some network traffic.\n\n", "in": "query", "name": "silent", "required": false, "type": "boolean" + }, + { + "description": "If set to *true*, the insert becomes a replace-insert. If a document with the\nsame *_key* already exists the new document is not rejected with unique\nconstraint violated but will replace the old document.\n\n", + "in": "query", + "name": "overwrite", + "required": false, + "type": "boolean" } ], "responses": { @@ -5708,7 +5722,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/post_create_document.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/post_create_document.md" }, "put": { "description": "\n\nReplaces multiple documents in the specified collection with the\nones in the body, the replaced documents are specified by the *_key*\nattributes in the body documents.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a\ndocument in the body and its value does not match the revision of\nthe corresponding document in the database, the precondition is\nviolated.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nThe body of the response contains a JSON array of the same length\nas the input array with the information about the handle and the\nrevision of the replaced documents. In each entry, the attribute\n*_id* contains the known *document-handle* of each updated document,\n*_key* contains the key which uniquely identifies a document in a\ngiven collection, and the attribute *_rev* contains the new document\nrevision. In case of an error or violated precondition, an error\nobject with the attribute *error* set to *true* and the attribute\n*errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each\ngenerated document, the complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 201 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n", @@ -5780,7 +5794,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/put_replace_multiple_documents.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/put_replace_multiple_documents.md" } }, "/_api/document/{document-handle}": { @@ -5842,7 +5856,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/delete_remove_document.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/delete_remove_document.md" }, "get": { "description": "\n\nReturns the document identified by *document-handle*. The returned\ndocument contains three special attributes: *_id* containing the document\nhandle, *_key* containing key which uniquely identifies a document\nin a given collection and *_rev* containing the revision.\n\n\n\n\n**Example:**\n Use a document handle:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/12309\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1Hq--_\"\n\n{ \n  \"_key\" : \"12309\", \n  \"_id\" : \"products/12309\", \n  \"_rev\" : \"_WnWW1Hq--_\", \n  \"hello\" : \"world\" \n}\n
\n\n\n\n\n**Example:**\n Use a document handle and an Etag:\n\n
shell> curl --header 'If-None-Match: \"_WnWW1KC--_\"' --dump - http://localhost:8529/_api/document/products/12357\n\n
\n\n\n\n\n**Example:**\n Unknown document handle:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/unknownhandle\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection or view not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", @@ -5887,7 +5901,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/get_read_document.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/get_read_document.md" }, "head": { "description": "\n\nLike *GET*, but only returns the header fields and not the body. You\ncan use this call to get the current revision of a document or check if\nthe document was deleted.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X HEAD --dump - http://localhost:8529/_api/document/products/12348\n\n
\n\n\n\n\n\n", @@ -5932,7 +5946,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/head_read_document_header.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/head_read_document_header.md" }, "patch": { "description": "\n\nPartially updates the document identified by *document-handle*.\nThe body of the request must contain a JSON document with the\nattributes to patch (the patch document). All attributes from the\npatch document will be added to the existing document if they do not\nyet exist, and overwritten in the existing document if they do exist\nthere.\n\nSetting an attribute value to *null* in the patch document will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *Etag* header field contains the new revision of the document\n(in double quotes) and the *Location* header contains a complete URL\nunder which the document can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the updated document operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n**Example:**\n Patches an existing document with new content.\n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/12228 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1_u--_\"\nlocation: /_db/_system/_api/document/products/12228\n\n{ \n  \"_id\" : \"products/12228\", \n  \"_key\" : \"12228\", \n  \"_rev\" : \"_WnWW1_u--_\", \n  \"_oldRev\" : \"_WnWW1_q--_\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/12228 <<EOF\n{ \n  \"numbers\" : { \n    \"one\" : 1, \n    \"two\" : 2, \n    \"three\" : 3, \n    \"empty\" : null \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1_6--_\"\nlocation: /_db/_system/_api/document/products/12228\n\n{ \n  \"_id\" : \"products/12228\", \n  \"_key\" : \"12228\", \n  \"_rev\" : \"_WnWW1_6--_\", \n  \"_oldRev\" : \"_WnWW1_u--_\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/12228\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1_6--_\"\n\n{ \n  \"_key\" : \"12228\", \n  \"_id\" : \"products/12228\", \n  \"_rev\" : \"_WnWW1_6--_\", \n  \"one\" : \"world\", \n  \"hello\" : \"world\", \n  \"numbers\" : { \n    \"one\" : 1, \n    \"two\" : 2, \n    \"three\" : 3, \n    \"empty\" : null \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/12228?keepNull=false <<EOF\n{ \n  \"hello\" : null, \n  \"numbers\" : { \n    \"four\" : 4 \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1AS--_\"\nlocation: /_db/_system/_api/document/products/12228\n\n{ \n  \"_id\" : \"products/12228\", \n  \"_key\" : \"12228\", \n  \"_rev\" : \"_WnWW1AS--_\", \n  \"_oldRev\" : \"_WnWW1_6--_\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/12228\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1AS--_\"\n\n{ \n  \"_key\" : \"12228\", \n  \"_id\" : \"products/12228\", \n  \"_rev\" : \"_WnWW1AS--_\", \n  \"one\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  } \n}\n
\n\n\n\n\n**Example:**\n Merging attributes of an object using `mergeObjects`:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/12244\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1Ba--_\"\n\n{ \n  \"_key\" : \"12244\", \n  \"_id\" : \"products/12244\", \n  \"_rev\" : \"_WnWW1Ba--_\", \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000 \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/12244?mergeObjects=true <<EOF\n{ \n  \"inhabitants\" : { \n    \"indonesia\" : 252164800, \n    \"brazil\" : 203553000 \n  } \n}\nEOF\n\nshell> curl --dump - http://localhost:8529/_api/document/products/12244\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1Bq--_\"\n\n{ \n  \"_key\" : \"12244\", \n  \"_id\" : \"products/12244\", \n  \"_rev\" : \"_WnWW1Bq--_\", \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000, \n    \"indonesia\" : 252164800, \n    \"brazil\" : 203553000 \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/12244?mergeObjects=false <<EOF\n{ \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1B6--_\"\nlocation: /_db/_system/_api/document/products/12244\n\n{ \n  \"_id\" : \"products/12244\", \n  \"_key\" : \"12244\", \n  \"_rev\" : \"_WnWW1B6--_\", \n  \"_oldRev\" : \"_WnWW1Bq--_\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/12244\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1B6--_\"\n\n{ \n  \"_key\" : \"12244\", \n  \"_id\" : \"products/12244\", \n  \"_rev\" : \"_WnWW1B6--_\", \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\n
\n\n\n\n\n", @@ -6034,7 +6048,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/patch_update_document.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/patch_update_document.md" }, "put": { "description": "\n\nReplaces the document with handle with the one in\nthe body, provided there is such a document and no precondition is\nviolated.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *Etag* header field contains the new revision of the document\nand the *Location* header contains a complete URL under which the\ndocument can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n**Example:**\n Using a document handle\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/12366 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\netag: \"_WnWW1LG--_\"\nlocation: /_db/_system/_api/document/products/12366\n\n{ \n  \"_id\" : \"products/12366\", \n  \"_key\" : \"12366\", \n  \"_rev\" : \"_WnWW1LG--_\", \n  \"_oldRev\" : \"_WnWW1LC--_\" \n}\n
\n\n\n\n\n**Example:**\n Unknown document handle\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/12388 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n**Example:**\n Produce a revision conflict\n\n
shell> curl -X PUT --header 'If-Match: \"_WnWW1Lu--B\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/12376 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: \"_WnWW1Lu--_\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/12376\", \n  \"_key\" : \"12376\", \n  \"_rev\" : \"_WnWW1Lu--_\" \n}\n
\n\n\n\n\n", @@ -6122,7 +6136,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/put_replace_document.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/put_replace_document.md" } }, "/_api/edges/{collection-id}": { @@ -6168,7 +6182,7 @@ "Graph Edges" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph Edges/get_read_in_out_edges.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph Edges/get_read_in_out_edges.md" } }, "/_api/endpoint": { @@ -6191,7 +6205,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_endpoint.md" } }, "/_api/engine": { @@ -6215,7 +6229,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_engine.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_engine.md" } }, "/_api/explain": { @@ -6248,7 +6262,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/post_api_explain.md" } }, "/_api/export": { @@ -6294,7 +6308,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Bulk/post_api_export.md" } }, "/_api/foxx": { @@ -6319,7 +6333,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "post": { "description": "\n\nInstalls the given new service at the given mount path.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle,\nJavaScript file or (in case of a file system path) directory.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n", @@ -6363,7 +6377,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md" } }, "/_api/foxx/commit": { @@ -6388,7 +6402,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md" } }, "/_api/foxx/configuration": { @@ -6413,7 +6427,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md" }, "patch": { "description": "\n\nReplaces the given service's configuration.\n\nReturns an object mapping all configuration option names to their new values.\n\n", @@ -6447,7 +6461,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md" }, "put": { "description": "\n\nReplaces the given service's configuration completely.\n\nReturns an object mapping all configuration option names to their new values.\n\n", @@ -6481,7 +6495,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" } }, "/_api/foxx/dependencies": { @@ -6506,7 +6520,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md" }, "patch": { "description": "\n\nReplaces the given service's dependencies.\n\nReturns an object mapping all dependency names to their new mount paths.\n\n", @@ -6540,7 +6554,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md" }, "put": { "description": "\n\nReplaces the given service's dependencies completely.\n\nReturns an object mapping all dependency names to their new mount paths.\n\n", @@ -6574,7 +6588,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md" } }, "/_api/foxx/development": { @@ -6599,7 +6613,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md" }, "post": { "description": "\n\nPuts the service into development mode.\n\nWhile the service is running in development mode the service will be reloaded\nfrom the filesystem and its setup script (if any) will be re-executed every\ntime the service handles a request.\n\nWhen running ArangoDB in a cluster with multiple coordinators note that changes\nto the filesystem on one coordinator will not be reflected across the other\ncoordinators. This means you should treat your coordinators as inconsistent\nas long as any service is running in development mode.\n\n", @@ -6622,7 +6636,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md" } }, "/_api/foxx/download": { @@ -6650,7 +6664,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md" } }, "/_api/foxx/readme": { @@ -6678,7 +6692,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md" } }, "/_api/foxx/scripts": { @@ -6703,7 +6717,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md" } }, "/_api/foxx/scripts/{name}": { @@ -6747,7 +6761,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md" } }, "/_api/foxx/service": { @@ -6779,7 +6793,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md" }, "get": { "description": "\n\nFetches detailed information for the service at the given mount path.\n\nReturns an object with the following attributes:\n\n- *mount*: the mount path of the service\n- *path*: the local file system path of the service\n- *development*: *true* if the service is running in development mode\n- *legacy*: *true* if the service is running in 2.8 legacy compatibility mode\n- *manifest*: the normalized JSON manifest of the service\n\nAdditionally the object may contain the following attributes if they have been set on the manifest:\n\n- *name*: a string identifying the service type\n- *version*: a semver-compatible version string\n\n", @@ -6805,7 +6819,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md" }, "patch": { "description": "\n\nInstalls the given new service on top of the service currently installed at the given mount path.\nThis is only recommended for switching between different versions of the same service.\n\nUnlike replacing a service, upgrading a service retains the old service's configuration\nand dependencies (if any) and should therefore only be used to migrate an existing service\nto a newer or equivalent service.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle,\nJavaScript file or (in case of a file system path) directory.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n", @@ -6849,7 +6863,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md" }, "put": { "description": "\n\nRemoves the service at the given mount path from the database and file system.\nThen installs the given new service at the same mount path.\n\nThis is a slightly safer equivalent to performing an uninstall of the old service\nfollowed by installing the new service. The new service's main and script files\n(if any) will be checked for basic syntax errors before the old service is removed.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle,\nJavaScript file or (in case of a file system path) directory.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n", @@ -6900,7 +6914,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md" } }, "/_api/foxx/swagger": { @@ -6925,7 +6939,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md" } }, "/_api/foxx/tests": { @@ -6964,7 +6978,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md" } }, "/_api/gharial": { @@ -6981,7 +6995,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_list_http_examples.md" }, "post": { "description": "\n\nThe creation of a graph requires the name of the graph and a\ndefinition of its edges.\n[See also edge definitions](../../Manual/Graphs/GeneralGraphs/Management.html#edge-definitions).\n\n\n**A JSON object with these properties is required:**\n\n - **orphanCollections**: An array of additional vertex collections.\n - **edgeDefinitions**: An array of definitions for the edge\n - **name**: Name of the graph.\n - **isSmart**: Define if the created graph should be smart.\n This only has effect in Enterprise version.\n - **options**:\n - **smartGraphAttribute**: The attribute name that is used to smartly shard the vertices of a graph.\n Every vertex in this Graph has to have this attribute.\n Cannot be modified later.\n - **numberOfShards**: The number of shards that is used for every collection within this graph.\n Cannot be modified later.\n\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial <<EOF\n{ \n  \"name\" : \"myGraph\", \n  \"edgeDefinitions\" : [ \n    { \n      \"collection\" : \"edges\", \n      \"from\" : [ \n        \"startVertices\" \n      ], \n      \"to\" : [ \n        \"endVertices\" \n      ] \n    } \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvIG--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_WnWWvIG--_\" \n  } \n}\n
\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial <<EOF\n{ \n  \"name\" : \"myGraph\", \n  \"edgeDefinitions\" : [ \n    { \n      \"collection\" : \"edges\", \n      \"from\" : [ \n        \"startVertices\" \n      ], \n      \"to\" : [ \n        \"endVertices\" \n      ] \n    } \n  ], \n  \"isSmart\" : true, \n  \"options\" : { \n    \"numberOfShards\" : 9, \n    \"smartGraphAttribute\" : \"region\" \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvJ6--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_WnWWvJ6--_\" \n  } \n}\n
\n\n\n\n\n", @@ -7012,7 +7026,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_create_http_examples.md" } }, "/_api/gharial/{graph-name}": { @@ -7051,7 +7065,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_drop_http_examples.md" }, "get": { "description": "\n\nGets a graph from the collection *_graphs*.\nReturns the definition content of this graph.\n\n\n\n\n**Example:**\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/myGraph\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvdS--_\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_WnWWvdS--_\" \n  } \n}\n
\n\n\n\n\n", @@ -7078,7 +7092,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_get_http_examples.md" } }, "/_api/gharial/{graph-name}/edge": { @@ -7107,7 +7121,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_list_edge_http_examples.md" }, "post": { "description": "\n\nAdds an additional edge definition to the graph.\n\nThis edge definition has to contain a *collection* and an array of\neach *from* and *to* vertex collections. An edge definition can only\nbe added if this definition is either not used in any other graph, or\nit is used with exactly the same definition. It is not possible to\nstore a definition \"e\" from \"v1\" to \"v2\" in the one graph, and \"e\"\nfrom \"v2\" to \"v1\" in the other graph.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge <<EOF\n{ \n  \"collection\" : \"works_in\", \n  \"from\" : [ \n    \"female\", \n    \"male\" \n  ], \n  \"to\" : [ \n    \"city\" \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvBS--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      }, \n      { \n        \"collection\" : \"works_in\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"city\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_WnWWvBS--_\" \n  } \n}\n
\n\n\n\n", @@ -7149,7 +7163,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}": { @@ -7221,7 +7235,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_create_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}": { @@ -7285,7 +7299,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_delete_http_examples.md" }, "get": { "description": "\n\nGets an edge from the given collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/social/edge/relation/10223\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvai--_\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"edge\" : { \n    \"_key\" : \"10223\", \n    \"_id\" : \"relation/10223\", \n    \"_from\" : \"female/alice\", \n    \"_to\" : \"male/charly\", \n    \"_rev\" : \"_WnWWvai--_\", \n    \"type\" : \"friend\", \n    \"vertex\" : \"alice\" \n  } \n}\n
\n\n\n\n\n", @@ -7337,7 +7351,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_get_http_examples.md" }, "patch": { "description": "\n\nUpdates the data of the specific edge in the collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/10799 <<EOF\n{ \n  \"since\" : \"01.01.2001\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWv4u--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"edge\" : { \n    \"_id\" : \"relation/10799\", \n    \"_key\" : \"10799\", \n    \"_rev\" : \"_WnWWv4u--_\", \n    \"_oldRev\" : \"_WnWWv4O--B\" \n  } \n}\n
\n\n\n\n\n", @@ -7408,7 +7422,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_modify_http_examples.md" }, "put": { "description": "\n\nReplaces the data of an edge in the collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/10868 <<EOF\n{ \n  \"type\" : \"divorced\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"male/bob\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWv8G--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"edge\" : { \n    \"_id\" : \"relation/10868\", \n    \"_key\" : \"10868\", \n    \"_rev\" : \"_WnWWv8G--_\", \n    \"_oldRev\" : \"_WnWWv8---L\" \n  } \n}\n
\n\n\n\n", @@ -7481,7 +7495,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_replace_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{definition-name}": { @@ -7531,7 +7545,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_remove_http_examples.md" }, "put": { "description": "\n\nChange one specific edge definition.\nThis will modify all occurrences of this definition in all graphs known to your database.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF\n{ \n  \"collection\" : \"relation\", \n  \"from\" : [ \n    \"female\", \n    \"male\", \n    \"animal\" \n  ], \n  \"to\" : [ \n    \"female\", \n    \"male\", \n    \"animal\" \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWwIa--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"animal\", \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"animal\", \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_WnWWwIa--_\" \n  } \n}\n
\n\n\n\n", @@ -7581,7 +7595,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_edge_definition_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex": { @@ -7610,7 +7624,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_list_vertex_http_examples.md" }, "post": { "description": "\n\nAdds a vertex collection to the set of collections of the graph. If\nthe collection does not exist, it will be created.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex <<EOF\n{ \n  \"collection\" : \"otherVertices\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvF6--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ \n      \"otherVertices\" \n    ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_WnWWvF6--_\" \n  } \n}\n
\n\n\n\n", @@ -7640,7 +7654,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_add_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}": { @@ -7690,7 +7704,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_collection_remove_http_examples.md" }, "post": { "description": "\n\nAdds a vertex to the given collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/male <<EOF\n{ \n  \"name\" : \"Francis\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvEO--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"vertex\" : { \n    \"_id\" : \"male/9743\", \n    \"_key\" : \"9743\", \n    \"_rev\" : \"_WnWWvEO--_\" \n  } \n}\n
\n\n\n\n\n", @@ -7746,7 +7760,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_create_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}": { @@ -7810,7 +7824,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_delete_http_examples.md" }, "get": { "description": "\n\nGets a vertex from the given collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWvhO--_\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"vertex\" : { \n    \"_key\" : \"alice\", \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"_WnWWvhO--_\", \n    \"name\" : \"Alice\" \n  } \n}\n
\n\n\n\n\n", @@ -7862,7 +7876,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_get_http_examples.md" }, "patch": { "description": "\n\nUpdates the data of the specific vertex in the collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice <<EOF\n{ \n  \"age\" : 26 \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWv0S--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_WnWWv0S--_\", \n    \"_oldRev\" : \"_WnWWvzi--_\" \n  } \n}\n
\n\n\n\n\n", @@ -7942,7 +7956,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_modify_http_examples.md" }, "put": { "description": "\n\nReplaces the data of a vertex in the collection.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice <<EOF\n{ \n  \"name\" : \"Alice Cooper\", \n  \"age\" : 26 \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\ncontent-type: application/json; charset=utf-8\netag: _WnWWwNq--_\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_WnWWwNq--_\", \n    \"_oldRev\" : \"_WnWWwNW--_\" \n  } \n}\n
\n\n\n\n\n", @@ -8015,7 +8029,7 @@ "Graph" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph/general_graph_vertex_replace_http_examples.md" } }, "/_api/import#document": { @@ -8112,7 +8126,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Bulk/import_document.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Bulk/import_document.md" } }, "/_api/import#json": { @@ -8216,7 +8230,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Bulk/import_json.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Bulk/import_json.md" } }, "/_api/index": { @@ -8241,7 +8255,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/get_api_index.md" } }, "/_api/index#fulltext": { @@ -8281,7 +8295,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_fulltext.md" } }, "/_api/index#general": { @@ -8326,7 +8340,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index.md" } }, "/_api/index#geo": { @@ -8366,7 +8380,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_geo.md" } }, "/_api/index#hash": { @@ -8409,7 +8423,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_hash.md" } }, "/_api/index#persistent": { @@ -8452,7 +8466,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_persistent.md" } }, "/_api/index#skiplist": { @@ -8495,7 +8509,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_skiplist.md" } }, "/_api/index/{index-handle}": { @@ -8524,7 +8538,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/post_api_index_delete.md" }, "get": { "description": "\n\nThe result is an object describing the index. It has at least the following\nattributes:\n\n- *id*: the identifier of the index\n\n- *type*: the index type\n\nAll other attributes are type-dependent. For example, some indexes provide\n*unique* or *sparse* flags, whereas others don't. Some indexes also provide \na selectivity estimate in the *selectivityEstimate* attribute of the result.\n\n\n\n\n**Example:**\n \n\n
shell> curl --dump - http://localhost:8529/_api/index/products/0\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"fields\" : [ \n    \"_key\" \n  ], \n  \"id\" : \"products/0\", \n  \"selectivityEstimate\" : 1, \n  \"sparse\" : false, \n  \"type\" : \"primary\", \n  \"unique\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -8551,7 +8565,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Indexes/get_api_reads_index.md" } }, "/_api/job/{job-id}": { @@ -8583,7 +8597,7 @@ "job" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/job/job_getStatusById.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/job/job_getStatusById.md" }, "put": { "description": "\n\nReturns the result of an async job identified by job-id. If the async job\nresult is present on the server, the result will be removed from the list of\nresult. That means this method can be called for each job-id once.\nThe method will return the original job result's headers and body, plus the\nadditional HTTP header x-arango-async-job-id. If this header is present,\nthen\nthe job was found and the response contains the original job's result. If\nthe header is not present, the job was not found and the response contains\nstatus information from the job manager.\n\n\n\n\n**Example:**\n Not providing a job-id:\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/job\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"bad parameter\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n**Example:**\n Providing a job-id for a non-existing job:\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/job/notthere\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"code\" : 404, \n  \"errorNum\" : 404 \n}\n
\n\n\n\n\n**Example:**\n Fetching the result of an HTTP GET job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584438\ncontent-type: text/plain; charset=utf-8\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/152293662584438\n\nHTTP/1.1 200 OK\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584438\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.4.devel\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n**Example:**\n Fetching the result of an HTTP POST job that failed:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \" this name is invalid \" \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584443\ncontent-type: text/plain; charset=utf-8\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/152293662584443\n\nHTTP/1.1 400 Bad Request\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584443\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", @@ -8613,7 +8627,7 @@ "job" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/job/job_fetch_result.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/job/job_fetch_result.md" } }, "/_api/job/{job-id}/cancel": { @@ -8645,7 +8659,7 @@ "job" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/job/job_cancel.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/job/job_cancel.md" } }, "/_api/job/{type}": { @@ -8684,7 +8698,7 @@ "job" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/job/job_delete.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/job/job_delete.md" }, "get": { "description": "\n\nReturns the list of ids of async jobs with a specific status (either done or\npending).\nThe list can be used by the client to get an overview of the job system\nstatus and\nto retrieve completed job results later.\n\n\n\n\n**Example:**\n Fetching the list of done jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584448\ncontent-type: text/plain; charset=utf-8\n\nshell> curl --dump - http://localhost:8529/_api/job/done\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"152293662584448\" \n]\n
\n\n\n\n\n**Example:**\n Fetching the list of pending jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584453\ncontent-type: text/plain; charset=utf-8\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ ]\n
\n\n\n\n\n**Example:**\n Querying the status of a pending job:\n(we create a sleep job therefore...)\n\n
shell> curl -X POST --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : [ \n      \"_frontend\" \n    ] \n  }, \n  \"action\" : \"function () {require('internal').sleep(15.0);}\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\nx-content-type-options: nosniff\nx-arango-async-id: 152293662584458\ncontent-type: text/plain; charset=utf-8\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"152293662584458\" \n]\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/152293662584458\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n", @@ -8718,7 +8732,7 @@ "job" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/job/job_getByType.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/job/job_getByType.md" } }, "/_api/query": { @@ -8748,7 +8762,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md" } }, "/_api/query-cache": { @@ -8768,7 +8782,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" } }, "/_api/query-cache/properties": { @@ -8788,7 +8802,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md" }, "put": { "description": "\n\nAfter the properties have been changed, the current set of properties will\nbe returned in the HTTP response.\n\nNote: changing the properties may invalidate all results in the cache.\nThe global properties for AQL query cache.\nThe properties need to be passed in the attribute *properties* in the body\nof the HTTP request. *properties* needs to be a JSON object with the following\nproperties:\n\n\n**A JSON object with these properties is required:**\n\n - **mode**: the mode the AQL query cache should operate in. Possible values are *off*, *on* or *demand*.\n - **maxResults**: the maximum number of query results that will be stored per database-specific cache.\n\n\n", @@ -8816,7 +8830,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md" } }, "/_api/query/current": { @@ -8836,7 +8850,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md" } }, "/_api/query/properties": { @@ -8856,7 +8870,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **maxSlowQueries**: The maximum number of slow queries to keep in the list\n of slow queries. If the list of slow queries is full, the oldest entry in\n it will be discarded when additional slow queries occur.\n - **slowQueryThreshold**: The threshold value for treating a query as slow. A\n query with a runtime greater or equal to this threshold value will be\n put into the list of slow queries when slow query tracking is enabled.\n The value for *slowQueryThreshold* is specified in seconds.\n - **enabled**: If set to *true*, then queries will be tracked. If set to\n *false*, neither queries nor slow queries will be tracked.\n - **maxQueryStringLength**: The maximum query string length to keep in the list of queries.\n Query strings can have arbitrary lengths, and this property\n can be used to save memory in case very long query strings are used. The\n value is specified in bytes.\n - **trackSlowQueries**: If set to *true*, then slow queries will be tracked\n in the list of slow queries if their runtime exceeds the value set in\n *slowQueryThreshold*. In order for slow queries to be tracked, the *enabled*\n property must also be set to *true*.\n - **trackBindVars**: If set to *true*, then the bind variables used in queries will be tracked \n along with queries.\n\n\n\n\nThe properties need to be passed in the attribute *properties* in the body\nof the HTTP request. *properties* needs to be a JSON object.\n\nAfter the properties have been changed, the current set of properties will\nbe returned in the HTTP response.\n\n", @@ -8884,7 +8898,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md" } }, "/_api/query/slow": { @@ -8904,7 +8918,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md" }, "get": { "description": "\n\nReturns an array containing the last AQL queries that are finished and\nhave exceeded the slow query threshold in the selected database.\nThe maximum amount of queries in the list can be controlled by setting\nthe query tracking property `maxSlowQueries`. The threshold for treating\na query as *slow* can be adjusted by setting the query tracking property\n`slowQueryThreshold`.\n\nEach query is a JSON object with the following attributes:\n\n- *id*: the query's id\n\n- *query*: the query string (potentially truncated)\n\n- *bindVars*: the bind parameter values used by the query\n\n- *started*: the date and time when the query was started\n\n- *runTime*: the query's total run time \n\n- *state*: the query's current execution state (will always be \"finished\"\n for the list of slow queries)\n\n", @@ -8922,7 +8936,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query/{query-id}": { @@ -8954,7 +8968,7 @@ "AQL" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/replication/applier-config": { @@ -8977,7 +8991,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the endpoint.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the logger server to connect to (e.g. \"tcp://192.168.173.13:8529\"). The endpoint must be specified.\n - **verbose**: if set to *true*, then a log line will be emitted for all operations \n performed by the replication applier. This should be used for debugging replication\n problems only.\n - **connectTimeout**: the timeout (in seconds) when attempting to connect to the\n endpoint. This value is used for each connection attempt.\n - **autoResync**: whether or not the slave should perform a full automatic resynchronization\n with the master in case the master cannot serve log data requested by the\n slave,\n or when the replication is started and no tick value can be found.\n - **database**: the name of the database on the endpoint. If not specified, defaults to the current local database name.\n - **idleMinWaitTime**: the minimum wait time (in seconds) that the applier will intentionally idle\n before fetching more log data from the master in case the master has\n already sent all its log data. This wait time can be used to control the\n frequency with which the replication applier sends HTTP log fetch requests\n to the master in case there is no write activity on the master.\n This value will be ignored if set to *0*.\n - **requestTimeout**: the timeout (in seconds) for individual requests to the endpoint.\n - **requireFromPresent**: if set to *true*, then the replication applier will check\n at start whether the start tick from which it starts or resumes replication is\n still present on the master. If not, then there would be data loss. If \n *requireFromPresent* is *true*, the replication applier will abort with an\n appropriate error message. If set to *false*, then the replication applier will\n still start, and ignore the data loss.\n - **idleMaxWaitTime**: the maximum wait time (in seconds) that the applier will intentionally idle \n before fetching more log data from the master in case the master has \n already sent all its log data and there have been previous log fetch attempts\n that resulted in no more log data. This wait time can be used to control the\n maximum frequency with which the replication applier sends HTTP log fetch\n requests to the master in case there is no write activity on the master for\n longer periods. This configuration value will only be used if the option\n *adaptivePolling* is set to *true*.\n This value will be ignored if set to *0*.\n - **restrictCollections** (string): the array of collections to include or exclude,\n based on the setting of *restrictType*\n - **restrictType**: the configuration for *restrictCollections*; Has to be either *include* or *exclude*\n - **initialSyncMaxWaitTime**: the maximum wait time (in seconds) that the initial synchronization will\n wait for a response from the master when fetching initial collection data.\n This wait time can be used to control after what time the initial\n synchronization\n will give up waiting for a response and fail. This value is relevant even\n for continuous replication when *autoResync* is set to *true* because this\n may re-start the initial synchronization when the master cannot provide\n log data the slave requires.\n This value will be ignored if set to *0*.\n - **maxConnectRetries**: the maximum number of connection attempts the applier\n will make in a row. If the applier cannot establish a connection to the\n endpoint in this number of attempts, it will stop itself.\n - **autoStart**: whether or not to auto-start the replication applier on\n (next and following) server starts\n - **adaptivePolling**: if set to *true*, the replication applier will fall\n to sleep for an increasingly long period in case the logger server at the\n endpoint does not have any more replication events to apply. Using\n adaptive polling is thus useful to reduce the amount of work for both the\n applier and the logger server for cases when there are only infrequent\n changes. The downside is that when using adaptive polling, it might take\n longer for the replication applier to detect that there are new replication\n events on the logger server.\n Setting *adaptivePolling* to false will make the replication applier\n contact the logger server in a constant interval, regardless of whether\n the logger server provides updates frequently or seldom.\n - **password**: the password to use when connecting to the endpoint.\n - **connectionRetryWaitTime**: the time (in seconds) that the applier will intentionally idle before\n it retries connecting to the master in case of connection problems.\n This value will be ignored if set to *0*.\n - **autoResyncRetries**: number of resynchronization retries that will be performed in a row when\n automatic resynchronization is enabled and kicks in. Setting this to *0*\n will\n effectively disable *autoResync*. Setting it to some other value will limit\n the number of retries that are performed. This helps preventing endless\n retries\n in case resynchronizations always fail.\n - **chunkSize**: the requested maximum size for log transfer packets that\n is used when the endpoint is contacted.\n\n\n\n\nSets the configuration of the replication applier. The configuration can\nonly be changed while the applier is not running. The updated configuration\nwill be saved immediately but only become active with the next start of the\napplier.\n\nIn case of success, the body of the response is a JSON object with the updated\nconfiguration.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/replication/applier-config <<EOF\n{ \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"username\" : \"replicationApplier\", \n  \"password\" : \"applier1234@foxx\", \n  \"chunkSize\" : 4194304, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\", \n  \"username\" : \"replicationApplier\", \n  \"requestTimeout\" : 600, \n  \"connectTimeout\" : 10, \n  \"ignoreErrors\" : 0, \n  \"maxConnectRetries\" : 100, \n  \"lockTimeoutRetries\" : 0, \n  \"sslProtocol\" : 0, \n  \"chunkSize\" : 4194304, \n  \"skipCreateDrop\" : false, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true, \n  \"autoResync\" : false, \n  \"autoResyncRetries\" : 2, \n  \"includeSystem\" : true, \n  \"requireFromPresent\" : false, \n  \"verbose\" : false, \n  \"incremental\" : false, \n  \"restrictType\" : \"\", \n  \"restrictCollections\" : [ ], \n  \"connectionRetryWaitTime\" : 15, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"idleMinWaitTime\" : 1, \n  \"idleMaxWaitTime\" : 2.5, \n  \"force32mode\" : false \n}\n
\n\n\n\n\n", @@ -9011,7 +9025,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_adjust.md" } }, "/_api/replication/applier-start": { @@ -9045,7 +9059,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_start.md" } }, "/_api/replication/applier-state": { @@ -9068,7 +9082,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_applier_state.md" } }, "/_api/replication/applier-stop": { @@ -9091,7 +9105,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_applier_stop.md" } }, "/_api/replication/batch": { @@ -9124,7 +9138,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/post_batch_replication.md" } }, "/_api/replication/batch/{id}": { @@ -9156,7 +9170,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/delete_batch_replication.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **ttl**: the time-to-live for the new batch (in seconds)\n\n\n\n\nExtends the ttl of an existing dump batch, using the batch's id and\nthe provided ttl value.\n\nIf the batch's ttl can be extended successfully, the response is empty.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n", @@ -9195,7 +9209,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_batch_replication.md" } }, "/_api/replication/clusterInventory": { @@ -9226,7 +9240,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_cluster_inventory.md" } }, "/_api/replication/dump": { @@ -9315,7 +9329,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_dump.md" } }, "/_api/replication/inventory": { @@ -9346,7 +9360,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_inventory.md" } }, "/_api/replication/logger-first-tick": { @@ -9372,7 +9386,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_first_tick.md" } }, "/_api/replication/logger-follow": { @@ -9433,7 +9447,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_returns.md" } }, "/_api/replication/logger-state": { @@ -9456,7 +9470,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_return_state.md" } }, "/_api/replication/logger-tick-ranges": { @@ -9482,7 +9496,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/get_api_replication_logger_tick_ranges.md" } }, "/_api/replication/make-slave": { @@ -9521,7 +9535,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_makeSlave.md" } }, "/_api/replication/server-id": { @@ -9544,7 +9558,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_serverID.md" } }, "/_api/replication/sync": { @@ -9583,7 +9597,7 @@ "Replication" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Replication/put_api_replication_synchronize.md" } }, "/_api/simple/all": { @@ -9618,7 +9632,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_all.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_all.md" } }, "/_api/simple/all-keys": { @@ -9655,7 +9669,7 @@ "Documents" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Documents/put_read_all_documents.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Documents/put_read_all_documents.md" } }, "/_api/simple/any": { @@ -9688,7 +9702,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_any.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_any.md" } }, "/_api/simple/by-example": { @@ -9721,7 +9735,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_by_example.md" } }, "/_api/simple/first-example": { @@ -9754,7 +9768,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_first_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_first_example.md" } }, "/_api/simple/fulltext": { @@ -9787,7 +9801,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_fulltext.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_fulltext.md" } }, "/_api/simple/lookup-by-keys": { @@ -9820,7 +9834,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" } }, "/_api/simple/near": { @@ -9853,7 +9867,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_near.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_near.md" } }, "/_api/simple/range": { @@ -9886,7 +9900,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_range.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_range.md" } }, "/_api/simple/remove-by-example": { @@ -9919,7 +9933,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_remove_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_remove_by_example.md" } }, "/_api/simple/remove-by-keys": { @@ -9952,7 +9966,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md" } }, "/_api/simple/replace-by-example": { @@ -9985,7 +9999,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_replace_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_replace_by_example.md" } }, "/_api/simple/update-by-example": { @@ -10018,7 +10032,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_update_by_example.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_update_by_example.md" } }, "/_api/simple/within": { @@ -10051,7 +10065,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within.md" } }, "/_api/simple/within-rectangle": { @@ -10084,7 +10098,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within_rectangle.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Simple Queries/put_api_simple_within_rectangle.md" } }, "/_api/tasks": { @@ -10121,7 +10135,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/post_api_new_tasks.md" } }, "/_api/tasks/": { @@ -10145,7 +10159,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_tasks_all.md" } }, "/_api/tasks/{id}": { @@ -10185,7 +10199,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/delete_api_tasks.md" }, "get": { "description": "\n\nfetches one existing task on the server specified by *id*\n\n\n#### HTTP 200\n*A json document with these Properties is returned:*\n\nThe requested task\n\n- **name**: The fully qualified name of the user function\n- **created**: The timestamp when this task was created\n- **database**: the database this task belongs to\n- **period**: this task should run each `period` seconds\n- **command**: the javascript function for this dask\n- **offset**: time offset in seconds from the created timestamp\n- **type**: What type of task is this [ `periodic`, `timed`]\n - periodic are tasks that repeat periodically\n - timed are tasks that execute once at a specific time\n- **id**: A string identifying the task\n\n\n\n\n**Example:**\n Fetching a single task by its id\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/tasks <<EOF\n{\"id\":\"testTask\",\"command\":\"console.log('Hello from task!');\",\"offset\":10000}\nEOF\n\nshell> curl --dump - http://localhost:8529/_api/tasks/testTask\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"testTask\", \n  \"name\" : \"user-defined task\", \n  \"created\" : 1522936640.674124, \n  \"type\" : \"timed\", \n  \"offset\" : 10000, \n  \"command\" : \"(function (params) { console.log('Hello from task!'); } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n**Example:**\n Trying to fetch a non-existing task\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/non-existing-task\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1852, \n  \"errorMessage\" : \"task not found\" \n}\n
\n\n\n\n\n", @@ -10216,7 +10230,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_tasks.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **params**: The parameters to be passed into command\n - **offset**: Number of seconds initial delay \n - **command**: The JavaScript code to be executed\n - **name**: The name of the task\n - **period**: number of seconds between the executions\n\n\n\n\nregisters a new task with the specified id\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/tasks/sampleTask <<EOF\n{ \n  \"id\" : \"SampleTask\", \n  \"name\" : \"SampleTask\", \n  \"command\" : \"(function(params) { require('@arangodb').print(params); })(params)\", \n  \"params\" : { \n    \"foo\" : \"bar\", \n    \"bar\" : \"foo\" \n  }, \n  \"period\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"sampleTask\", \n  \"name\" : \"SampleTask\", \n  \"created\" : 1522936640.6792622, \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"offset\" : 0, \n  \"command\" : \"(function (params) { (function(params) { require('@arangodb').print(params); })(params) } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -10249,7 +10263,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/put_api_new_tasks.md" } }, "/_api/transaction": { @@ -10285,7 +10299,7 @@ "Transactions" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Transactions/post_api_transaction.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Transactions/post_api_transaction.md" } }, "/_api/traversal": { @@ -10321,7 +10335,7 @@ "Graph Traversal" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Graph Traversal/HTTP_API_TRAVERSAL.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Graph Traversal/HTTP_API_TRAVERSAL.md" } }, "/_api/user": { @@ -10360,7 +10374,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/": { @@ -10383,7 +10397,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}": { @@ -10418,7 +10432,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "get": { "description": "\n\nFetches data about the specified user. You can fetch information about\nyourself or you need the *Administrate* server access level in order to\nexecute this REST call.\n\n\n\n\n**Example:**\n \n\n
shell> curl --dump - http://localhost:8529/_api/user/admin@myapp\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -10451,7 +10465,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "patch": { "description": "\n**A JSON object with these properties is required:**\n\n - **passwd**: The user password as a string. Specifying a password is mandatory, but\n the empty string is allowed for passwords\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\nPartially updates the data of an existing user. The name of an existing user\nmust be specified in *user*. You need server access level *Administrate* in\norder to execute this REST call. Additionally, a user can change his/her own\ndata.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp <<EOF\n{ \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n\n\n", @@ -10496,7 +10510,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **passwd**: The user password as a string. Specifying a password is mandatory, but\n the empty string is allowed for passwords\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\nReplaces the data of an existing user. The name of an existing user must be\nspecified in *user*. You need server access level *Administrate* in order to\nexecute this REST call. Additionally, a user can change his/her own data.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp <<EOF\n{ \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -10541,7 +10555,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/": { @@ -10583,7 +10597,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{database}": { @@ -10626,7 +10640,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{database}/{collection}": { @@ -10677,7 +10691,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{dbname}": { @@ -10714,7 +10728,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **grant**: Use \"rw\" to set the database access level to *Administrate* .\n Use \"ro\" to set the database access level to *Access*.\n Use \"none\" to set the database access level to *No access*.\n\n\n\n\nSets the database access levels for the database *dbname* of user *user*. You\nneed the *Administrate* server access level in order to execute this REST\ncall.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp/database/_system <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"_system\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -10764,7 +10778,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{dbname}/{collection}": { @@ -10809,7 +10823,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **grant**: Use \"rw\" to set the collection level access to *Read/Write*.\n Use \"ro\" to set the collection level access to *Read Only*.\n Use \"none\" to set the collection level access to *No access*.\n\n\n\n\nSets the collection access level for the *collection* in the database *dbname*\nfor user *user*. You need the *Administrate* server access level in order to\nexecute this REST call.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp/database/_system/reports <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"_system/reports\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -10867,7 +10881,7 @@ "User Management" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/version": { @@ -10899,7 +10913,7 @@ "Administration" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Administration/get_api_return.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Administration/get_api_return.md" } }, "/_api/view": { @@ -10916,7 +10930,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/get_api_views.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/get_api_views.md" } }, "/_api/view#arangosearch": { @@ -10946,7 +10960,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/post_api_view_iresearch.md" } }, "/_api/view/{view-name}": { @@ -10975,7 +10989,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/delete_api_view.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/delete_api_view.md" }, "get": { "description": "\n\nThe result is an object describing the view with the following\nattributes:\n\n- *id*: The identifier of the view.\n\n- *name*: The name of the view.\n\n- *type*: The type of the view as string\n - arangosearch: ArangoSearch view\n\n- *properties* : The properties of the view.\n\n", @@ -10999,7 +11013,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/get_api_view_name.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/get_api_view_name.md" } }, "/_api/view/{view-name}/properties": { @@ -11028,7 +11042,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/get_api_view_properties.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/get_api_view_properties.md" } }, "/_api/view/{view-name}/properties#ArangoSearch": { @@ -11066,7 +11080,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/patch_api_view_properties_iresearch.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **locale**: The default locale used for queries on analyzed string values (default: *C*).\n - **commit**:\n - **consolidate**:\n - **count**:\n - **threshold**: Consolidate IFF {threshold} > segment_docs{valid} / (all_segment_docs{valid} / #segments) (default: 0.85)\n - **segmentThreshold**: Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n - **bytes**:\n - **threshold**: Consolidate IFF {threshold} > segment_bytes / (all_segment_bytes / #segments) (default: 0.85)\n - **segmentThreshold**: Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n - **bytes_accum**:\n - **threshold**: Consolidate IFF {threshold} > (segment_bytes + sum_of_merge_candidate_segment_bytes) / all_segment_bytes (default: 0.85)\n - **segmentThreshold**: Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n - **fill**:\n - **threshold**: Consolidate IFF {threshold} > #segment_docs{valid} / (#segment_docs{valid} + #segment_docs{removed}) (default: 0.85)\n - **segmentThreshold**: Apply consolidation policy IFF {segmentThreshold} >= #segments (default: 300, to disable use: 0)\n - **commitIntervalMsec**: Wait at least this many milliseconds between committing index data changes and\n making them visible to queries (default: 60000, to disable use: 0).\n For the case where there are a lot of inserts/updates, a lower value, until commit, will cause the index not to account for them and\n memory usage would continue to grow.\n For the case where there are a few inserts/updates, a higher value will impact performance and waste disk space for each\n commit call without any added benefits.\n - **cleanupIntervalStep**: Wait at least this many commits between removing unused files in data directory (default: 10, \n to disable use: 0).\n For the case where the consolidation policies merge segments often (i.e. a lot of commit+consolidate), a lower value will cause a\n lot of disk space to be wasted.\n For the case where the consolidation policies rarely merge segments (i.e. few inserts/deletes), a higher value will impact\n performance without any added benefits.\n - **threadMaxTotal**: Maximum total number of threads (>0) for single-run tasks (default: 5).\n For the case where there are a lot of parallelizable tasks and an abundance of resources, a lower value would limit performance.\n For the case where there are limited resources CPU/memory, a higher value will negatively impact performance.\n - **threadMaxIdle**: Maximum idle number of threads for single-run tasks (default: 5).\n For the case where there are a lot of short-lived asynchronous tasks, a lower value will cause a lot of thread creation/deletion calls.\n For the case where there are no short-lived asynchronous tasks, a higher value will only waste memory.\n - **links**:\n - **[collection-name]**:\n - **analyzers** (string): The list of analyzers to be used for indexing of string values (default: [\"identity\"]).\n - **[field-name]**:\n - **analyzers** (string): The list of analyzers to be used for indexing of string values (default: [\"identity\"]).\n - **[field-name]**: Specify properties for nested fields here\n - **includeAllFields**: The flag determines whether or not to index all fields on a particular level of depth (default: false).\n - **trackListPositions**: The flag determines whether or not values in a lists should be treated separate (default: false).\n - **includeAllFields**: The flag determines whether or not to index all fields on a particular level of depth (default: false).\n - **trackListPositions**: The flag determines whether or not values in a lists should be treated separate (default: false).\n\n\n\n\nChanges the properties of a view.\n\nOn success an object with the following attributes is returned:\n- *id*: The identifier of the view.\n- *name*: The name of the view.\n- *type*: The view type. Valid types are:\n - arangosearch: ArangoSearch view\n- *properties*: The updated properties of the view.\n\n\n\n\n**Example:**\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/view/products/properties <<EOF\n{ \n  \"threadMaxIdle\" : 10 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"12656\", \n  \"name\" : \"products\", \n  \"type\" : \"arangosearch\" \n}\n
\n\n\n\n\n", @@ -11102,7 +11116,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_properties_iresearch.md" } }, "/_api/view/{view-name}/rename": { @@ -11131,7 +11145,7 @@ "Views" ], "x-examples": [], - "x-filename": "/var/lib/jenkins/workspace/RELEASE__BuildFrontend/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md" + "x-filename": "/home/oberon/arangodb1/Documentation/DocuBlocks/Rest/Views/put_api_view_rename.md" } } },