diff --git a/js/apps/system/_admin/aardvark/APP/api-docs.json b/js/apps/system/_admin/aardvark/APP/api-docs.json index 7823f191b7..5ded539be5 100644 --- a/js/apps/system/_admin/aardvark/APP/api-docs.json +++ b/js/apps/system/_admin/aardvark/APP/api-docs.json @@ -22,7 +22,7 @@ "journalSize" ], "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "JSA_put_api_simple_any": { "properties": { @@ -35,7 +35,7 @@ "collection" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_by_example": { "properties": { @@ -63,7 +63,7 @@ "limit" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_first_example": { "properties": { @@ -81,7 +81,7 @@ "example" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_fulltext": { "properties": { @@ -119,7 +119,7 @@ "index" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_near": { "properties": { @@ -162,7 +162,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_range": { "properties": { @@ -206,7 +206,7 @@ "skip" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_remove_by_example": { "properties": { @@ -227,7 +227,7 @@ "example" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_replace_by_example": { "properties": { @@ -253,7 +253,7 @@ "newValue" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_update_by_example": { "properties": { @@ -280,7 +280,7 @@ "newValue" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_within": { "properties": { @@ -328,7 +328,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSA_put_api_simple_within_rectangle": { "properties": { @@ -376,7 +376,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "JSF_HTTP_API_TRAVERSAL": { "properties": { @@ -437,7 +437,7 @@ "type": "string" }, "uniqueness": { - "description": "specifies uniqueness for vertices and edges visited\nif set, must be an object like this:\n\n*\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}*\n\n", + "description": "specifies uniqueness for vertices and edges visited.\nIf set, must be an object like this:\n\n`\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}`\n\n", "type": "string" }, "visitor": { @@ -449,7 +449,7 @@ "startVertex" ], "type": "object", - "x-filename": "Graph Traversal - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" + "x-filename": "Graph Traversal - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" }, "JSF_general_graph_create_http_examples": { "properties": { @@ -470,7 +470,7 @@ "name" ], "type": "object", - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "JSF_general_graph_edge_definition_add_http_examples": { "properties": { @@ -499,7 +499,7 @@ "to" ], "type": "object", - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "JSF_general_graph_edge_definition_modify_http_examples": { "properties": { @@ -528,34 +528,16 @@ "to" ], "type": "object", - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "JSF_get_api_database_new": { "properties": { - "active": { - "description": "A Flag indicating whether the user account should be activated or not.\nThe default value is *true*.\n\n", - "format": "", - "type": "boolean" - }, - "extra": { - "additionalProperties": {}, - "description": "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", - "type": "object" - }, "name": { "description": "Has to contain a valid database name.\n\n", "type": "string" }, - "passwd": { - "description": "The user password as a string. If not specified, it will default to an empty string.\n\n", - "type": "string" - }, - "username": { - "description": "The user name as a string.\nIf *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\nnew database will be accessible after it is created.\n\n", - "type": "string" - }, "users": { - "description": "Has to be a list of user objects to initially create for the new database.\nEach user object can contain the following attributes:\n\n", + "description": "Has to be an array of user objects to initially create for the new database.\nUser information will not be changed for users that already exist.\nIf *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\nnew database will be accessible after it is created.\nEach user object can contain the following attributes:\n\n", "items": { "$ref": "#/definitions/JSF_get_api_database_new_USERS" }, @@ -566,17 +548,22 @@ "name" ], "type": "object", - "x-filename": "Database - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md" }, "JSF_get_api_database_new_USERS": { "description": "", "properties": { "active": { - "description": "if *False* the user won't be able to log into the database.\n\n", + "description": "A flag indicating whether the user account should be activated or not.\nThe default value is *true*. If set to *false*, the user won't be able to\nlog into the database.\n\n", "type": "boolean" }, + "extra": { + "description": "A JSON object with extra user information. The data contained in *extra*\nwill be stored for the user but not be interpreted further by ArangoDB.\n\n", + "format": "", + "type": "object" + }, "passwd": { - "description": "Password for the user\n\n", + "description": "The user password as a string. If not specified, it will default to an empty string.\n\n", "type": "string" }, "username": { @@ -607,7 +594,7 @@ "version" ], "type": "object", - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" }, "JSF_post_api_aqlfunction": { "properties": { @@ -630,7 +617,7 @@ "code" ], "type": "object", - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "JSF_post_api_collection": { "properties": { @@ -690,7 +677,7 @@ "name" ], "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "JSF_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", @@ -715,7 +702,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "JSF_post_api_cursor": { "properties": { @@ -725,7 +712,7 @@ "type": "integer" }, "bindVars": { - "description": "list of bind parameter objects.\n\n", + "description": "key/value pairs representing the bind parameters.\n\n", "items": { "additionalProperties": {}, "type": "object" @@ -738,7 +725,7 @@ "type": "boolean" }, "count": { - "description": "indicates whether the number of documents in the result set should be returned in\nthe \"count\" attribute of the result.\nCalculating the \"count\" attribute might in the future have a performance\nimpact for some queries so this option is turned off by default, and \"count\"\nis only returned when requested.\n\n", + "description": "indicates whether the number of documents in the result set should be returned in\nthe \"count\" attribute of the result.\nCalculating the \"count\" attribute might have a performance impact for some queries\nin the future so this option is turned off by default, and \"count\"\nis only returned when requested.\n\n", "format": "", "type": "boolean" }, @@ -759,22 +746,22 @@ "query" ], "type": "object", - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_cursor_opts": { "description": "key/value object with extra options for the query.\n\n", "properties": { "fullCount": { - "description": "if set to *true* and the query contains a *LIMIT* clause, then the\nresult will contain an extra attribute *extra* with a sub-attribute *fullCount*.\nThis sub-attribute will contain the number of documents in the result before the\nlast LIMIT in the query was applied. It can be used to count the number of documents that\nmatch certain filter criteria, but only return a subset of them, in one go.\nIt is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\nwill disable a few LIMIT optimizations and may lead to more documents being processed,\nand thus make queries run longer. Note that the *fullCount* sub-attribute will only\nbe present in the result if the query has a LIMIT clause and the LIMIT clause is\nactually used in the query.\n\n", + "description": "if set to *true* and the query contains a *LIMIT* clause, then the\nresult will have an *extra* attribute with the sub-attributes *stats*\nand *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`.\nThe *fullCount* attribute will contain the number of documents in the result before the\nlast LIMIT in the query was applied. It can be used to count the number of documents that\nmatch certain filter criteria, but only return a subset of them, in one go.\nIt is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\nwill disable a few LIMIT optimizations and may lead to more documents being processed,\nand thus make queries run longer. Note that the *fullCount* attribute will only\nbe present in the result if the query has a LIMIT clause and the LIMIT clause is\nactually used in the query.\n\n", "type": "boolean" }, "maxPlans": { - "description": "limits the maximum number of plans that are created by the AQL query optimizer.\n\n", + "description": "Limits the maximum number of plans that are created by the AQL query optimizer.\n\n", "format": "int64", "type": "integer" }, "optimizer.rules": { - "description": "a list of to-be-included or to-be-excluded optimizer rules\ncan be put into this attribute, telling the optimizer to include or exclude\nspecific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\nwith a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n\n", + "description": "A list of to-be-included or to-be-excluded optimizer rules\ncan be put into this attribute, telling the optimizer to include or exclude\nspecific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\nwith a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules.\n\n", "format": "string", "items": { "type": "string" @@ -782,12 +769,12 @@ "type": "array" }, "profile": { - "description": "if set to *true*, then the additional query profiling information\nwill be returned in the *extra.stats* return attribute if the query result is not\nserved from the query cache.\n\n", + "description": "If set to *true*, then the additional query profiling information will be returned\nin the sub-attribute *profile* of the *extra* return attribute if the query result\nis not served from the query cache.\n\n", "type": "boolean" } }, "type": "object", - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_cursor_rc_201": { "properties": { @@ -839,7 +826,7 @@ "cached" ], "type": "object", - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_cursor_rc_400": { "properties": { @@ -870,12 +857,12 @@ "errorMessage" ], "type": "object", - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_explain": { "properties": { "bindVars": { - "description": "key/value pairs representing the bind values\n\n", + "description": "key/value pairs representing the bind parameters.\n\n", "items": { "additionalProperties": {}, "type": "object" @@ -894,7 +881,7 @@ "query" ], "type": "object", - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "JSF_post_api_export": { "properties": { @@ -941,7 +928,7 @@ "ttl" ], "type": "object", - "x-filename": "Bulk - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md" }, "JSF_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", @@ -960,7 +947,7 @@ } }, "type": "object", - "x-filename": "Bulk - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md" }, "JSF_post_api_index_fulltext": { "properties": { @@ -987,7 +974,7 @@ "minLength" ], "type": "object", - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" }, "JSF_post_api_index_geo": { "properties": { @@ -1013,7 +1000,7 @@ "geoJson" ], "type": "object", - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" }, "JSF_post_api_index_hash": { "properties": { @@ -1046,7 +1033,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" }, "JSF_post_api_index_persistent": { "properties": { @@ -1079,7 +1066,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" }, "JSF_post_api_index_skiplist": { "properties": { @@ -1112,7 +1099,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" }, "JSF_post_api_new_tasks": { "properties": { @@ -1145,7 +1132,7 @@ "params" ], "type": "object", - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" }, "JSF_post_api_transaction": { "properties": { @@ -1177,7 +1164,7 @@ "action" ], "type": "object", - "x-filename": "Transactions - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" + "x-filename": "Transactions - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" }, "JSF_post_batch_replication": { "properties": { @@ -1191,7 +1178,7 @@ "ttl" ], "type": "object", - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "JSF_put_api_new_tasks": { "properties": { @@ -1224,7 +1211,7 @@ "params" ], "type": "object", - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" }, "JSF_put_api_replication_applier_adjust": { "properties": { @@ -1347,7 +1334,7 @@ "restrictType" ], "type": "object", - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "JSF_put_api_replication_makeSlave": { "properties": { @@ -1456,7 +1443,7 @@ "includeSystem" ], "type": "object", - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "JSF_put_api_replication_synchronize": { "properties": { @@ -1508,7 +1495,7 @@ "password" ], "type": "object", - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "JSF_put_batch_replication": { "properties": { @@ -1522,7 +1509,7 @@ "ttl" ], "type": "object", - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "PostApiQueryProperties": { "properties": { @@ -1535,7 +1522,7 @@ "query" ], "type": "object", - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "PutApiQueryCacheProperties": { "properties": { @@ -1554,7 +1541,7 @@ "maxResults" ], "type": "object", - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "PutApiQueryProperties": { "properties": { @@ -1592,7 +1579,7 @@ "maxQueryStringLength" ], "type": "object", - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "REST_DOCUMENT_READ_ALL": { "properties": { @@ -1606,7 +1593,7 @@ } }, "type": "object", - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" }, "RestLookupByKeys": { "properties": { @@ -1627,7 +1614,7 @@ "keys" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "RestRemoveByKeys": { "properties": { @@ -1651,7 +1638,94 @@ "keys" ], "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" + }, + "UserHandling_create": { + "properties": { + "active": { + "description": "An optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n", + "format": "boolean", + "type": "boolean" + }, + "extra": { + "additionalProperties": {}, + "description": "An optional JSON object with arbitrary extra data about the user.\n\n", + "type": "object" + }, + "passwd": { + "description": "The user password as a string. If no password is specified, the empty\nstring will be used. If you pass the special value\n*ARANGODB_DEFAULT_ROOT_PASSWORD*, the password will be set the value\nstored in the environment variable\n`ARANGODB_DEFAULT_ROOT_PASSWORD`. This can be used to pass an instance\nvariable into ArangoDB. For example, the instance identifier from\nAmazon.\n\n", + "type": "string" + }, + "user": { + "description": "The name of the user as a string. This is mandatory.\n\n", + "type": "string" + } + }, + "required": [ + "user", + "passwd" + ], + "type": "object", + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" + }, + "UserHandling_grantDatabase": { + "properties": { + "grant": { + "description": "Use \"rw\" to grant access right and \"none\" to revoke.\n\n", + "type": "string" + } + }, + "required": [ + "grant" + ], + "type": "object", + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" + }, + "UserHandling_modify": { + "properties": { + "active": { + "description": "An optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n", + "format": "boolean", + "type": "boolean" + }, + "extra": { + "additionalProperties": {}, + "description": "An optional JSON object with arbitrary extra data about the user.\n\n", + "type": "object" + }, + "passwd": { + "description": "The user password as a string. Specifying a password is mandatory, but\nthe empty string is allowed for passwords\n\n", + "type": "string" + } + }, + "required": [ + "passwd" + ], + "type": "object", + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" + }, + "UserHandling_replace": { + "properties": { + "active": { + "description": "An optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n", + "format": "boolean", + "type": "boolean" + }, + "extra": { + "additionalProperties": {}, + "description": "An optional JSON object with arbitrary extra data about the user.\n\n", + "type": "object" + }, + "passwd": { + "description": "The user password as a string. Specifying a password is mandatory, but\nthe empty string is allowed for passwords\n\n", + "type": "string" + } + }, + "required": [ + "passwd" + ], + "type": "object", + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" }, "collection_figures": { "description": "metrics of the collection\n\n", @@ -1719,7 +1793,7 @@ "indexes" ], "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_alive": { "description": "the currently active figures\n\n", @@ -1736,7 +1810,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_attributes": { "description": "", @@ -1753,7 +1827,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_compactors": { "description": "\n", @@ -1770,7 +1844,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_datafiles": { "description": "Metrics regarding the datafiles\n\n", @@ -1787,7 +1861,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_dead": { "description": "the items waiting to be swept away by the cleaner\n\n", @@ -1809,7 +1883,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_indexes": { "description": "", @@ -1826,7 +1900,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_journals": { "description": "Metrics regarding the journal files\n\n", @@ -1843,7 +1917,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_shapefiles": { "description": "**deprecated**\n\n", @@ -1860,7 +1934,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_shapes": { "description": "", @@ -1877,7 +1951,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "compactionStatus_attributes": { "description": "", @@ -1892,7 +1966,7 @@ } }, "type": "object", - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "explain_options": { "description": "Options for the query\n\n", @@ -1916,7 +1990,7 @@ } }, "type": "object", - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "put_api_simple_remove_by_example_opts": { "description": "a json object which can contains following attributes:\n\n", @@ -1931,7 +2005,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "put_api_simple_remove_by_keys_opts": { "description": "a json object which can contains following attributes:\n\n", @@ -1950,7 +2024,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "put_api_simple_replace_by_example_options": { "description": "a json object which can contain following attributes\n\n", @@ -1965,7 +2039,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" }, "put_api_simple_update_by_example_options": { "description": "a json object which can contains following attributes:\n\n", @@ -1989,7 +2063,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "info": { @@ -2010,7 +2084,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "get": { "description": "\n\n\nExecutes a cluster roundtrip from a coordinator to a DB server and\nback. This call only works in a coordinator node in a cluster.\nOne can and should append an arbitrary path to the URL and the\npart after */_admin/cluster-test* is used as the path of the HTTP\nrequest which is sent from the coordinator to a DB node. Likewise,\nany form data appended to the URL is forwarded in the request to the\nDB node. This handler takes care of all request types (see below)\nand uses the same request type in its request to the DB node.\n\nThe following HTTP headers are interpreted in a special way:\n\n - *X-Shard-ID*: This specifies the ID of the shard to which the\n cluster request is sent and thus tells the system to which DB server\n to send the cluster request. Note that the mapping from the\n shard ID to the responsible server has to be defined in the\n agency under *Current/ShardLocation/*. One has to give\n this header, otherwise the system does not know where to send\n the request.\n - *X-Client-Transaction-ID*: the value of this header is taken\n as the client transaction ID for the request\n - *X-Timeout*: specifies a timeout in seconds for the cluster\n operation. If the answer does not arrive within the specified\n timeout, an corresponding error is returned and any subsequent\n real answer is ignored. The default if not given is 24 hours.\n - *X-Synchronous-Mode*: If set to *true* the test function uses\n synchronous mode, otherwise the default asynchronous operation\n mode is used. This is mainly for debugging purposes.\n - *Host*: This header is ignored and not forwarded to the DB server.\n - *User-Agent*: This header is ignored and not forwarded to the DB\n server.\n\nAll other HTTP headers and the body of the request (if present, see\nother HTTP methods below) are forwarded as given in the original request.\n\nIn asynchronous mode the DB server answers with an HTTP request of its\nown, in synchronous mode it sends a HTTP response. In both cases the\nheaders and the body are used to produce the HTTP response of this\nAPI call.\n\n", @@ -2031,7 +2105,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "head": { "description": "\n\nSee GET method.\n\n\n", @@ -2041,7 +2115,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "patch": { "description": "\nfree style json body\n\n\n\nSee GET method. The body can be any type and is simply forwarded.\n\n\n", @@ -2063,7 +2137,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "post": { "description": "\nfree style json body\n\n\n\nSee GET method.\n\n\n", @@ -2085,7 +2159,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "put": { "description": "\nfree style json body\n\n\n\nSee GET method. The body can be any type and is simply forwarded.\n\n\n", @@ -2107,7 +2181,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/clusterCheckPort": { @@ -2135,7 +2209,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/clusterStatistics": { @@ -2166,7 +2240,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/database/target-version": { @@ -2183,7 +2257,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/echo": { @@ -2200,7 +2274,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/execute": { @@ -2224,7 +2298,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/log": { @@ -2294,7 +2368,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/long_echo": { @@ -2311,7 +2385,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/routing/reload": { @@ -2328,7 +2402,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/server/id": { @@ -2345,7 +2419,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/server/role": { @@ -2362,7 +2436,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/shutdown": { @@ -2379,7 +2453,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/sleep": { @@ -2405,12 +2479,12 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/statistics": { "get": { - "description": "\n\n\nReturns the statistics information. The returned object contains the\nstatistics figures grouped together according to the description returned by\n*_admin/statistics-description*. For instance, to access a figure *userTime*\nfrom the group *system*, you first select the sub-object describing the\ngroup stored in *system* and in that sub-object the value for *userTime* is\nstored in the attribute of the same name.\n\nIn case of a distribution, the returned object contains the total count in\n*count* and the distribution list in *counts*. The sum (or total) of the\nindividual values is returned in *sum*.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"time\" : 1466169092.174889, \n  \"enabled\" : true, \n  \"system\" : { \n    \"minorPageFaults\" : 102362, \n    \"majorPageFaults\" : 0, \n    \"userTime\" : 3.62, \n    \"systemTime\" : 1.27, \n    \"numberOfThreads\" : 25, \n    \"residentSize\" : 227049472, \n    \"residentSizePercent\" : 0.006731417743537259, \n    \"virtualSize\" : 2322108416 \n  }, \n  \"client\" : { \n    \"httpConnections\" : 1, \n    \"connectionTime\" : { \n      \"sum\" : 0.0010251998901367188, \n      \"count\" : 2, \n      \"counts\" : [ \n        2, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"totalTime\" : { \n      \"sum\" : 13.568241834640503, \n      \"count\" : 3777, \n      \"counts\" : [ \n        3541, \n        142, \n        82, \n        11, \n        1, \n        0, \n        0 \n      ] \n    }, \n    \"requestTime\" : { \n      \"sum\" : 13.03047490119934, \n      \"count\" : 3777, \n      \"counts\" : [ \n        3542, \n        144, \n        80, \n        10, \n        1, \n        0, \n        0 \n      ] \n    }, \n    \"queueTime\" : { \n      \"sum\" : 0.11764764785766602, \n      \"count\" : 3752, \n      \"counts\" : [ \n        3752, \n        0, \n        0, \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"ioTime\" : { \n      \"sum\" : 0.4201192855834961, \n      \"count\" : 3777, \n      \"counts\" : [ \n        3777, \n        0, \n        0, \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"bytesSent\" : { \n      \"sum\" : 1204776, \n      \"count\" : 3777, \n      \"counts\" : [ \n        2713, \n        799, \n        260, \n        5, \n        0, \n        0 \n      ] \n    }, \n    \"bytesReceived\" : { \n      \"sum\" : 819158, \n      \"count\" : 3777, \n      \"counts\" : [ \n        3499, \n        278, \n        0, \n        0, \n        0, \n        0 \n      ] \n    } \n  }, \n  \"http\" : { \n    \"requestsTotal\" : 3777, \n    \"requestsAsync\" : 9, \n    \"requestsGet\" : 754, \n    \"requestsHead\" : 0, \n    \"requestsPost\" : 2756, \n    \"requestsPut\" : 120, \n    \"requestsPatch\" : 3, \n    \"requestsDelete\" : 144, \n    \"requestsOptions\" : 0, \n    \"requestsOther\" : 0 \n  }, \n  \"server\" : { \n    \"uptime\" : 47.61853384971619, \n    \"physicalMemory\" : 33729814528 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\n\nReturns the statistics information. The returned object contains the\nstatistics figures grouped together according to the description returned by\n*_admin/statistics-description*. For instance, to access a figure *userTime*\nfrom the group *system*, you first select the sub-object describing the\ngroup stored in *system* and in that sub-object the value for *userTime* is\nstored in the attribute of the same name.\n\nIn case of a distribution, the returned object contains the total count in\n*count* and the distribution list in *counts*. The sum (or total) of the\nindividual values is returned in *sum*.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_admin/statistics\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"time\" : 1471531346.356035, \n  \"enabled\" : true, \n  \"system\" : { \n    \"minorPageFaults\" : 74887, \n    \"majorPageFaults\" : 0, \n    \"userTime\" : 1.7, \n    \"systemTime\" : 0.75, \n    \"numberOfThreads\" : 25, \n    \"residentSize\" : 249344000, \n    \"residentSizePercent\" : 0.014926862664036106, \n    \"virtualSize\" : 2323369984 \n  }, \n  \"client\" : { \n    \"httpConnections\" : 1, \n    \"connectionTime\" : { \n      \"sum\" : 0.0002200603485107422, \n      \"count\" : 1, \n      \"counts\" : [ \n        1, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"totalTime\" : { \n      \"sum\" : 4.379083871841431, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3677, \n        102, \n        13, \n        1, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"requestTime\" : { \n      \"sum\" : 4.2216126918792725, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3678, \n        101, \n        13, \n        1, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"queueTime\" : { \n      \"sum\" : 0.03446626663208008, \n      \"count\" : 3769, \n      \"counts\" : [ \n        3769, \n        0, \n        0, \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"ioTime\" : { \n      \"sum\" : 0.12300491333007812, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3793, \n        0, \n        0, \n        0, \n        0, \n        0, \n        0 \n      ] \n    }, \n    \"bytesSent\" : { \n      \"sum\" : 1250670, \n      \"count\" : 3793, \n      \"counts\" : [ \n        393, \n        3128, \n        268, \n        4, \n        0, \n        0 \n      ] \n    }, \n    \"bytesReceived\" : { \n      \"sum\" : 822614, \n      \"count\" : 3793, \n      \"counts\" : [ \n        3510, \n        283, \n        0, \n        0, \n        0, \n        0 \n      ] \n    } \n  }, \n  \"http\" : { \n    \"requestsTotal\" : 3793, \n    \"requestsAsync\" : 9, \n    \"requestsGet\" : 762, \n    \"requestsHead\" : 0, \n    \"requestsPost\" : 2764, \n    \"requestsPut\" : 120, \n    \"requestsPatch\" : 3, \n    \"requestsDelete\" : 144, \n    \"requestsOptions\" : 0, \n    \"requestsOther\" : 0 \n  }, \n  \"server\" : { \n    \"uptime\" : 35.99648380279541, \n    \"physicalMemory\" : 16704380928 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -2422,7 +2496,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/statistics-description": { @@ -2439,7 +2513,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/test": { @@ -2463,7 +2537,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/time": { @@ -2480,7 +2554,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_admin/wal/flush": { @@ -2515,7 +2589,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" } }, "/_admin/wal/properties": { @@ -2535,7 +2609,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" }, "put": { "description": "\n\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\n\n{ \n  \"allowOversizeEntries\" : true, \n  \"logfileSize\" : 33554432, \n  \"historicLogfiles\" : 10, \n  \"reserveLogfiles\" : 3, \n  \"syncInterval\" : 100, \n  \"throttleWait\" : 15000, \n  \"throttleWhenPending\" : 0, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -2553,12 +2627,12 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" } }, "/_admin/wal/transactions": { "get": { - "description": "\n\n\nReturns information about the currently running transactions. The result\nis a JSON object with the following attributes:\n- *runningTransactions*: number of currently running transactions\n- *minLastCollected*: minimum id of the last collected logfile (at the\n start of each running transaction). This is *null* if no transaction is\n running.\n- *minLastSealed*: minimum id of the last sealed logfile (at the\n start of each running transaction). This is *null* if no transaction is\n running.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_admin/wal/transactions\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"runningTransactions\" : 1, \n  \"minLastCollected\" : \"9893\", \n  \"minLastSealed\" : \"9893\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\n\nReturns information about the currently running transactions. The result\nis a JSON object with the following attributes:\n- *runningTransactions*: number of currently running transactions\n- *minLastCollected*: minimum id of the last collected logfile (at the\n start of each running transaction). This is *null* if no transaction is\n running.\n- *minLastSealed*: minimum id of the last sealed logfile (at the\n start of each running transaction). This is *null* if no transaction is\n running.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_admin/wal/transactions\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"runningTransactions\" : 1, \n  \"minLastCollected\" : \"9303\", \n  \"minLastSealed\" : \"9303\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -2573,7 +2647,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" } }, "/_api/aqlfunction": { @@ -2598,7 +2672,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "post": { "description": "**A json post document with these Properties is required:**\n\n - **isDeterministic**: an optional boolean value to indicate that 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, the returned JSON object has the following properties:\n\n- *error*: boolean flag to indicate that an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\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}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", @@ -2629,7 +2703,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/aqlfunction/{name}": { @@ -2668,12 +2742,12 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/batch": { "post": { - "description": "\nfree style json body\n\n\n\nExecutes a batch request. A batch request can contain any number of\nother requests that can be sent to ArangoDB in isolation. The benefit of\nusing batch requests is that batching requests requires less client/server\nroundtrips than when sending isolated requests.\n\nAll parts of a batch request are executed serially on the server. The\nserver will return the results of all parts in a single response when all\nparts are finished.\n\nTechnically, a batch request is a multipart HTTP request, with\ncontent-type `multipart/form-data`. A batch request consists of an\nenvelope and the individual batch part actions. Batch part actions\nare \"regular\" HTTP requests, including full header and an optional body.\nMultiple batch parts are separated by a boundary identifier. The\nboundary identifier is declared in the batch envelope. The MIME content-type\nfor each individual batch part must be `application/x-arango-batchpart`.\n\nPlease note that when constructing the individual batch parts, you must\nuse CRLF (`\\\\\\r\\\\\\n`) as the line terminator as in regular HTTP messages.\n\nThe response sent by the server will be an `HTTP 200` response, with an\noptional error summary header `x-arango-errors`. This header contains the\nnumber of batch part operations that failed with an HTTP error code of at\nleast 400. This header is only present in the response if the number of\nerrors is greater than zero.\n\nThe response sent by the server is a multipart response, too. It contains\nthe individual HTTP responses for all batch parts, including the full HTTP\nresult header (with status code and other potential headers) and an\noptional result body. The individual batch parts in the result are\nseperated using the same boundary value as specified in the request.\n\nThe order of batch parts in the response will be the same as in the\noriginal client request. Client can additionally use the `Content-Id`\nMIME header in a batch part to define an individual id for each batch part.\nThe server will return this id is the batch part responses, too.\n\n\n\n\n#Example:\n Sending a batch request with five batch parts:\n\n- GET /_api/version\n\n- DELETE /_api/collection/products\n\n- POST /_api/collection/products\n\n- GET /_api/collection/products/figures\n\n- DELETE /_api/collection/products\n\nThe boundary (`SomeBoundaryValue`) is passed to the server in the HTTP\n`Content-Type` HTTP header.\n*Please note the reply is not displayed all accurate.*\n\n
shell> curl -X POST --header 'Content-Type: multipart/form-data; boundary=SomeBoundaryValue' --data-binary @- --dump - http://localhost:8529/_api/batch <<EOF\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nGET /_api/version HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nPOST /_api/collection/products HTTP/1.1\r\n\r\n{\"name\": \"products\" }\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nGET /_api/collection/products/figures HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n--SomeBoundaryValue--\r\n\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: multipart/form-data; boundary=SomeBoundaryValue\nx-arango-errors: 1\n\n\"--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: myId1\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 43\\r\\n\\r\\n{\\\"server\\\":\\\"arango\\\",\\\"version\\\":\\\"3.0.x-devel\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: myId2\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 88\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":1203,\\\"errorMessage\\\":\\\"unknown collection 'products'\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: someId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nLocation: /_db/_system/_api/collection/products\\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 132\\r\\n\\r\\n{\\\"id\\\":\\\"9543\\\",\\\"name\\\":\\\"products\\\",\\\"waitForSync\\\":false,\\\"isVolatile\\\":false,\\\"isSystem\\\":false,\\\"status\\\":3,\\\"type\\\":2,\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: nextId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nLocation: /_db/_system/_api/collection/products/figures\\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 659\\r\\n\\r\\n{\\\"id\\\":\\\"9543\\\",\\\"name\\\":\\\"products\\\",\\\"isSystem\\\":false,\\\"doCompact\\\":true,\\\"isVolatile\\\":false,\\\"journalSize\\\":33554432,\\\"keyOptions\\\":{\\\"type\\\":\\\"traditional\\\",\\\"allowUserKeys\\\":true},\\\"waitForSync\\\":false,\\\"indexBuckets\\\":8,\\\"count\\\":0,\\\"figures\\\":{\\\"alive\\\":{\\\"count\\\":0,\\\"size\\\":0},\\\"dead\\\":{\\\"count\\\":0,\\\"size\\\":0,\\\"deletion\\\":0},\\\"datafiles\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"journals\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"compactors\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"indexes\\\":{\\\"count\\\":1,\\\"size\\\":16064},\\\"lastTick\\\":\\\"0\\\",\\\"uncollectedLogfileEntries\\\":0,\\\"documentReferences\\\":0,\\\"waitingFor\\\":\\\"-\\\",\\\"compactionStatus\\\":{\\\"message\\\":\\\"compaction not yet started\\\",\\\"time\\\":\\\"2016-06-17T13:11:32Z\\\"}},\\\"status\\\":3,\\\"type\\\":2,\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: otherId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 38\\r\\n\\r\\n{\\\"id\\\":\\\"9543\\\",\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue--\"\n
\n\n\n\n\n#Example:\n Sending a batch request, setting the boundary implicitly (the server will\nin this case try to find the boundary at the beginning of the request body).\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/batch <<EOF\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\n\r\nDELETE /_api/collection/notexisting1 HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\n\r\nDELETE _api/collection/notexisting2 HTTP/1.1\r\n--SomeBoundaryValue--\r\n\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: \nx-arango-errors: 2\n\n\"--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 92\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":1203,\\\"errorMessage\\\":\\\"unknown collection 'notexisting1'\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 101\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":404,\\\"errorMessage\\\":\\\"unknown path '_api/collection/notexisting2'\\\"}\\r\\n--SomeBoundaryValue--\"\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\n\nExecutes a batch request. A batch request can contain any number of\nother requests that can be sent to ArangoDB in isolation. The benefit of\nusing batch requests is that batching requests requires less client/server\nroundtrips than when sending isolated requests.\n\nAll parts of a batch request are executed serially on the server. The\nserver will return the results of all parts in a single response when all\nparts are finished.\n\nTechnically, a batch request is a multipart HTTP request, with\ncontent-type `multipart/form-data`. A batch request consists of an\nenvelope and the individual batch part actions. Batch part actions\nare \"regular\" HTTP requests, including full header and an optional body.\nMultiple batch parts are separated by a boundary identifier. The\nboundary identifier is declared in the batch envelope. The MIME content-type\nfor each individual batch part must be `application/x-arango-batchpart`.\n\nPlease note that when constructing the individual batch parts, you must\nuse CRLF (`\\\\\\r\\\\\\n`) as the line terminator as in regular HTTP messages.\n\nThe response sent by the server will be an `HTTP 200` response, with an\noptional error summary header `x-arango-errors`. This header contains the\nnumber of batch part operations that failed with an HTTP error code of at\nleast 400. This header is only present in the response if the number of\nerrors is greater than zero.\n\nThe response sent by the server is a multipart response, too. It contains\nthe individual HTTP responses for all batch parts, including the full HTTP\nresult header (with status code and other potential headers) and an\noptional result body. The individual batch parts in the result are\nseperated using the same boundary value as specified in the request.\n\nThe order of batch parts in the response will be the same as in the\noriginal client request. Client can additionally use the `Content-Id`\nMIME header in a batch part to define an individual id for each batch part.\nThe server will return this id is the batch part responses, too.\n\n\n\n\n#Example:\n Sending a batch request with five batch parts:\n\n- GET /_api/version\n\n- DELETE /_api/collection/products\n\n- POST /_api/collection/products\n\n- GET /_api/collection/products/figures\n\n- DELETE /_api/collection/products\n\nThe boundary (`SomeBoundaryValue`) is passed to the server in the HTTP\n`Content-Type` HTTP header.\n*Please note the reply is not displayed all accurate.*\n\n
shell> curl -X POST --header 'Content-Type: multipart/form-data; boundary=SomeBoundaryValue' --data-binary @- --dump - http://localhost:8529/_api/batch <<EOF\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId1\r\n\r\nGET /_api/version HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: myId2\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: someId\r\n\r\nPOST /_api/collection/products HTTP/1.1\r\n\r\n{\"name\": \"products\" }\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: nextId\r\n\r\nGET /_api/collection/products/figures HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\nContent-Id: otherId\r\n\r\nDELETE /_api/collection/products HTTP/1.1\r\n--SomeBoundaryValue--\r\n\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: multipart/form-data; boundary=SomeBoundaryValue\nx-arango-errors: 1\n\n\"--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: myId1\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nConnection: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nContent-Length: 41\\r\\n\\r\\n{\\\"server\\\":\\\"arango\\\",\\\"version\\\":\\\"3.0.devel\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: myId2\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 88\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":1203,\\\"errorMessage\\\":\\\"unknown collection 'products'\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: someId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nLocation: /_db/_system/_api/collection/products\\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 132\\r\\n\\r\\n{\\\"id\\\":\\\"8954\\\",\\\"name\\\":\\\"products\\\",\\\"waitForSync\\\":false,\\\"isVolatile\\\":false,\\\"isSystem\\\":false,\\\"status\\\":3,\\\"type\\\":2,\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: nextId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nLocation: /_db/_system/_api/collection/products/figures\\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 659\\r\\n\\r\\n{\\\"id\\\":\\\"8954\\\",\\\"name\\\":\\\"products\\\",\\\"isSystem\\\":false,\\\"doCompact\\\":true,\\\"isVolatile\\\":false,\\\"journalSize\\\":33554432,\\\"keyOptions\\\":{\\\"type\\\":\\\"traditional\\\",\\\"allowUserKeys\\\":true},\\\"waitForSync\\\":false,\\\"indexBuckets\\\":8,\\\"count\\\":0,\\\"figures\\\":{\\\"alive\\\":{\\\"count\\\":0,\\\"size\\\":0},\\\"dead\\\":{\\\"count\\\":0,\\\"size\\\":0,\\\"deletion\\\":0},\\\"datafiles\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"journals\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"compactors\\\":{\\\"count\\\":0,\\\"fileSize\\\":0},\\\"indexes\\\":{\\\"count\\\":1,\\\"size\\\":16064},\\\"lastTick\\\":\\\"0\\\",\\\"uncollectedLogfileEntries\\\":0,\\\"documentReferences\\\":0,\\\"waitingFor\\\":\\\"-\\\",\\\"compactionStatus\\\":{\\\"message\\\":\\\"compaction not yet started\\\",\\\"time\\\":\\\"2016-08-18T14:42:26Z\\\"}},\\\"status\\\":3,\\\"type\\\":2,\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\nContent-Id: otherId\\r\\n\\r\\nHTTP/1.1 200 OK\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 38\\r\\n\\r\\n{\\\"id\\\":\\\"8954\\\",\\\"error\\\":false,\\\"code\\\":200}\\r\\n--SomeBoundaryValue--\"\n
\n\n\n\n\n#Example:\n Sending a batch request, setting the boundary implicitly (the server will\nin this case try to find the boundary at the beginning of the request body).\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/batch <<EOF\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\n\r\nDELETE /_api/collection/notexisting1 HTTP/1.1\r\n\r\n--SomeBoundaryValue\r\nContent-Type: application/x-arango-batchpart\r\n\r\nDELETE _api/collection/notexisting2 HTTP/1.1\r\n--SomeBoundaryValue--\r\n\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: \nx-arango-errors: 2\n\n\"--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 92\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":1203,\\\"errorMessage\\\":\\\"unknown collection 'notexisting1'\\\"}\\r\\n--SomeBoundaryValue\\r\\nContent-Type: application/x-arango-batchpart\\r\\n\\r\\nHTTP/1.1 404 Not Found\\r\\nServer: \\r\\nContent-Type: application/json; charset=utf-8\\r\\nConnection: \\r\\nContent-Length: 101\\r\\n\\r\\n{\\\"error\\\":true,\\\"code\\\":404,\\\"errorNum\\\":404,\\\"errorMessage\\\":\\\"unknown path '_api/collection/notexisting2'\\\"}\\r\\n--SomeBoundaryValue--\"\n
\n\n\n\n\n", "parameters": [ { "description": "The multipart batch request, consisting of the envelope and the individual\nbatch parts.\n\n", @@ -2703,12 +2777,12 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md" } }, "/_api/collection": { "get": { - "description": "\n\nReturns an object with an attribute *collections* containing an\narray of all collection descriptions. The same information is also\navailable in the *names* as an object with the collection names\nas keys.\n\nBy providing the optional query parameter *excludeSystem* with a value of\n*true*, all system collections will be excluded from the response.\n\n\n\n\n#Example:\n Return information about all collections:\n\n
shell> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"id\" : \"61\", \n      \"name\" : \"_apps\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"38\", \n      \"name\" : \"_aqlfunctions\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"55\", \n      \"name\" : \"_frontend\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"4\", \n      \"name\" : \"_graphs\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"59\", \n      \"name\" : \"_jobs\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"23\", \n      \"name\" : \"_modules\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"57\", \n      \"name\" : \"_queues\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"25\", \n      \"name\" : \"_routing\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"45\", \n      \"name\" : \"_statistics\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"50\", \n      \"name\" : \"_statistics15\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"40\", \n      \"name\" : \"_statisticsRaw\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"8\", \n      \"name\" : \"_users\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"95\", \n      \"name\" : \"animals\", \n      \"isSystem\" : false, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"89\", \n      \"name\" : \"demo\", \n      \"isSystem\" : false, \n      \"status\" : 3, \n      \"type\" : 2 \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nReturns an object with an attribute *collections* containing an\narray of all collection descriptions. The same information is also\navailable in the *names* as an object with the collection names\nas keys.\n\nBy providing the optional query parameter *excludeSystem* with a value of\n*true*, all system collections will be excluded from the response.\n\n\n\n\n#Example:\n Return information about all collections:\n\n
shell> curl --dump - http://localhost:8529/_api/collection\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"id\" : \"60\", \n      \"name\" : \"_apps\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"37\", \n      \"name\" : \"_aqlfunctions\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"54\", \n      \"name\" : \"_frontend\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"2\", \n      \"name\" : \"_graphs\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"58\", \n      \"name\" : \"_jobs\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"22\", \n      \"name\" : \"_modules\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"56\", \n      \"name\" : \"_queues\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"24\", \n      \"name\" : \"_routing\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"44\", \n      \"name\" : \"_statistics\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"49\", \n      \"name\" : \"_statistics15\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"39\", \n      \"name\" : \"_statisticsRaw\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"7\", \n      \"name\" : \"_users\", \n      \"isSystem\" : true, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"92\", \n      \"name\" : \"animals\", \n      \"isSystem\" : false, \n      \"status\" : 3, \n      \"type\" : 2 \n    }, \n    { \n      \"id\" : \"87\", \n      \"name\" : \"demo\", \n      \"isSystem\" : false, \n      \"status\" : 3, \n      \"type\" : 2 \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "Whether or not system collections should be excluded from the result.\n\n", @@ -2728,10 +2802,10 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "post": { - "description": "**A json post document 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 - **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 - **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 - **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\n\n\n\nCreates an new collection with a given name. The request must contain an\nobject with the following attributes.\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\nlocation: /_db/_system/_api/collection/testCollectionBasics\n\n{ \n  \"id\" : \"9548\", \n  \"name\" : \"testCollectionBasics\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \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\nlocation: /_db/_system/_api/collection/testCollectionEdges\n\n{ \n  \"id\" : \"9550\", \n  \"name\" : \"testCollectionEdges\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \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\nlocation: /_db/_system/_api/collection/testCollectionUsers\n\n{ \n  \"id\" : \"9554\", \n  \"name\" : \"testCollectionUsers\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "**A json post document 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 - **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 - **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 - **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\n\n\n\nCreates an new collection with a given name. The request must contain an\nobject with the following attributes.\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\nlocation: /_db/_system/_api/collection/testCollectionBasics\n\n{ \n  \"id\" : \"8959\", \n  \"name\" : \"testCollectionBasics\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \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\nlocation: /_db/_system/_api/collection/testCollectionEdges\n\n{ \n  \"id\" : \"8961\", \n  \"name\" : \"testCollectionEdges\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \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\nlocation: /_db/_system/_api/collection/testCollectionUsers\n\n{ \n  \"id\" : \"8965\", \n  \"name\" : \"testCollectionUsers\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -2756,12 +2830,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}": { "delete": { - "description": "\n\nDrops the collection identified by *collection-name*.\n\nIf the collection was successfully dropped, an object is returned with\nthe following attributes:\n\n- *error*: *false*\n\n- *id*: The identifier of the dropped collection.\n\n\n\n\n#Example:\n Using an identifier:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/9557\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9557\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a name:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9560\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nDrops the collection identified by *collection-name*.\n\nIf the collection was successfully dropped, an object is returned with\nthe following attributes:\n\n- *error*: *false*\n\n- *id*: The identifier of the dropped collection.\n\n\n\n\n#Example:\n Using an identifier:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/8968\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"8968\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a name:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/collection/products1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"8971\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection to drop.\n\n", @@ -2785,7 +2859,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.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", @@ -2809,12 +2883,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/checksum": { "get": { - "description": "\n\nWill calculate a checksum of the meta-data (keys and optionally revision ids) and\noptionally the document data in the collection.\n\nThe checksum can be used to compare if two collections on different ArangoDB\ninstances contain the same contents. The current revision of the collection is\nreturned too so one can make sure the checksums are calculated for the same\nstate of data.\n\nBy default, the checksum will only be calculated on the *_key* system attribute\nof the documents contained in the collection. For edge collections, the system\nattributes *_from* and *_to* will also be included in the calculation.\n\nBy setting the optional query parameter *withRevisions* to *true*, then revision\nids (*_rev* system attributes) are included in the checksumming.\n\nBy providing the optional query parameter *withData* with a value of *true*,\nthe user-defined document attributes will be included in the calculation too.\n**Note**: Including user-defined attributes will make the checksumming slower.\n\nThe response is a JSON object with the following attributes:\n\n- *checksum*: The calculated checksum as a number.\n\n- *revision*: The collection revision id as a string.\n\n**Note**: this method is not available in a cluster.\n\n\n\n\n#Example:\n Retrieving the checksum of a collection:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/checksum\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9563\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"checksum\" : \"9481966707640211634\", \n  \"revision\" : \"9568\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Retrieving the checksum of a collection including the collection data,\nbut not the revisions:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/checksum?withRevisions=false&withData=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9572\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"checksum\" : \"9089522856283954813\", \n  \"revision\" : \"9577\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nWill calculate a checksum of the meta-data (keys and optionally revision ids) and\noptionally the document data in the collection.\n\nThe checksum can be used to compare if two collections on different ArangoDB\ninstances contain the same contents. The current revision of the collection is\nreturned too so one can make sure the checksums are calculated for the same\nstate of data.\n\nBy default, the checksum will only be calculated on the *_key* system attribute\nof the documents contained in the collection. For edge collections, the system\nattributes *_from* and *_to* will also be included in the calculation.\n\nBy setting the optional query parameter *withRevisions* to *true*, then revision\nids (*_rev* system attributes) are included in the checksumming.\n\nBy providing the optional query parameter *withData* with a value of *true*,\nthe user-defined document attributes will be included in the calculation too.\n**Note**: Including user-defined attributes will make the checksumming slower.\n\nThe response is a JSON object with the following attributes:\n\n- *checksum*: The calculated checksum as a number.\n\n- *revision*: The collection revision id as a string.\n\n**Note**: this method is not available in a cluster.\n\n\n\n\n#Example:\n Retrieving the checksum of a collection:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/checksum\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"8974\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"checksum\" : \"17436627089227009034\", \n  \"revision\" : \"1543012453210652672\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Retrieving the checksum of a collection including the collection data,\nbut not the revisions:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/checksum?withRevisions=false&withData=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"8982\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"checksum\" : \"17160957728564846223\", \n  \"revision\" : \"1543012453228478464\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -2852,12 +2926,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/count": { "get": { - "description": "\n\nIn addition to the above, the result also contains the number of documents.\n**Note** that this will always load the collection into memory.\n\n- *count*: The number of documents inside the collection.\n\n\n\n\n#Example:\n Requesting the number of documents:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/count\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/count\n\n{ \n  \"id\" : \"9580\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"count\" : 100, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nIn addition to the above, the result also contains the number of documents.\n**Note** that this will always load the collection into memory.\n\n- *count*: The number of documents inside the collection.\n\n\n\n\n#Example:\n Requesting the number of documents:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/count\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/count\n\n{ \n  \"id\" : \"8990\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"count\" : 100, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -2881,12 +2955,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/figures": { "get": { - "description": "\n\nIn addition to the above, the result also contains the number of documents\nand additional statistical information about the collection.\n**Note** : This will always load the collection into memory.\n\n**Note**: collection data that are stored in the write-ahead log only are\nnot reported in the results. When the write-ahead log is collected, documents\nmight be added to journals and datafiles of the collection, which may modify\nthe figures of the collection.\n\nAdditionally, the filesizes of collection and index parameter JSON files are\nnot reported. These files should normally have a size of a few bytes\neach. Please also note that the *fileSize* values are reported in bytes\nand reflect the logical file sizes. Some filesystems may use optimisations\n(e.g. sparse files) so that the actual physical file size is somewhat\ndifferent. Directories and sub-directories may also require space in the\nfile system, but this space is not reported in the *fileSize* results.\n\nThat means that the figures reported do not reflect the actual disk\nusage of the collection with 100% accuracy. The actual disk usage of\na collection is normally slightly higher than the sum of the reported\n*fileSize* values. Still the sum of the *fileSize* values can still be\nused as a lower bound approximation of the disk usage.\n\n**A json document with these Properties is returned:**\n\n##HTTP 200\nReturns information about the collection:\n\n - **count**: The number of documents currently present in the collection.\n - **journalSize**: The maximal size of a journal or datafile in bytes.\n - **figures**:\n - **datafiles**:\n - **count**: The number of datafiles.\n - **fileSize**: The total filesize of datafiles (in bytes).\n - **uncollectedLogfileEntries**: The number of markers in the write-ahead\n log for this collection that have not been transferred to journals or datafiles.\n - **compactionStatus**:\n - **message**: The action that was performed when the compaction was last run for the collection. \n This information can be used for debugging compaction issues.\n - **time**: The point in time the compaction for the collection was last executed. \n This information can be used for debugging compaction issues.\n - **compactors**:\n - **count**: The number of compactor files.\n - **fileSize**: The total filesize of all compactor files (in bytes).\n - **dead**:\n - **count**: The number of dead documents. This includes document\n versions that have been deleted or replaced by a newer version. Documents\n deleted or replaced that are contained the write-ahead log only are not reported\n in this figure.\n - **deletion**: The total number of deletion markers. Deletion markers\n only contained in the write-ahead log are not reporting in this figure.\n - **size**: The total size in bytes used by all dead documents.\n - **indexes**:\n - **count**: The total number of indexes defined for the collection, including the pre-defined\n indexes (e.g. primary index).\n - **size**: The total memory allocated for indexes in bytes.\n - **shapes**:\n - **count**: The total number of shapes used in the collection. This includes shapes\n that are not in use anymore. Shapes that are contained\n in the write-ahead log only are not reported in this figure.\n - **size**: The total size of all shapes (in bytes). This includes\n shapes that are not in use anymore. Shapes that are contained in the\n write-ahead log only are not reported in this figure.\n - **waitingFor**: An optional string value that contains information about which object type is at the \n head of the collection's cleanup queue. This information can be used for debugging \n compaction and unload issues.\n - **alive**:\n - **count**: The number of currently active documents in all datafiles\n and journals of the collection. Documents that are contained in the\n write-ahead log only are not reported in this figure.\n - **size**: The total size in bytes used by all active documents of\n the collection. Documents that are contained in the write-ahead log only are\n not reported in this figure.\n - **documentReferences**: The number of references to documents in datafiles that JavaScript code \n currently holds. This information can be used for debugging compaction and \n unload issues.\n - **attributes**:\n - **count**: The total number of attributes used in the\n collection. Note: the value includes data of attributes that are not in use\n anymore. Attributes that are contained in the write-ahead log only are\n not reported in this figure.\n - **size**: The total size of the attribute data (in bytes).\n Note: the value includes data of attributes that are not in use anymore.\n Attributes that are contained in the write-ahead log only are not\n reported in this figure.\n - **shapefiles**:\n - **count**: The number of shape files. This value is deprecated and kept for compatibility reasons only.\n The value will always be 0 since ArangoDB 2.0 and higher.\n - **fileSize**: The total filesize of the shape files. This value is deprecated and kept\n for compatibility reasons only. The value will always be 0 in ArangoDB 2.0 and higher.\n - **journals**:\n - **count**: The number of journal files.\n - **fileSize**: The total filesize of all journal files (in bytes).\n - **maxTick**: The tick of the last marker that was stored in a journal\n of the collection. This might be 0 if the collection does not yet have\n a journal.\n\n\n\n\n#Example:\n Using an identifier and requesting the figures of the collection:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/figures\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/figures\n\n{ \n  \"id\" : \"9885\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : false, \n  \"indexBuckets\" : 8, \n  \"count\" : 1, \n  \"figures\" : { \n    \"alive\" : { \n      \"count\" : 0, \n      \"size\" : 0 \n    }, \n    \"dead\" : { \n      \"count\" : 0, \n      \"size\" : 0, \n      \"deletion\" : 0 \n    }, \n    \"datafiles\" : { \n      \"count\" : 0, \n      \"fileSize\" : 0 \n    }, \n    \"journals\" : { \n      \"count\" : 1, \n      \"fileSize\" : 33554432 \n    }, \n    \"compactors\" : { \n      \"count\" : 0, \n      \"fileSize\" : 0 \n    }, \n    \"indexes\" : { \n      \"count\" : 1, \n      \"size\" : 16088 \n    }, \n    \"lastTick\" : \"9890\", \n    \"uncollectedLogfileEntries\" : 1, \n    \"documentReferences\" : 1, \n    \"waitingFor\" : \"document-reference\", \n    \"compactionStatus\" : { \n      \"message\" : \"skipped compaction because collection has no datafiles\", \n      \"time\" : \"2016-06-17T13:11:38Z\" \n    } \n  }, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nIn addition to the above, the result also contains the number of documents\nand additional statistical information about the collection.\n**Note** : This will always load the collection into memory.\n\n**Note**: collection data that are stored in the write-ahead log only are\nnot reported in the results. When the write-ahead log is collected, documents\nmight be added to journals and datafiles of the collection, which may modify\nthe figures of the collection.\n\nAdditionally, the filesizes of collection and index parameter JSON files are\nnot reported. These files should normally have a size of a few bytes\neach. Please also note that the *fileSize* values are reported in bytes\nand reflect the logical file sizes. Some filesystems may use optimisations\n(e.g. sparse files) so that the actual physical file size is somewhat\ndifferent. Directories and sub-directories may also require space in the\nfile system, but this space is not reported in the *fileSize* results.\n\nThat means that the figures reported do not reflect the actual disk\nusage of the collection with 100% accuracy. The actual disk usage of\na collection is normally slightly higher than the sum of the reported\n*fileSize* values. Still the sum of the *fileSize* values can still be\nused as a lower bound approximation of the disk usage.\n\n**A json document with these Properties is returned:**\n\n##HTTP 200\nReturns information about the collection:\n\n - **count**: The number of documents currently present in the collection.\n - **journalSize**: The maximal size of a journal or datafile in bytes.\n - **figures**:\n - **datafiles**:\n - **count**: The number of datafiles.\n - **fileSize**: The total filesize of datafiles (in bytes).\n - **uncollectedLogfileEntries**: The number of markers in the write-ahead\n log for this collection that have not been transferred to journals or datafiles.\n - **compactionStatus**:\n - **message**: The action that was performed when the compaction was last run for the collection. \n This information can be used for debugging compaction issues.\n - **time**: The point in time the compaction for the collection was last executed. \n This information can be used for debugging compaction issues.\n - **compactors**:\n - **count**: The number of compactor files.\n - **fileSize**: The total filesize of all compactor files (in bytes).\n - **dead**:\n - **count**: The number of dead documents. This includes document\n versions that have been deleted or replaced by a newer version. Documents\n deleted or replaced that are contained the write-ahead log only are not reported\n in this figure.\n - **deletion**: The total number of deletion markers. Deletion markers\n only contained in the write-ahead log are not reporting in this figure.\n - **size**: The total size in bytes used by all dead documents.\n - **indexes**:\n - **count**: The total number of indexes defined for the collection, including the pre-defined\n indexes (e.g. primary index).\n - **size**: The total memory allocated for indexes in bytes.\n - **shapes**:\n - **count**: The total number of shapes used in the collection. This includes shapes\n that are not in use anymore. Shapes that are contained\n in the write-ahead log only are not reported in this figure.\n - **size**: The total size of all shapes (in bytes). This includes\n shapes that are not in use anymore. Shapes that are contained in the\n write-ahead log only are not reported in this figure.\n - **waitingFor**: An optional string value that contains information about which object type is at the \n head of the collection's cleanup queue. This information can be used for debugging \n compaction and unload issues.\n - **alive**:\n - **count**: The number of currently active documents in all datafiles\n and journals of the collection. Documents that are contained in the\n write-ahead log only are not reported in this figure.\n - **size**: The total size in bytes used by all active documents of\n the collection. Documents that are contained in the write-ahead log only are\n not reported in this figure.\n - **documentReferences**: The number of references to documents in datafiles that JavaScript code \n currently holds. This information can be used for debugging compaction and \n unload issues.\n - **attributes**:\n - **count**: The total number of attributes used in the\n collection. Note: the value includes data of attributes that are not in use\n anymore. Attributes that are contained in the write-ahead log only are\n not reported in this figure.\n - **size**: The total size of the attribute data (in bytes).\n Note: the value includes data of attributes that are not in use anymore.\n Attributes that are contained in the write-ahead log only are not\n reported in this figure.\n - **shapefiles**:\n - **count**: The number of shape files. This value is deprecated and kept for compatibility reasons only.\n The value will always be 0 since ArangoDB 2.0 and higher.\n - **fileSize**: The total filesize of the shape files. This value is deprecated and kept\n for compatibility reasons only. The value will always be 0 in ArangoDB 2.0 and higher.\n - **journals**:\n - **count**: The number of journal files.\n - **fileSize**: The total filesize of all journal files (in bytes).\n - **maxTick**: The tick of the last marker that was stored in a journal\n of the collection. This might be 0 if the collection does not yet have\n a journal.\n\n\n\n\n#Example:\n Using an identifier and requesting the figures of the collection:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/figures\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/figures\n\n{ \n  \"id\" : \"9295\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : false, \n  \"indexBuckets\" : 8, \n  \"count\" : 1, \n  \"figures\" : { \n    \"alive\" : { \n      \"count\" : 1, \n      \"size\" : 72 \n    }, \n    \"dead\" : { \n      \"count\" : 0, \n      \"size\" : 0, \n      \"deletion\" : 0 \n    }, \n    \"datafiles\" : { \n      \"count\" : 0, \n      \"fileSize\" : 0 \n    }, \n    \"journals\" : { \n      \"count\" : 1, \n      \"fileSize\" : 33554432 \n    }, \n    \"compactors\" : { \n      \"count\" : 0, \n      \"fileSize\" : 0 \n    }, \n    \"indexes\" : { \n      \"count\" : 1, \n      \"size\" : 16088 \n    }, \n    \"lastTick\" : \"9300\", \n    \"uncollectedLogfileEntries\" : 0, \n    \"documentReferences\" : 0, \n    \"waitingFor\" : \"-\", \n    \"compactionStatus\" : { \n      \"message\" : \"compaction not yet started\", \n      \"time\" : \"2016-08-18T14:42:26Z\" \n    } \n  }, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -2920,12 +2994,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/load": { "put": { - "description": "\n\nLoads a collection into memory. Returns the collection on success.\n\nThe request body object might optionally contain the following attribute:\n\n- *count*: If set, this controls whether the return value should include\n the number of documents in the collection. Setting *count* to\n *false* may speed up loading a collection. The default value for\n *count* is *true*.\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- *count*: The number of documents inside the collection. This is only\n returned if the *count* input parameters is set to *true* or has\n not been specified.\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\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/load\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9918\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"count\" : 0, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nLoads a collection into memory. Returns the collection on success.\n\nThe request body object might optionally contain the following attribute:\n\n- *count*: If set, this controls whether the return value should include\n the number of documents in the collection. Setting *count* to\n *false* may speed up loading a collection. The default value for\n *count* is *true*.\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- *count*: The number of documents inside the collection. This is only\n returned if the *count* input parameters is set to *true* or has\n not been specified.\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\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/load\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9327\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"count\" : 0, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -2949,12 +3023,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/properties": { "get": { - "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync*, *doCompact*, *journalSize*, and *isVolatile* attributes.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\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- *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\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n\n\n\n#Example:\n Using an identifier:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/9908/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/properties\n\n{ \n  \"id\" : \"9908\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a name:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/properties\n\n{ \n  \"id\" : \"9911\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nIn addition to the above, the result will always contain the\n*waitForSync*, *doCompact*, *journalSize*, and *isVolatile* attributes.\nThis is achieved by forcing a load of the underlying collection.\n\n- *waitForSync*: If *true* then creating, changing or removing\n documents will wait until the data has been synchronized to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n\n- *journalSize*: The maximal size setting for journals / datafiles\n in bytes.\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- *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\nIn a cluster setup, the result will also contain the following attributes:\n- *numberOfShards*: the number of shards of the collection.\n\n- *shardKeys*: contains the names of document attributes that are used to\n determine the target shard for documents.\n\n\n\n\n#Example:\n Using an identifier:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/9317/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/properties\n\n{ \n  \"id\" : \"9317\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a name:\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/properties\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nlocation: /_db/_system/_api/collection/products/properties\n\n{ \n  \"id\" : \"9320\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -2978,10 +3052,10 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.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**: some other collection properties, such as *type*, *isVolatile*,\n*numberOfShards* or *shardKeys* cannot be changed once a collection is\ncreated.\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\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9922\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "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**: some other collection properties, such as *type*, *isVolatile*,\n*numberOfShards* or *shardKeys* cannot be changed once a collection is\ncreated.\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\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9331\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -3005,12 +3079,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/rename": { "put": { - "description": "\n\nRenames a collection. Expects an object with the attribute(s)\n\n- *name*: The new name.\n\nIt returns an object with the attributes\n\n- *id*: The identifier of the collection.\n\n- *name*: The new name of the collection.\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\nIf renaming the collection succeeds, then the collection is also renamed in \nall graph definitions inside the `_graphs` collection in the current database.\n\n**Note**: this method is not available in a cluster.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products1/rename <<EOF\n{ \n  \"name\" : \"newname\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9926\", \n  \"name\" : \"newname\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nRenames a collection. Expects an object with the attribute(s)\n\n- *name*: The new name.\n\nIt returns an object with the attributes\n\n- *id*: The identifier of the collection.\n\n- *name*: The new name of the collection.\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\nIf renaming the collection succeeds, then the collection is also renamed in \nall graph definitions inside the `_graphs` collection in the current database.\n\n**Note**: this method is not available in a cluster.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products1/rename <<EOF\n{ \n  \"name\" : \"newname\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9335\", \n  \"name\" : \"newname\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection to rename.\n\n", @@ -3034,12 +3108,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/revision": { "get": { - "description": "\n\nIn addition to the above, the result will also contain the\ncollection's revision id. The revision id is a server-generated\nstring that clients can use to check whether data in a collection\nhas changed since the last revision check.\n\n- *revision*: The collection revision id as a string.\n\n\n\n\n#Example:\n Retrieving the revision of a collection\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/revision\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9914\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"revision\" : \"0\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nIn addition to the above, the result will also contain the\ncollection's revision id. The revision id is a server-generated\nstring that clients can use to check whether data in a collection\nhas changed since the last revision check.\n\n- *revision*: The collection revision id as a string.\n\n\n\n\n#Example:\n Retrieving the revision of a collection\n\n
shell> curl --dump - http://localhost:8529/_api/collection/products/revision\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9323\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"revision\" : \"0\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -3063,7 +3137,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/rotate": { @@ -3092,12 +3166,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/truncate": { "put": { - "description": "\n\nRemoves all documents from the collection, but leaves the indexes intact.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/truncate\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9931\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nRemoves all documents from the collection, but leaves the indexes intact.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/truncate\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9340\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the collection.\n\n", @@ -3121,12 +3195,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/unload": { "put": { - "description": "\n\nRemoves a collection from memory. This call does not delete any documents.\nYou can use the collection afterwards; in which case it will be loaded into\nmemory, again. On success an object with the following attributes is\nreturned:\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\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\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/unload\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9935\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 4, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nRemoves a collection from memory. This call does not delete any documents.\nYou can use the collection afterwards; in which case it will be loaded into\nmemory, again. On success an object with the following attributes is\nreturned:\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\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\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/collection/products/unload\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"9344\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"status\" : 4, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "\n", @@ -3150,12 +3224,12 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/cursor": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **count**: indicates whether the number of documents in the result set should be returned in\n the \"count\" attribute of the result.\n Calculating the \"count\" attribute might in the future have a performance\n impact for some queries so this option is turned off by default, and \"count\"\n is only returned when requested.\n - **ttl**: The time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip. If this attribute is\n not set, a server-controlled default value will be used. A *batchSize* value of\n *0* is disallowed.\n - **cache**: flag to determine whether the AQL query cache\n shall be used. If set to *false*, then any query cache lookup will be skipped\n for the query. If set to *true*, it will lead to the query cache being checked\n for the query if the query cache mode is either *on* or *demand*.\n - **bindVars**: list of bind parameter objects. of type object\n - **query**: contains the query string to be executed\n - **options**:\n - **profile**: if set to *true*, then the additional query profiling information\n will be returned in the *extra.stats* return attribute if the query result is not\n served from the query cache.\n - **optimizer.rules**: a list of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules. of type string\n - **fullCount**: if set to *true* and the query contains a *LIMIT* clause, then the\n result will contain an extra attribute *extra* with a sub-attribute *fullCount*.\n This sub-attribute will contain the number of documents in the result before the\n last LIMIT in the query was applied. It can be used to count the number of documents that\n match certain filter criteria, but only return a subset of them, in one go.\n It is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\n will disable a few LIMIT optimizations and may lead to more documents being processed,\n and thus make queries run longer. Note that the *fullCount* sub-attribute will only\n be present in the result if the query has a LIMIT clause and the LIMIT clause is\n actually used in the query.\n - **maxPlans**: limits the maximum number of plans that are created by the AQL query optimizer.\n\n\n\n\nThe query details include the query string plus optional query options and\nbind parameters. These values need to be passed in a JSON representation in\nthe body of the POST request.\n\n**A json document with these Properties is returned:**\n\n##HTTP 201\nis returned if the result set can be created by the server.\n\n - **count**: the total number of result documents available (only\navailable if the query was executed with the *count* attribute set)\n - **code**: the HTTP status code\n - **extra**: an optional JSON object with extra information about the query result\ncontained in its *stats* sub-attribute. For data-modification queries, the \n*extra.stats* sub-attribute will contain the number of modified documents and \nthe number of documents that could not be modified\ndue to an error (if *ignoreErrors* query option is specified)\n - **cached**: a boolean flag indicating whether the query result was served \nfrom the query cache or not. If the query result is served from the query\ncache, the *extra* return attribute will not contain any *stats* sub-attribute\nand no *profile* sub-attribute.\n - **hasMore**: A boolean indicator whether there are more results\navailable for the cursor on the server\n - **result**: an array of result documents (might be empty if query has no results)anonymous json object\n - **error**: A flag to indicate that an error occurred (*false* in this case)\n - **id**: id of temporary cursor created on the server (optional, see above)\n\n**A json document with these Properties is returned:**\n\n##HTTP 400\nis returned if the JSON representation is malformed or the query specification is\nmissing from the request.\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n - **errorMessage**: a descriptive error message\nIf the query specification is complete, the server will process the query. If an\nerror occurs during query processing, the server will respond with *HTTP 400*.\nAgain, the body of the response will contain details about the error.\nA [list of query errors can be found here](../../Manual/Appendix/ErrorCodes.html).\n - **errorNum**: the server error number\n - **code**: the HTTP status code\n - **error**: boolean flag to indicate that an error occurred (*true* in this case)\n\n\n\n\n#Example:\n Execute a query and extract the result in a single go\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 2 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9996\", \n      \"_id\" : \"products/9996\", \n      \"_rev\" : \"9996\", \n      \"hello2\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9992\", \n      \"_id\" : \"products/9992\", \n      \"_rev\" : \"9992\", \n      \"hello1\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 2, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00018405914306640625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a query and extract a part of the result\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\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9971\", \n      \"_id\" : \"products/9971\", \n      \"_rev\" : \"9971\", \n      \"hello1\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9975\", \n      \"_id\" : \"products/9975\", \n      \"_rev\" : \"9975\", \n      \"hello2\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9987\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00014591217041015625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Using the query option \"fullCount\"\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..1000 FILTER i > 500 LIMIT 10 RETURN i\", \n  \"count\" : true, \n  \"options\" : { \n    \"fullCount\" : true \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    501, \n    502, \n    503, \n    504, \n    505, \n    506, \n    507, \n    508, \n    509, \n    510 \n  ], \n  \"hasMore\" : false, \n  \"count\" : 10, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 500, \n      \"fullCount\" : 500, \n      \"executionTime\" : 0.0008840560913085938 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Enabling and disabling optimizer rules\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 LET a = 1 LET b = 2 FILTER a + b == 3 RETURN i\", \n  \"count\" : true, \n  \"options\" : { \n    \"maxPlans\" : 1, \n    \"optimizer\" : { \n      \"rules\" : [ \n        \"-all\", \n        \"+remove-unnecessary-filters\" \n      ] \n    } \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    1, \n    2, \n    3, \n    4, \n    5, \n    6, \n    7, \n    8, \n    9, \n    10 \n  ], \n  \"hasMore\" : false, \n  \"count\" : 10, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0012359619140625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a data-modification query and retrieve the number of\nmodified documents\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products REMOVE p IN products\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 2, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 2, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0002589225769042969 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a data-modification query with option *ignoreErrors*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"REMOVE 'bar' IN products OPTIONS { ignoreErrors: true }\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 1, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00024008750915527344 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Bad query - Missing body\n\n
shell> curl -X POST --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"Parse error: Expecting item\", \n  \"code\" : 400, \n  \"errorNum\" : 600 \n}\n
\n\n\n\n\n#Example:\n Bad query - Unknown collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR u IN unknowncoll LIMIT 2 RETURN u\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found (unknowncoll)\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Bad query - Execute a data-modification query that attempts to remove a non-existing\ndocument\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"REMOVE 'foo' IN products\" \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found (while executing)\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **count**: indicates whether the number of documents in the result set should be returned in\n the \"count\" attribute of the result.\n Calculating the \"count\" attribute might have a performance impact for some queries\n in the future so this option is turned off by default, and \"count\"\n is only returned when requested.\n - **ttl**: The time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip. If this attribute is\n not set, a server-controlled default value will be used. A *batchSize* value of\n *0* is disallowed.\n - **cache**: flag to determine whether the AQL query cache\n shall be used. If set to *false*, then any query cache lookup will be skipped\n for the query. If set to *true*, it will lead to the query cache being checked\n for the query if the query cache mode is either *on* or *demand*.\n - **bindVars** (object): key/value pairs representing the bind parameters. - **query**: contains the query string to be executed\n - **options**:\n - **profile**: If set to *true*, then the additional query profiling information will be returned\n in the sub-attribute *profile* of the *extra* return attribute if the query result\n is not served from the query cache.\n - **optimizer.rules** (string): A list of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules. - **fullCount**: if set to *true* and the query contains a *LIMIT* clause, then the\n result will have an *extra* attribute with the sub-attributes *stats*\n and *fullCount*, `{ ... , \"extra\": { \"stats\": { \"fullCount\": 123 } } }`.\n The *fullCount* attribute will contain the number of documents in the result before the\n last LIMIT in the query was applied. It can be used to count the number of documents that\n match certain filter criteria, but only return a subset of them, in one go.\n It is thus similar to MySQL's *SQL_CALC_FOUND_ROWS* hint. Note that setting the option\n will disable a few LIMIT optimizations and may lead to more documents being processed,\n and thus make queries run longer. Note that the *fullCount* attribute will only\n be present in the result if the query has a LIMIT clause and the LIMIT clause is\n actually used in the query.\n - **maxPlans**: Limits the maximum number of plans that are created by the AQL query optimizer.\n\n\n\n\nThe query details include the query string plus optional query options and\nbind parameters. These values need to be passed in a JSON representation in\nthe body of the POST request.\n\n**A json document with these Properties is returned:**\n\n##HTTP 201\nis returned if the result set can be created by the server.\n\n - **count**: the total number of result documents available (only\navailable if the query was executed with the *count* attribute set)\n - **code**: the HTTP status code\n - **extra**: an optional JSON object with extra information about the query result\ncontained in its *stats* sub-attribute. For data-modification queries, the \n*extra.stats* sub-attribute will contain the number of modified documents and \nthe number of documents that could not be modified\ndue to an error (if *ignoreErrors* query option is specified)\n - **cached**: a boolean flag indicating whether the query result was served \nfrom the query cache or not. If the query result is served from the query\ncache, the *extra* return attribute will not contain any *stats* sub-attribute\nand no *profile* sub-attribute.\n - **hasMore**: A boolean indicator whether there are more results\navailable for the cursor on the server\n - **result** (anonymous json object): an array of result documents (might be empty if query has no results) - **error**: A flag to indicate that an error occurred (*false* in this case)\n - **id**: id of temporary cursor created on the server (optional, see above)\n\n**A json document with these Properties is returned:**\n\n##HTTP 400\nis returned if the JSON representation is malformed or the query specification is\nmissing from the request.\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n - **errorMessage**: a descriptive error message\nIf the query specification is complete, the server will process the query. If an\nerror occurs during query processing, the server will respond with *HTTP 400*.\nAgain, the body of the response will contain details about the error.\nA [list of query errors can be found here](../../Manual/Appendix/ErrorCodes.html).\n - **errorNum**: the server error number\n - **code**: the HTTP status code\n - **error**: boolean flag to indicate that an error occurred (*true* in this case)\n\n\n\n\n#Example:\n Execute a query and extract the result in a single go\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 2 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9391\", \n      \"_id\" : \"products/9391\", \n      \"_rev\" : \"_Tn2YalO---\", \n      \"hello1\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9395\", \n      \"_id\" : \"products/9395\", \n      \"_rev\" : \"_Tn2YalS---\", \n      \"hello2\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 2, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00010085105895996094 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a query and extract a part of the result\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\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9370\", \n      \"_id\" : \"products/9370\", \n      \"_rev\" : \"_Tn2Yakq---\", \n      \"hello1\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9377\", \n      \"_id\" : \"products/9377\", \n      \"_rev\" : \"_Tn2Yaku---\", \n      \"hello3\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9386\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.000102996826171875 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Using the query option \"fullCount\"\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..1000 FILTER i > 500 LIMIT 10 RETURN i\", \n  \"count\" : true, \n  \"options\" : { \n    \"fullCount\" : true \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    501, \n    502, \n    503, \n    504, \n    505, \n    506, \n    507, \n    508, \n    509, \n    510 \n  ], \n  \"hasMore\" : false, \n  \"count\" : 10, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 500, \n      \"fullCount\" : 500, \n      \"executionTime\" : 0.00036978721618652344 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Enabling and disabling optimizer rules\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 LET a = 1 LET b = 2 FILTER a + b == 3 RETURN i\", \n  \"count\" : true, \n  \"options\" : { \n    \"maxPlans\" : 1, \n    \"optimizer\" : { \n      \"rules\" : [ \n        \"-all\", \n        \"+remove-unnecessary-filters\" \n      ] \n    } \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    1, \n    2, \n    3, \n    4, \n    5, \n    6, \n    7, \n    8, \n    9, \n    10 \n  ], \n  \"hasMore\" : false, \n  \"count\" : 10, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0006580352783203125 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a data-modification query and retrieve the number of\nmodified documents\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products REMOVE p IN products\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 2, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 2, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00013303756713867188 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Execute a data-modification query with option *ignoreErrors*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"REMOVE 'bar' IN products OPTIONS { ignoreErrors: true }\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 1, \n      \"scannedFull\" : 0, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00011777877807617188 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Bad query - Missing body\n\n
shell> curl -X POST --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"VpackError error: Expecting item\", \n  \"code\" : 400, \n  \"errorNum\" : 600 \n}\n
\n\n\n\n\n#Example:\n Bad query - Unknown collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR u IN unknowncoll LIMIT 2 RETURN u\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found (unknowncoll)\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Bad query - Execute a data-modification query that attempts to remove a non-existing\ndocument\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"REMOVE 'foo' IN products\" \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found (while executing)\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", @@ -3197,12 +3271,12 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" } }, "/_api/cursor/{cursor-identifier}": { "delete": { - "description": "\n\nDeletes the cursor and frees the resources associated with it.\n\nThe cursor will automatically be destroyed on the server when the client has\nretrieved all documents from it. The client can also explicitly destroy the\ncursor at any earlier time using an HTTP DELETE request. The cursor id must\nbe included as part of the URL.\n\nNote: the server will also destroy abandoned cursors automatically after a\ncertain server-controlled timeout to avoid resource leakage.\n\n\n\n\n#Example:\n \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\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10008\", \n      \"_id\" : \"products/10008\", \n      \"_rev\" : \"10008\", \n      \"hello2\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"10011\", \n      \"_id\" : \"products/10011\", \n      \"_rev\" : \"10011\", \n      \"hello3\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"10020\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00015091896057128906 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/cursor/10020\n\n
\n\n\n\n\n", + "description": "\n\nDeletes the cursor and frees the resources associated with it.\n\nThe cursor will automatically be destroyed on the server when the client has\nretrieved all documents from it. The client can also explicitly destroy the\ncursor at any earlier time using an HTTP DELETE request. The cursor id must\nbe included as part of the URL.\n\nNote: the server will also destroy abandoned cursors automatically after a\ncertain server-controlled timeout to avoid resource leakage.\n\n\n\n\n#Example:\n \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\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9407\", \n      \"_id\" : \"products/9407\", \n      \"_rev\" : \"_Tn2YamO--_\", \n      \"hello2\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9413\", \n      \"_id\" : \"products/9413\", \n      \"_rev\" : \"_Tn2YamO--B\", \n      \"hello4\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9419\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00011587142944335938 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/cursor/9419\n\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the cursor\n\n", @@ -3226,10 +3300,10 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "put": { - "description": "\n\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/10077\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10071\", \n      \"_id\" : \"products/10071\", \n      \"_rev\" : \"10071\", \n      \"hello4\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"10065\", \n      \"_id\" : \"products/10065\", \n      \"_rev\" : \"10065\", \n      \"hello2\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"10077\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.000186920166015625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 200 \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\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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cursor not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1600 \n}\n
\n\n\n\n\n", + "description": "\n\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/9470\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"9458\", \n      \"_id\" : \"products/9458\", \n      \"_rev\" : \"_Tn2Yaoi--_\", \n      \"hello2\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"9454\", \n      \"_id\" : \"products/9454\", \n      \"_rev\" : \"_Tn2Yaoi---\", \n      \"hello1\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"9470\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0001049041748046875 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 200 \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\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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cursor not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1600 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The name of the cursor\n\n", @@ -3256,12 +3330,12 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" } }, "/_api/database": { "get": { - "description": "\n\nRetrieves the list of all existing databases\n\n**Note**: retrieving the list of databases is only possible from within the *_system* database.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/database\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    \"_system\" \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nRetrieves the list of all existing databases\n\n**Note**: retrieving the list of databases is only possible from within the *_system* database.\n\n**Note**: You should use the [*GET user API*](../UserManagement/README.md#list-the-databases-available-to-a-user) to fetch the list of the available databases now.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/database\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    \"_system\" \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -3279,10 +3353,10 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md" }, "post": { - "description": "**A json post document with these Properties is required:**\n\n - **username**: The user name as a string.\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 - **users**: Has to be a list of user objects to initially create for the new database.\n Each user object can contain the following attributes:\n - **username**: Loginname of the user to be created\n - **passwd**: Password for the user\n - **active**: if *False* the user won't be able to 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 - **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*.\n - **name**: Has to contain a valid database name.\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\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 201 \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\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document 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\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 201 \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\n\n{ \n  \"result\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -3313,12 +3387,12 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md" } }, "/_api/database/current": { "get": { - "description": "\n\nRetrieves information about the current database\n\nThe response is a JSON object with the following attributes:\n\n- *name*: the name of the current database\n\n- *id*: the id of the current database\n\n- *path*: the filesystem path of the current database\n\n- *isSystem*: whether or not the current database is the *_system* database\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/database/current\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"name\" : \"_system\", \n    \"id\" : \"1\", \n    \"path\" : \"/tmp/arangosh_HRvSiM/tmp-26887-1938238700/data/databases/database-1\", \n    \"isSystem\" : true \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nRetrieves information about the current database\n\nThe response is a JSON object with the following attributes:\n\n- *name*: the name of the current database\n\n- *id*: the id of the current database\n\n- *path*: the filesystem path of the current database\n\n- *isSystem*: whether or not the current database is the *_system* database\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/database/current\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"name\" : \"_system\", \n    \"id\" : \"1\", \n    \"path\" : \"/tmp/arangosh_pfFFNd/tmp-26625-4130755256/data/databases/database-1\", \n    \"isSystem\" : true \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -3336,7 +3410,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md" } }, "/_api/database/user": { @@ -3356,7 +3430,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md" } }, "/_api/database/{database-name}": { @@ -3391,12 +3465,12 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md" } }, "/_api/document/{collection}": { "delete": { - "description": "\nfree style json body\n\n\n\nThe body of the request is an array consisting of selectors for\ndocuments. A selector can either be a string with a key or a string\nwith a document handle or an object with a *_key* attribute. This\nAPI call removes all specified documents from *collection*. If the\nselector is an object and has a *_rev* attribute, it is a\nprecondition that the actual revision of the removed document in the\ncollection is the specified one.\n\nThe body of the response is an array of the same length as the input\narray. For each input selector, the output contains a JSON object\nwith the information about the outcome of the operation. If no error\noccurred, an object is built in which the attribute *_id* contains\nthe known *document-handle* of the removed document, *_key* contains\nthe key which uniquely identifies a document in a given collection,\nand the attribute *_rev* contains the document revision. In case of\nan error, an object with the attribute *error* set to *true* and\n*errorCode* set to the error code is built.\n\nIf the *waitForSync* parameter is not specified or set to *false*,\nthen the collection's default *waitForSync* behavior is applied.\nThe *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync*\nvalue of *true*.\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\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 200 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\n\n\n#Example:\n Using document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10286\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10286\"\nlocation: /_db/_system/_api/document/products/10286\n\n{ \n  \"_id\" : \"products/10286\", \n  \"_key\" : \"10286\", \n  \"_rev\" : \"10286\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10308\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\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 Revision conflict:\n\n
shell> curl -X DELETE --header 'If-Match: \"10278\"' --dump - http://localhost:8529/_api/document/products/10274\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"10274\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/10274\", \n  \"_key\" : \"10274\", \n  \"_rev\" : \"10274\" \n}\n
\n\n\n\n", + "description": "\nfree style json body\n\n\n\nThe body of the request is an array consisting of selectors for\ndocuments. A selector can either be a string with a key or a string\nwith a document handle or an object with a *_key* attribute. This\nAPI call removes all specified documents from *collection*. If the\nselector is an object and has a *_rev* attribute, it is a\nprecondition that the actual revision of the removed document in the\ncollection is the specified one.\n\nThe body of the response is an array of the same length as the input\narray. For each input selector, the output contains a JSON object\nwith the information about the outcome of the operation. If no error\noccurred, an object is built in which the attribute *_id* contains\nthe known *document-handle* of the removed document, *_key* contains\nthe key which uniquely identifies a document in a given collection,\nand the attribute *_rev* contains the document revision. In case of\nan error, an object with the attribute *error* set to *true* and\n*errorCode* set to the error code is built.\n\nIf the *waitForSync* parameter is not specified or set to *false*,\nthen the collection's default *waitForSync* behavior is applied.\nThe *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync*\nvalue of *true*.\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\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 200 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\n\n\n#Example:\n Using document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9673\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya36---\"\nlocation: /_db/_system/_api/document/products/9673\n\n{ \n  \"_id\" : \"products/9673\", \n  \"_key\" : \"9673\", \n  \"_rev\" : \"_Tn2Ya36---\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9692\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\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 Revision conflict:\n\n
shell> curl -X DELETE --header 'If-Match: \"_Tn2Ya3W--_\"' --dump - http://localhost:8529/_api/document/products/9662\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya3W---\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/9662\", \n  \"_key\" : \"9662\", \n  \"_rev\" : \"_Tn2Ya3W---\" \n}\n
\n\n\n\n", "parameters": [ { "description": "A JSON array of strings or documents.\n\n", @@ -3455,7 +3529,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" }, "patch": { "description": "\nfree style json body\n\n\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", @@ -3541,11 +3615,19 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" }, "post": { - "description": "\nfree style json body\n\n\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\nThe body of the response contains a JSON object (single document case)\nwith 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\netag: \"10364\"\nlocation: /_db/_system/_api/document/products/10364\n\n{ \n  \"_id\" : \"products/10364\", \n  \"_key\" : \"10364\", \n  \"_rev\" : \"10364\" \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\netag: \"10354\"\nlocation: /_db/_system/_api/document/products/10354\n\n{ \n  \"_id\" : \"products/10354\", \n  \"_key\" : \"10354\", \n  \"_rev\" : \"10354\" \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\netag: \"10391\"\nlocation: /_db/_system/_api/document/products/10391\n\n{ \n  \"_id\" : \"products/10391\", \n  \"_key\" : \"10391\", \n  \"_rev\" : \"10391\" \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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"Parse 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\n\n[ \n  { \n    \"_id\" : \"products/10371\", \n    \"_key\" : \"10371\", \n    \"_rev\" : \"10371\" \n  }, \n  { \n    \"_id\" : \"products/10375\", \n    \"_key\" : \"10375\", \n    \"_rev\" : \"10375\" \n  }, \n  { \n    \"_id\" : \"products/10377\", \n    \"_key\" : \"10377\", \n    \"_rev\" : \"10377\" \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\netag: \"10384\"\nlocation: /_db/_system/_api/document/products/10384\n\n{ \n  \"_id\" : \"products/10384\", \n  \"_key\" : \"10384\", \n  \"_rev\" : \"10384\", \n  \"new\" : { \n    \"_key\" : \"10384\", \n    \"_id\" : \"products/10384\", \n    \"_rev\" : \"10384\", \n    \"Hello\" : \"World\" \n  } \n}\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\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\nThe body of the response contains a JSON object (single document case)\nwith 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\netag: \"_Tn2Ya9G---\"\nlocation: /_db/_system/_api/document/products/9741\n\n{ \n  \"_id\" : \"products/9741\", \n  \"_key\" : \"9741\", \n  \"_rev\" : \"_Tn2Ya9G---\" \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\netag: \"_Tn2Ya8C---\"\nlocation: /_db/_system/_api/document/products/9731\n\n{ \n  \"_id\" : \"products/9731\", \n  \"_key\" : \"9731\", \n  \"_rev\" : \"_Tn2Ya8C---\" \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\netag: \"_Tn2Yb_O---\"\nlocation: /_db/_system/_api/document/products/9768\n\n{ \n  \"_id\" : \"products/9768\", \n  \"_key\" : \"9768\", \n  \"_rev\" : \"_Tn2Yb_O---\" \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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \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\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\n\n[ \n  { \n    \"_id\" : \"products/9748\", \n    \"_key\" : \"9748\", \n    \"_rev\" : \"_Tn2Ya9u---\" \n  }, \n  { \n    \"_id\" : \"products/9752\", \n    \"_key\" : \"9752\", \n    \"_rev\" : \"_Tn2Ya9u--_\" \n  }, \n  { \n    \"_id\" : \"products/9754\", \n    \"_key\" : \"9754\", \n    \"_rev\" : \"_Tn2Ya9u--A\" \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\netag: \"_Tn2Yb-a---\"\nlocation: /_db/_system/_api/document/products/9761\n\n{ \n  \"_id\" : \"products/9761\", \n  \"_key\" : \"9761\", \n  \"_rev\" : \"_Tn2Yb-a---\", \n  \"new\" : { \n    \"_key\" : \"9761\", \n    \"_id\" : \"products/9761\", \n    \"_rev\" : \"_Tn2Yb-a---\", \n    \"Hello\" : \"World\" \n  } \n}\n
\n\n\n\n\n", "parameters": [ + { + "description": "The *collection* in which the collection is to be created.\n\n", + "format": "string", + "in": "path", + "name": "collection", + "required": true, + "type": "string" + }, { "description": "A JSON representation of a single document or of an array of documents.\n\n", "in": "body", @@ -3596,12 +3678,12 @@ "description": "is returned in the single document case if a document with the\nsame qualifiers in an indexed attribute conflicts with an already\nexisting document and thus violates that unique constraint. The\nresponse body contains an error document in this case. In the array\ncase only 201 or 202 is returned, but if an error occurred, the\nadditional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1205:10,1210:17* which means that in 10\ncases the error 1205 \"illegal document handle\" and in 17 cases the\nerror 1210 \"unique constraint violated\" has happened.\n\n" } }, - "summary": "Create document", + "summary": " Create document", "tags": [ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" }, "put": { "description": "\nfree style json body\n\n\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", @@ -3673,12 +3755,12 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" } }, "/_api/document/{document-handle}": { "delete": { - "description": "\n\nThe body of the response contains a JSON object with the information\nabout the handle and the revision. The attribute *_id* contains the\nknown *document-handle* of the removed document, *_key* contains the\nkey which uniquely identifies a document in a given collection, and\nthe attribute *_rev* contains the document revision.\n\nIf the *waitForSync* parameter is not specified or set to *false*,\nthen the collection's default *waitForSync* behavior is applied.\nThe *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync*\nvalue of *true*.\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\n\n\n\n#Example:\n Using document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10252\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10252\"\nlocation: /_db/_system/_api/document/products/10252\n\n{ \n  \"_id\" : \"products/10252\", \n  \"_key\" : \"10252\", \n  \"_rev\" : \"10252\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/10296\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\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 Revision conflict:\n\n
shell> curl -X DELETE --header 'If-Match: \"10266\"' --dump - http://localhost:8529/_api/document/products/10262\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"10262\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/10262\", \n  \"_key\" : \"10262\", \n  \"_rev\" : \"10262\" \n}\n
\n\n\n\n", + "description": "\n\nThe body of the response contains a JSON object with the information\nabout the handle and the revision. The attribute *_id* contains the\nknown *document-handle* of the removed document, *_key* contains the\nkey which uniquely identifies a document in a given collection, and\nthe attribute *_rev* contains the document revision.\n\nIf the *waitForSync* parameter is not specified or set to *false*,\nthen the collection's default *waitForSync* behavior is applied.\nThe *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync*\nvalue of *true*.\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\n\n\n\n#Example:\n Using document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9642\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya1m---\"\nlocation: /_db/_system/_api/document/products/9642\n\n{ \n  \"_id\" : \"products/9642\", \n  \"_key\" : \"9642\", \n  \"_rev\" : \"_Tn2Ya1m---\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/9682\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\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 Revision conflict:\n\n
shell> curl -X DELETE --header 'If-Match: \"_Tn2Ya2y--_\"' --dump - http://localhost:8529/_api/document/products/9651\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya2y---\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/9651\", \n  \"_key\" : \"9651\", \n  \"_rev\" : \"_Tn2Ya2y---\" \n}\n
\n\n\n\n", "parameters": [ { "description": "Removes the document identified by *document-handle*.\n\n", @@ -3728,10 +3810,10 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.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/10398\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10398\"\n\n{ \n  \"_key\" : \"10398\", \n  \"_id\" : \"products/10398\", \n  \"_rev\" : \"10398\", \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: \"10442\"' --dump - http://localhost:8529/_api/document/products/10442\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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", + "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/9775\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Yb_6---\"\n\n{ \n  \"_key\" : \"9775\", \n  \"_id\" : \"products/9775\", \n  \"_rev\" : \"_Tn2Yb_6---\", \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: \"_Tn2YbCS---\"' --dump - http://localhost:8529/_api/document/products/9819\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\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The handle of the document.\n\n", @@ -3773,10 +3855,10 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.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/10434\n\n
\n\n\n\n\n\n", + "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/9811\n\n
\n\n\n\n\n\n", "parameters": [ { "description": "The handle of the document.\n\n", @@ -3818,10 +3900,10 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" }, "patch": { - "description": "\nfree style json body\n\n\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\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 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\nThe body of the response contains a JSON object with the information\nabout the handle and the revision. The attribute *_id* contains the\nknown *document-handle* of the updated document, *_key* contains the\nkey which uniquely identifies a document in a given collection, and\nthe 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/10320 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"10324\"\nlocation: /_db/_system/_api/document/products/10320\n\n{ \n  \"_id\" : \"products/10320\", \n  \"_key\" : \"10320\", \n  \"_rev\" : \"10324\", \n  \"_oldRev\" : \"10320\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10320 <<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\netag: \"10327\"\nlocation: /_db/_system/_api/document/products/10320\n\n{ \n  \"_id\" : \"products/10320\", \n  \"_key\" : \"10320\", \n  \"_rev\" : \"10327\", \n  \"_oldRev\" : \"10324\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10320\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10327\"\n\n{ \n  \"_key\" : \"10320\", \n  \"_id\" : \"products/10320\", \n  \"_rev\" : \"10327\", \n  \"hello\" : \"world\", \n  \"one\" : \"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/10320?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\netag: \"10331\"\nlocation: /_db/_system/_api/document/products/10320\n\n{ \n  \"_id\" : \"products/10320\", \n  \"_key\" : \"10320\", \n  \"_rev\" : \"10331\", \n  \"_oldRev\" : \"10327\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10320\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10331\"\n\n{ \n  \"_key\" : \"10320\", \n  \"_id\" : \"products/10320\", \n  \"_rev\" : \"10331\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  }, \n  \"one\" : \"world\" \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/10338\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10338\"\n\n{ \n  \"_key\" : \"10338\", \n  \"_id\" : \"products/10338\", \n  \"_rev\" : \"10338\", \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/10338?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/10338\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10343\"\n\n{ \n  \"_key\" : \"10338\", \n  \"_id\" : \"products/10338\", \n  \"_rev\" : \"10343\", \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/10338?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\netag: \"10347\"\nlocation: /_db/_system/_api/document/products/10338\n\n{ \n  \"_id\" : \"products/10338\", \n  \"_key\" : \"10338\", \n  \"_rev\" : \"10347\", \n  \"_oldRev\" : \"10343\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10338\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"10347\"\n\n{ \n  \"_key\" : \"10338\", \n  \"_id\" : \"products/10338\", \n  \"_rev\" : \"10347\", \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\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\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 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\nThe body of the response contains a JSON object with the information\nabout the handle and the revision. The attribute *_id* contains the\nknown *document-handle* of the updated document, *_key* contains the\nkey which uniquely identifies a document in a given collection, and\nthe 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/9702 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya6S---\"\nlocation: /_db/_system/_api/document/products/9702\n\n{ \n  \"_id\" : \"products/9702\", \n  \"_key\" : \"9702\", \n  \"_rev\" : \"_Tn2Ya6S---\", \n  \"_oldRev\" : \"_Tn2Ya6O---\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/9702 <<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\netag: \"_Tn2Ya6W---\"\nlocation: /_db/_system/_api/document/products/9702\n\n{ \n  \"_id\" : \"products/9702\", \n  \"_key\" : \"9702\", \n  \"_rev\" : \"_Tn2Ya6W---\", \n  \"_oldRev\" : \"_Tn2Ya6S---\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/9702\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya6W---\"\n\n{ \n  \"_key\" : \"9702\", \n  \"_id\" : \"products/9702\", \n  \"_rev\" : \"_Tn2Ya6W---\", \n  \"hello\" : \"world\", \n  \"one\" : \"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/9702?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\netag: \"_Tn2Ya6i---\"\nlocation: /_db/_system/_api/document/products/9702\n\n{ \n  \"_id\" : \"products/9702\", \n  \"_key\" : \"9702\", \n  \"_rev\" : \"_Tn2Ya6i---\", \n  \"_oldRev\" : \"_Tn2Ya6W---\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/9702\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya6i---\"\n\n{ \n  \"_key\" : \"9702\", \n  \"_id\" : \"products/9702\", \n  \"_rev\" : \"_Tn2Ya6i---\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  }, \n  \"one\" : \"world\" \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/9717\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya7K---\"\n\n{ \n  \"_key\" : \"9717\", \n  \"_id\" : \"products/9717\", \n  \"_rev\" : \"_Tn2Ya7K---\", \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/9717?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/9717\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya7S---\"\n\n{ \n  \"_key\" : \"9717\", \n  \"_id\" : \"products/9717\", \n  \"_rev\" : \"_Tn2Ya7S---\", \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/9717?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\netag: \"_Tn2Ya7a---\"\nlocation: /_db/_system/_api/document/products/9717\n\n{ \n  \"_id\" : \"products/9717\", \n  \"_key\" : \"9717\", \n  \"_rev\" : \"_Tn2Ya7a---\", \n  \"_oldRev\" : \"_Tn2Ya7S---\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/9717\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2Ya7a---\"\n\n{ \n  \"_key\" : \"9717\", \n  \"_id\" : \"products/9717\", \n  \"_rev\" : \"_Tn2Ya7a---\", \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\n
\n\n\n\n\n", "parameters": [ { "description": "A JSON representation of a document update as an object.\n\n", @@ -3913,10 +3995,10 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" }, "put": { - "description": "\nfree style json body\n\n\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\nThe body of the response contains a JSON object with the information\nabout the handle and the revision. The attribute *_id* contains the\nknown *document-handle* of the updated document, *_key* contains the\nkey which uniquely identifies a document in a given collection, and\nthe 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/10450 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"10454\"\nlocation: /_db/_system/_api/document/products/10450\n\n{ \n  \"_id\" : \"products/10450\", \n  \"_key\" : \"10450\", \n  \"_rev\" : \"10454\", \n  \"_oldRev\" : \"10450\" \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/10472 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\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: \"10464\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/10460 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"10460\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/10460\", \n  \"_key\" : \"10460\", \n  \"_rev\" : \"10460\" \n}\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\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\nThe body of the response contains a JSON object with the information\nabout the handle and the revision. The attribute *_id* contains the\nknown *document-handle* of the updated document, *_key* contains the\nkey which uniquely identifies a document in a given collection, and\nthe 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/9827 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2YbC2--_\"\nlocation: /_db/_system/_api/document/products/9827\n\n{ \n  \"_id\" : \"products/9827\", \n  \"_key\" : \"9827\", \n  \"_rev\" : \"_Tn2YbC2--_\", \n  \"_oldRev\" : \"_Tn2YbC2---\" \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/9847 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\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: \"_Tn2YbDW--_\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/9836 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_Tn2YbDW---\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/9836\", \n  \"_key\" : \"9836\", \n  \"_rev\" : \"_Tn2YbDW---\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "A JSON representation of a single document.\n\n", @@ -3994,12 +4076,12 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" } }, "/_api/edges/{collection-id}": { "get": { - "description": "\n\nReturns an array of edges starting or ending in the vertex identified by\n*vertex-handle*.\n\n\n\n\n#Example:\n Any direction\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"5\", \n      \"_id\" : \"edges/5\", \n      \"_from\" : \"vertices/1\", \n      \"_to\" : \"vertices/3\", \n      \"_rev\" : \"10499\", \n      \"$label\" : \"v1 -> v3\" \n    }, \n    { \n      \"_key\" : \"6\", \n      \"_id\" : \"edges/6\", \n      \"_from\" : \"vertices/2\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"10503\", \n      \"$label\" : \"v2 -> v1\" \n    }, \n    { \n      \"_key\" : \"7\", \n      \"_id\" : \"edges/7\", \n      \"_from\" : \"vertices/4\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"10506\", \n      \"$label\" : \"v4 -> v1\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 3, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n#Example:\n In edges\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=in\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"6\", \n      \"_id\" : \"edges/6\", \n      \"_from\" : \"vertices/2\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"10533\", \n      \"$label\" : \"v2 -> v1\" \n    }, \n    { \n      \"_key\" : \"7\", \n      \"_id\" : \"edges/7\", \n      \"_from\" : \"vertices/4\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"10536\", \n      \"$label\" : \"v4 -> v1\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 2, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n#Example:\n Out edges\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=out\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"5\", \n      \"_id\" : \"edges/5\", \n      \"_from\" : \"vertices/1\", \n      \"_to\" : \"vertices/3\", \n      \"_rev\" : \"10559\", \n      \"$label\" : \"v1 -> v3\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 1, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n", + "description": "\n\nReturns an array of edges starting or ending in the vertex identified by\n*vertex-handle*.\n\n\n\n\n#Example:\n Any direction\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"5\", \n      \"_id\" : \"edges/5\", \n      \"_from\" : \"vertices/1\", \n      \"_to\" : \"vertices/3\", \n      \"_rev\" : \"_Tn2YbEe--_\", \n      \"$label\" : \"v1 -> v3\" \n    }, \n    { \n      \"_key\" : \"6\", \n      \"_id\" : \"edges/6\", \n      \"_from\" : \"vertices/2\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_Tn2YbEe--A\", \n      \"$label\" : \"v2 -> v1\" \n    }, \n    { \n      \"_key\" : \"7\", \n      \"_id\" : \"edges/7\", \n      \"_from\" : \"vertices/4\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_Tn2YbEe--B\", \n      \"$label\" : \"v4 -> v1\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 3, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n#Example:\n In edges\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=in\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"6\", \n      \"_id\" : \"edges/6\", \n      \"_from\" : \"vertices/2\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_Tn2YbFW--B\", \n      \"$label\" : \"v2 -> v1\" \n    }, \n    { \n      \"_key\" : \"7\", \n      \"_id\" : \"edges/7\", \n      \"_from\" : \"vertices/4\", \n      \"_to\" : \"vertices/1\", \n      \"_rev\" : \"_Tn2YbFW--C\", \n      \"$label\" : \"v4 -> v1\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 2, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n#Example:\n Out edges\n\n
shell> curl --dump - http://localhost:8529/_api/edges/edges?vertex=vertices/1&direction=out\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"edges\" : [ \n    { \n      \"_key\" : \"5\", \n      \"_id\" : \"edges/5\", \n      \"_from\" : \"vertices/1\", \n      \"_to\" : \"vertices/3\", \n      \"_rev\" : \"_Tn2YbGK--B\", \n      \"$label\" : \"v1 -> v3\" \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200, \n  \"stats\" : { \n    \"scannedIndex\" : 1, \n    \"filtered\" : 0 \n  } \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the collection.\n\n", @@ -4040,12 +4122,12 @@ "Graph Edges" ], "x-examples": [], - "x-filename": "Graph Edges - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READINOUTBOUND.md" + "x-filename": "Graph Edges - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READINOUTBOUND.md" } }, "/_api/endpoint": { "get": { - "description": "\n\nReturns an array of all configured endpoints the server is listening on. For\neach endpoint, the array of allowed databases is returned too if set.\n\nThe result is a JSON object which has the endpoints as keys, and an array of\nmapped database names as values for each endpoint.\n\nIf an array of mapped databases is empty, it means that all databases can be\naccessed via the endpoint. If an array of mapped databases contains more than\none database name, this means that any of the databases might be accessed\nvia the endpoint, and the first database in the arry will be treated as\nthe default database for the endpoint. The default database will be used\nwhen an incoming request does not specify a database name in the request\nexplicitly.\n\n**Note**: retrieving the array of all endpoints is allowed in the system database\nonly. Calling this action in any other database will make the server return\nan error.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/endpoint\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  { \n    \"endpoint\" : \"http://127.0.0.1:57754\" \n  } \n]\n
\n\n\n\n\n", + "description": "\n\nReturns an array of all configured endpoints the server is listening on. For\neach endpoint, the array of allowed databases is returned too if set.\n\nThe result is a JSON object which has the endpoints as keys, and an array of\nmapped database names as values for each endpoint.\n\nIf an array of mapped databases is empty, it means that all databases can be\naccessed via the endpoint. If an array of mapped databases contains more than\none database name, this means that any of the databases might be accessed\nvia the endpoint, and the first database in the arry will be treated as\nthe default database for the endpoint. The default database will be used\nwhen an incoming request does not specify a database name in the request\nexplicitly.\n\n**Note**: retrieving the array of all endpoints is allowed in the system database\nonly. Calling this action in any other database will make the server return\nan error.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/endpoint\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  { \n    \"endpoint\" : \"http://127.0.0.1:9846\" \n  } \n]\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -4063,12 +4145,12 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_api/explain": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **query**: the query which you want explained; If the query references any bind variables,\n these must also be passed in the attribute *bindVars*. Additional\n options for the query can be passed in the *options* attribute.\n - **options**:\n - **optimizer.rules**: an array of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules. of type string\n - **maxNumberOfPlans**: an optional maximum number of plans that the optimizer is \n allowed to generate. Setting this attribute to a low value allows to put a\n cap on the amount of work the optimizer does.\n - **allPlans**: if set to *true*, all possible execution plans will be returned.\n The default is *false*, meaning only the optimal plan will be returned.\n - **bindVars**: key/value pairs representing the bind values of type object\n\n\n\n\n\nTo explain how an AQL query would be executed on the server, the query string\ncan be sent to the server via an HTTP POST request. The server will then validate\nthe query and create an execution plan for it. The execution plan will be\nreturned, but the query will not be executed.\n\nThe execution plan that is returned by the server can be used to estimate the\nprobable performance of the query. Though the actual performance will depend\non many different factors, the execution plan normally can provide some rough\nestimates on the amount of work the server needs to do in order to actually run \nthe query.\n\nBy default, the explain operation will return the optimal plan as chosen by\nthe query optimizer The optimal plan is the plan with the lowest total estimated\ncost. The plan will be returned in the attribute *plan* of the response object.\nIf the option *allPlans* is specified in the request, the result will contain \nall plans created by the optimizer. The plans will then be returned in the \nattribute *plans*.\n\nThe result will also contain an attribute *warnings*, which is an array of \nwarnings that occurred during optimization or execution plan creation. Additionally,\na *stats* attribute is contained in the result with some optimizer statistics.\nIf *allPlans* is set to *false*, the result will contain an attribute *cacheable* \nthat states whether the query results can be cached on the server if the query\nresult cache were used. The *cacheable* attribute is not present when *allPlans*\nis set to *true*.\n\nEach plan in the result is a JSON object with the following attributes:\n- *nodes*: the array of execution nodes of the plan. The array of available node types\n can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *estimatedCost*: the total estimated cost for the plan. If there are multiple\n plans, the optimizer will choose the plan with the lowest total cost.\n\n- *collections*: an array of collections used in the query\n\n- *rules*: an array of rules the optimizer applied. An overview of the\n available rules can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *variables*: array of variables used in the query (note: this may contain\n internal variables created by the optimizer)\n\n\n\n\n#Example:\n Valid query\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products RETURN p\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"EnumerateCollectionNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 11, \n        \"estimatedNrItems\" : 10, \n        \"database\" : \"_system\", \n        \"collection\" : \"products\", \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        }, \n        \"random\" : false \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 21, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      } \n    ], \n    \"rules\" : [ ], \n    \"collections\" : [ \n      { \n        \"name\" : \"products\", \n        \"type\" : \"read\" \n      } \n    ], \n    \"variables\" : [ \n      { \n        \"id\" : 0, \n        \"name\" : \"p\" \n      } \n    ], \n    \"estimatedCost\" : 21, \n    \"estimatedNrItems\" : 10 \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n A plan with some optimizer rules applied\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"IndexNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 11, \n        \"estimatedCost\" : 11, \n        \"estimatedNrItems\" : 10, \n        \"database\" : \"_system\", \n        \"collection\" : \"products\", \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        }, \n        \"indexes\" : [ \n          { \n            \"id\" : \"10588\", \n            \"type\" : \"skiplist\", \n            \"fields\" : [ \n              \"id\" \n            ], \n            \"unique\" : false, \n            \"sparse\" : false \n          } \n        ], \n        \"condition\" : { \n        }, \n        \"reverse\" : false \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          11 \n        ], \n        \"id\" : 4, \n        \"estimatedCost\" : 21, \n        \"estimatedNrItems\" : 10, \n        \"expression\" : { \n          \"type\" : \"compare ==\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"attribute access\", \n              \"name\" : \"id\", \n              \"subNodes\" : [ \n                { \n                  \"type\" : \"reference\", \n                  \"name\" : \"p\", \n                  \"id\" : 0 \n                } \n              ] \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 4 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"simple\" \n      }, \n      { \n        \"type\" : \"FilterNode\", \n        \"dependencies\" : [ \n          4 \n        ], \n        \"id\" : 5, \n        \"estimatedCost\" : 31, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        } \n      }, \n      { \n        \"type\" : \"LimitNode\", \n        \"dependencies\" : [ \n          5 \n        ], \n        \"id\" : 9, \n        \"estimatedCost\" : 32, \n        \"estimatedNrItems\" : 1, \n        \"offset\" : 0, \n        \"limit\" : 1, \n        \"fullCount\" : false \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          9 \n        ], \n        \"id\" : 6, \n        \"estimatedCost\" : 33, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"attribute access\", \n          \"name\" : \"name\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"reference\", \n              \"name\" : \"p\", \n              \"id\" : 0 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"attribute\" \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          6 \n        ], \n        \"id\" : 10, \n        \"estimatedCost\" : 34, \n        \"estimatedNrItems\" : 1, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"remove-redundant-calculations\", \n      \"remove-unnecessary-calculations\", \n      \"move-calculations-up-2\", \n      \"use-index-for-sort\", \n      \"remove-unnecessary-calculations-2\", \n      \"move-calculations-down\" \n    ], \n    \"collections\" : [ \n      { \n        \"name\" : \"products\", \n        \"type\" : \"read\" \n      } \n    ], \n    \"variables\" : [ \n      { \n        \"id\" : 6, \n        \"name\" : \"5\" \n      }, \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"name\" \n      }, \n      { \n        \"id\" : 1, \n        \"name\" : \"a\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"p\" \n      } \n    ], \n    \"estimatedCost\" : 34, \n    \"estimatedNrItems\" : 1 \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using some options\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\", \n  \"options\" : { \n    \"maxNumberOfPlans\" : 2, \n    \"allPlans\" : true, \n    \"optimizer\" : { \n      \"rules\" : [ \n        \"-all\", \n        \"+use-index-for-sort\", \n        \"+use-index-range\" \n      ] \n    } \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plans\" : [ \n    { \n      \"nodes\" : [ \n        { \n          \"type\" : \"SingletonNode\", \n          \"dependencies\" : [ ], \n          \"id\" : 1, \n          \"estimatedCost\" : 1, \n          \"estimatedNrItems\" : 1 \n        }, \n        { \n          \"type\" : \"IndexNode\", \n          \"dependencies\" : [ \n            1 \n          ], \n          \"id\" : 11, \n          \"estimatedCost\" : 11, \n          \"estimatedNrItems\" : 10, \n          \"database\" : \"_system\", \n          \"collection\" : \"products\", \n          \"outVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          }, \n          \"indexes\" : [ \n            { \n              \"id\" : \"10626\", \n              \"type\" : \"skiplist\", \n              \"fields\" : [ \n                \"id\" \n              ], \n              \"unique\" : false, \n              \"sparse\" : false \n            } \n          ], \n          \"condition\" : { \n          }, \n          \"reverse\" : false \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            11 \n          ], \n          \"id\" : 3, \n          \"estimatedCost\" : 21, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"id\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 1, \n            \"name\" : \"a\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            3 \n          ], \n          \"id\" : 4, \n          \"estimatedCost\" : 31, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"compare ==\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"a\", \n                \"id\" : 1 \n              }, \n              { \n                \"type\" : \"value\", \n                \"value\" : 4 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 4, \n            \"name\" : \"3\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"simple\" \n        }, \n        { \n          \"type\" : \"FilterNode\", \n          \"dependencies\" : [ \n            4 \n          ], \n          \"id\" : 5, \n          \"estimatedCost\" : 41, \n          \"estimatedNrItems\" : 10, \n          \"inVariable\" : { \n            \"id\" : 4, \n            \"name\" : \"3\" \n          } \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            5 \n          ], \n          \"id\" : 6, \n          \"estimatedCost\" : 51, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"name\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 2, \n            \"name\" : \"name\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            6 \n          ], \n          \"id\" : 7, \n          \"estimatedCost\" : 61, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"id\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 6, \n            \"name\" : \"5\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"LimitNode\", \n          \"dependencies\" : [ \n            7 \n          ], \n          \"id\" : 9, \n          \"estimatedCost\" : 62, \n          \"estimatedNrItems\" : 1, \n          \"offset\" : 0, \n          \"limit\" : 1, \n          \"fullCount\" : false \n        }, \n        { \n          \"type\" : \"ReturnNode\", \n          \"dependencies\" : [ \n            9 \n          ], \n          \"id\" : 10, \n          \"estimatedCost\" : 63, \n          \"estimatedNrItems\" : 1, \n          \"inVariable\" : { \n            \"id\" : 2, \n            \"name\" : \"name\" \n          } \n        } \n      ], \n      \"rules\" : [ \n        \"use-index-for-sort\" \n      ], \n      \"collections\" : [ \n        { \n          \"name\" : \"products\", \n          \"type\" : \"read\" \n        } \n      ], \n      \"variables\" : [ \n        { \n          \"id\" : 6, \n          \"name\" : \"5\" \n        }, \n        { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        }, \n        { \n          \"id\" : 1, \n          \"name\" : \"a\" \n        }, \n        { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      ], \n      \"estimatedCost\" : 63, \n      \"estimatedNrItems\" : 1 \n    } \n  ], \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 1, \n    \"rulesSkipped\" : 25, \n    \"plansCreated\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Returning all plans\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products FILTER p.id == 25 RETURN p\", \n  \"options\" : { \n    \"allPlans\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plans\" : [ \n    { \n      \"nodes\" : [ \n        { \n          \"type\" : \"SingletonNode\", \n          \"dependencies\" : [ ], \n          \"id\" : 1, \n          \"estimatedCost\" : 1, \n          \"estimatedNrItems\" : 1 \n        }, \n        { \n          \"type\" : \"IndexNode\", \n          \"dependencies\" : [ \n            1 \n          ], \n          \"id\" : 6, \n          \"estimatedCost\" : 1.99, \n          \"estimatedNrItems\" : 1, \n          \"database\" : \"_system\", \n          \"collection\" : \"products\", \n          \"outVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          }, \n          \"indexes\" : [ \n            { \n              \"id\" : \"10574\", \n              \"type\" : \"hash\", \n              \"fields\" : [ \n                \"id\" \n              ], \n              \"selectivityEstimate\" : 1, \n              \"unique\" : false, \n              \"sparse\" : false \n            } \n          ], \n          \"condition\" : { \n            \"type\" : \"n-ary or\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"n-ary and\", \n                \"subNodes\" : [ \n                  { \n                    \"type\" : \"compare ==\", \n                    \"subNodes\" : [ \n                      { \n                        \"type\" : \"attribute access\", \n                        \"name\" : \"id\", \n                        \"subNodes\" : [ \n                          { \n                            \"type\" : \"reference\", \n                            \"name\" : \"p\", \n                            \"id\" : 0 \n                          } \n                        ] \n                      }, \n                      { \n                        \"type\" : \"value\", \n                        \"value\" : 25 \n                      } \n                    ] \n                  } \n                ] \n              } \n            ] \n          }, \n          \"reverse\" : false \n        }, \n        { \n          \"type\" : \"ReturnNode\", \n          \"dependencies\" : [ \n            6 \n          ], \n          \"id\" : 5, \n          \"estimatedCost\" : 2.99, \n          \"estimatedNrItems\" : 1, \n          \"inVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          } \n        } \n      ], \n      \"rules\" : [ \n        \"use-indexes\", \n        \"remove-filter-covered-by-index\" \n      ], \n      \"collections\" : [ \n        { \n          \"name\" : \"products\", \n          \"type\" : \"read\" \n        } \n      ], \n      \"variables\" : [ \n        { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      ], \n      \"estimatedCost\" : 2.99, \n      \"estimatedNrItems\" : 1 \n    } \n  ], \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n A query that produces a warning\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 RETURN 1 / 0\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 2, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"range\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 1 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 10 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"simple\" \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 4, \n        \"estimatedCost\" : 3, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"value\", \n          \"value\" : null \n        }, \n        \"outVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"json\" \n      }, \n      { \n        \"type\" : \"EnumerateListNode\", \n        \"dependencies\" : [ \n          4 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 13, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          3 \n        ], \n        \"id\" : 5, \n        \"estimatedCost\" : 23, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"move-calculations-up-2\" \n    ], \n    \"collections\" : [ ], \n    \"variables\" : [ \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"1\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"i\" \n      } \n    ], \n    \"estimatedCost\" : 23, \n    \"estimatedNrItems\" : 10 \n  }, \n  \"warnings\" : [ \n    { \n      \"code\" : 1562, \n      \"message\" : \"division by zero\" \n    } \n  ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Invalid query (missing bind parameter)\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products FILTER p.id == @id LIMIT 2 RETURN p.n\" \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1551, \n  \"errorMessage\" : \"no value specified for declared bind parameter 'id' (while parsing)\" \n}\n
\n\n\n\n\n#Example:\n The data returned in the **plan** attribute of the result contains one element per AQL top-level statement\n(i.e. `FOR`, `RETURN`, `FILTER` etc.). If the query optimizer removed some unnecessary statements,\nthe result might also contain less elements than there were top-level statements in the AQL query.\n\nThe following example shows a query with a non-sensible filter condition that\nthe optimizer has removed so that there are less top-level statements.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \"query\" : \"FOR i IN [ 1, 2, 3 ] FILTER 1 == 2 RETURN i\" }\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 2, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"array\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 1 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 2 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 3 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"json\" \n      }, \n      { \n        \"type\" : \"NoResultsNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 7, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0 \n      }, \n      { \n        \"type\" : \"EnumerateListNode\", \n        \"dependencies\" : [ \n          7 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          3 \n        ], \n        \"id\" : 6, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0, \n        \"inVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"move-filters-up\", \n      \"remove-unnecessary-filters\", \n      \"remove-unnecessary-calculations\" \n    ], \n    \"collections\" : [ ], \n    \"variables\" : [ \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"1\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"i\" \n      } \n    ], \n    \"estimatedCost\" : 0.5, \n    \"estimatedNrItems\" : 0 \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **query**: the query which you want explained; If the query references any bind variables,\n these must also be passed in the attribute *bindVars*. Additional\n options for the query can be passed in the *options* attribute.\n - **options**:\n - **optimizer.rules** (string): an array of to-be-included or to-be-excluded optimizer rules\n can be put into this attribute, telling the optimizer to include or exclude\n specific rules. To disable a rule, prefix its name with a `-`, to enable a rule, prefix it\n with a `+`. There is also a pseudo-rule `all`, which will match all optimizer rules. - **maxNumberOfPlans**: an optional maximum number of plans that the optimizer is \n allowed to generate. Setting this attribute to a low value allows to put a\n cap on the amount of work the optimizer does.\n - **allPlans**: if set to *true*, all possible execution plans will be returned.\n The default is *false*, meaning only the optimal plan will be returned.\n - **bindVars** (object): key/value pairs representing the bind parameters.\n\n\n\n\nTo explain how an AQL query would be executed on the server, the query string\ncan be sent to the server via an HTTP POST request. The server will then validate\nthe query and create an execution plan for it. The execution plan will be\nreturned, but the query will not be executed.\n\nThe execution plan that is returned by the server can be used to estimate the\nprobable performance of the query. Though the actual performance will depend\non many different factors, the execution plan normally can provide some rough\nestimates on the amount of work the server needs to do in order to actually run \nthe query.\n\nBy default, the explain operation will return the optimal plan as chosen by\nthe query optimizer The optimal plan is the plan with the lowest total estimated\ncost. The plan will be returned in the attribute *plan* of the response object.\nIf the option *allPlans* is specified in the request, the result will contain \nall plans created by the optimizer. The plans will then be returned in the \nattribute *plans*.\n\nThe result will also contain an attribute *warnings*, which is an array of \nwarnings that occurred during optimization or execution plan creation. Additionally,\na *stats* attribute is contained in the result with some optimizer statistics.\nIf *allPlans* is set to *false*, the result will contain an attribute *cacheable* \nthat states whether the query results can be cached on the server if the query\nresult cache were used. The *cacheable* attribute is not present when *allPlans*\nis set to *true*.\n\nEach plan in the result is a JSON object with the following attributes:\n- *nodes*: the array of execution nodes of the plan. The array of available node types\n can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *estimatedCost*: the total estimated cost for the plan. If there are multiple\n plans, the optimizer will choose the plan with the lowest total cost.\n\n- *collections*: an array of collections used in the query\n\n- *rules*: an array of rules the optimizer applied. An overview of the\n available rules can be found [here](../../AQL/ExecutionAndPerformance/Optimizer.html)\n\n- *variables*: array of variables used in the query (note: this may contain\n internal variables created by the optimizer)\n\n\n\n\n#Example:\n Valid query\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products RETURN p\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"EnumerateCollectionNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 11, \n        \"estimatedNrItems\" : 10, \n        \"database\" : \"_system\", \n        \"collection\" : \"products\", \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        }, \n        \"random\" : false \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 21, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      } \n    ], \n    \"rules\" : [ ], \n    \"collections\" : [ \n      { \n        \"name\" : \"products\", \n        \"type\" : \"read\" \n      } \n    ], \n    \"variables\" : [ \n      { \n        \"id\" : 0, \n        \"name\" : \"p\" \n      } \n    ], \n    \"estimatedCost\" : 21, \n    \"estimatedNrItems\" : 10 \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n A plan with some optimizer rules applied\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"IndexNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 11, \n        \"estimatedCost\" : 11, \n        \"estimatedNrItems\" : 10, \n        \"database\" : \"_system\", \n        \"collection\" : \"products\", \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        }, \n        \"indexes\" : [ \n          { \n            \"id\" : \"9940\", \n            \"type\" : \"skiplist\", \n            \"fields\" : [ \n              \"id\" \n            ], \n            \"unique\" : false, \n            \"sparse\" : false \n          } \n        ], \n        \"condition\" : { \n        }, \n        \"reverse\" : false \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          11 \n        ], \n        \"id\" : 4, \n        \"estimatedCost\" : 21, \n        \"estimatedNrItems\" : 10, \n        \"expression\" : { \n          \"type\" : \"compare ==\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"attribute access\", \n              \"name\" : \"id\", \n              \"subNodes\" : [ \n                { \n                  \"type\" : \"reference\", \n                  \"name\" : \"p\", \n                  \"id\" : 0 \n                } \n              ] \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 4 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"simple\" \n      }, \n      { \n        \"type\" : \"FilterNode\", \n        \"dependencies\" : [ \n          4 \n        ], \n        \"id\" : 5, \n        \"estimatedCost\" : 31, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        } \n      }, \n      { \n        \"type\" : \"LimitNode\", \n        \"dependencies\" : [ \n          5 \n        ], \n        \"id\" : 9, \n        \"estimatedCost\" : 32, \n        \"estimatedNrItems\" : 1, \n        \"offset\" : 0, \n        \"limit\" : 1, \n        \"fullCount\" : false \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          9 \n        ], \n        \"id\" : 6, \n        \"estimatedCost\" : 33, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"attribute access\", \n          \"name\" : \"name\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"reference\", \n              \"name\" : \"p\", \n              \"id\" : 0 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"attribute\" \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          6 \n        ], \n        \"id\" : 10, \n        \"estimatedCost\" : 34, \n        \"estimatedNrItems\" : 1, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"remove-redundant-calculations\", \n      \"remove-unnecessary-calculations\", \n      \"move-calculations-up-2\", \n      \"use-index-for-sort\", \n      \"remove-unnecessary-calculations-2\", \n      \"move-calculations-down\" \n    ], \n    \"collections\" : [ \n      { \n        \"name\" : \"products\", \n        \"type\" : \"read\" \n      } \n    ], \n    \"variables\" : [ \n      { \n        \"id\" : 6, \n        \"name\" : \"5\" \n      }, \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"name\" \n      }, \n      { \n        \"id\" : 1, \n        \"name\" : \"a\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"p\" \n      } \n    ], \n    \"estimatedCost\" : 34, \n    \"estimatedNrItems\" : 1 \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using some options\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products LET a = p.id FILTER a == 4 LET name = p.name SORT p.id LIMIT 1 RETURN name\", \n  \"options\" : { \n    \"maxNumberOfPlans\" : 2, \n    \"allPlans\" : true, \n    \"optimizer\" : { \n      \"rules\" : [ \n        \"-all\", \n        \"+use-index-for-sort\", \n        \"+use-index-range\" \n      ] \n    } \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plans\" : [ \n    { \n      \"nodes\" : [ \n        { \n          \"type\" : \"SingletonNode\", \n          \"dependencies\" : [ ], \n          \"id\" : 1, \n          \"estimatedCost\" : 1, \n          \"estimatedNrItems\" : 1 \n        }, \n        { \n          \"type\" : \"IndexNode\", \n          \"dependencies\" : [ \n            1 \n          ], \n          \"id\" : 11, \n          \"estimatedCost\" : 11, \n          \"estimatedNrItems\" : 10, \n          \"database\" : \"_system\", \n          \"collection\" : \"products\", \n          \"outVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          }, \n          \"indexes\" : [ \n            { \n              \"id\" : \"9978\", \n              \"type\" : \"skiplist\", \n              \"fields\" : [ \n                \"id\" \n              ], \n              \"unique\" : false, \n              \"sparse\" : false \n            } \n          ], \n          \"condition\" : { \n          }, \n          \"reverse\" : false \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            11 \n          ], \n          \"id\" : 3, \n          \"estimatedCost\" : 21, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"id\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 1, \n            \"name\" : \"a\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            3 \n          ], \n          \"id\" : 4, \n          \"estimatedCost\" : 31, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"compare ==\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"a\", \n                \"id\" : 1 \n              }, \n              { \n                \"type\" : \"value\", \n                \"value\" : 4 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 4, \n            \"name\" : \"3\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"simple\" \n        }, \n        { \n          \"type\" : \"FilterNode\", \n          \"dependencies\" : [ \n            4 \n          ], \n          \"id\" : 5, \n          \"estimatedCost\" : 41, \n          \"estimatedNrItems\" : 10, \n          \"inVariable\" : { \n            \"id\" : 4, \n            \"name\" : \"3\" \n          } \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            5 \n          ], \n          \"id\" : 6, \n          \"estimatedCost\" : 51, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"name\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 2, \n            \"name\" : \"name\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"CalculationNode\", \n          \"dependencies\" : [ \n            6 \n          ], \n          \"id\" : 7, \n          \"estimatedCost\" : 61, \n          \"estimatedNrItems\" : 10, \n          \"expression\" : { \n            \"type\" : \"attribute access\", \n            \"name\" : \"id\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"reference\", \n                \"name\" : \"p\", \n                \"id\" : 0 \n              } \n            ] \n          }, \n          \"outVariable\" : { \n            \"id\" : 6, \n            \"name\" : \"5\" \n          }, \n          \"canThrow\" : false, \n          \"expressionType\" : \"attribute\" \n        }, \n        { \n          \"type\" : \"LimitNode\", \n          \"dependencies\" : [ \n            7 \n          ], \n          \"id\" : 9, \n          \"estimatedCost\" : 62, \n          \"estimatedNrItems\" : 1, \n          \"offset\" : 0, \n          \"limit\" : 1, \n          \"fullCount\" : false \n        }, \n        { \n          \"type\" : \"ReturnNode\", \n          \"dependencies\" : [ \n            9 \n          ], \n          \"id\" : 10, \n          \"estimatedCost\" : 63, \n          \"estimatedNrItems\" : 1, \n          \"inVariable\" : { \n            \"id\" : 2, \n            \"name\" : \"name\" \n          } \n        } \n      ], \n      \"rules\" : [ \n        \"use-index-for-sort\" \n      ], \n      \"collections\" : [ \n        { \n          \"name\" : \"products\", \n          \"type\" : \"read\" \n        } \n      ], \n      \"variables\" : [ \n        { \n          \"id\" : 6, \n          \"name\" : \"5\" \n        }, \n        { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        { \n          \"id\" : 2, \n          \"name\" : \"name\" \n        }, \n        { \n          \"id\" : 1, \n          \"name\" : \"a\" \n        }, \n        { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      ], \n      \"estimatedCost\" : 63, \n      \"estimatedNrItems\" : 1 \n    } \n  ], \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 1, \n    \"rulesSkipped\" : 25, \n    \"plansCreated\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Returning all plans\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products FILTER p.id == 25 RETURN p\", \n  \"options\" : { \n    \"allPlans\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plans\" : [ \n    { \n      \"nodes\" : [ \n        { \n          \"type\" : \"SingletonNode\", \n          \"dependencies\" : [ ], \n          \"id\" : 1, \n          \"estimatedCost\" : 1, \n          \"estimatedNrItems\" : 1 \n        }, \n        { \n          \"type\" : \"IndexNode\", \n          \"dependencies\" : [ \n            1 \n          ], \n          \"id\" : 6, \n          \"estimatedCost\" : 1.99, \n          \"estimatedNrItems\" : 1, \n          \"database\" : \"_system\", \n          \"collection\" : \"products\", \n          \"outVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          }, \n          \"indexes\" : [ \n            { \n              \"id\" : \"9926\", \n              \"type\" : \"hash\", \n              \"fields\" : [ \n                \"id\" \n              ], \n              \"selectivityEstimate\" : 1, \n              \"unique\" : false, \n              \"sparse\" : false \n            } \n          ], \n          \"condition\" : { \n            \"type\" : \"n-ary or\", \n            \"subNodes\" : [ \n              { \n                \"type\" : \"n-ary and\", \n                \"subNodes\" : [ \n                  { \n                    \"type\" : \"compare ==\", \n                    \"subNodes\" : [ \n                      { \n                        \"type\" : \"attribute access\", \n                        \"name\" : \"id\", \n                        \"subNodes\" : [ \n                          { \n                            \"type\" : \"reference\", \n                            \"name\" : \"p\", \n                            \"id\" : 0 \n                          } \n                        ] \n                      }, \n                      { \n                        \"type\" : \"value\", \n                        \"value\" : 25 \n                      } \n                    ] \n                  } \n                ] \n              } \n            ] \n          }, \n          \"reverse\" : false \n        }, \n        { \n          \"type\" : \"ReturnNode\", \n          \"dependencies\" : [ \n            6 \n          ], \n          \"id\" : 5, \n          \"estimatedCost\" : 2.99, \n          \"estimatedNrItems\" : 1, \n          \"inVariable\" : { \n            \"id\" : 0, \n            \"name\" : \"p\" \n          } \n        } \n      ], \n      \"rules\" : [ \n        \"use-indexes\", \n        \"remove-filter-covered-by-index\" \n      ], \n      \"collections\" : [ \n        { \n          \"name\" : \"products\", \n          \"type\" : \"read\" \n        } \n      ], \n      \"variables\" : [ \n        { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        { \n          \"id\" : 0, \n          \"name\" : \"p\" \n        } \n      ], \n      \"estimatedCost\" : 2.99, \n      \"estimatedNrItems\" : 1 \n    } \n  ], \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n A query that produces a warning\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 RETURN 1 / 0\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 2, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"range\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 1 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 10 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"simple\" \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 4, \n        \"estimatedCost\" : 3, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"value\", \n          \"value\" : null \n        }, \n        \"outVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"json\" \n      }, \n      { \n        \"type\" : \"EnumerateListNode\", \n        \"dependencies\" : [ \n          4 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 13, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          3 \n        ], \n        \"id\" : 5, \n        \"estimatedCost\" : 23, \n        \"estimatedNrItems\" : 10, \n        \"inVariable\" : { \n          \"id\" : 4, \n          \"name\" : \"3\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"move-calculations-up-2\" \n    ], \n    \"collections\" : [ ], \n    \"variables\" : [ \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"1\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"i\" \n      } \n    ], \n    \"estimatedCost\" : 23, \n    \"estimatedNrItems\" : 10 \n  }, \n  \"warnings\" : [ \n    { \n      \"code\" : 1562, \n      \"message\" : \"division by zero\" \n    } \n  ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Invalid query (missing bind parameter)\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \n  \"query\" : \"FOR p IN products FILTER p.id == @id LIMIT 2 RETURN p.n\" \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1551, \n  \"errorMessage\" : \"no value specified for declared bind parameter 'id' (while parsing)\" \n}\n
\n\n\n\n\n#Example:\n The data returned in the **plan** attribute of the result contains one element per AQL top-level statement\n(i.e. `FOR`, `RETURN`, `FILTER` etc.). If the query optimizer removed some unnecessary statements,\nthe result might also contain less elements than there were top-level statements in the AQL query.\n\nThe following example shows a query with a non-sensible filter condition that\nthe optimizer has removed so that there are less top-level statements.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/explain <<EOF\n{ \"query\" : \"FOR i IN [ 1, 2, 3 ] FILTER 1 == 2 RETURN i\" }\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"plan\" : { \n    \"nodes\" : [ \n      { \n        \"type\" : \"SingletonNode\", \n        \"dependencies\" : [ ], \n        \"id\" : 1, \n        \"estimatedCost\" : 1, \n        \"estimatedNrItems\" : 1 \n      }, \n      { \n        \"type\" : \"CalculationNode\", \n        \"dependencies\" : [ \n          1 \n        ], \n        \"id\" : 2, \n        \"estimatedCost\" : 2, \n        \"estimatedNrItems\" : 1, \n        \"expression\" : { \n          \"type\" : \"array\", \n          \"subNodes\" : [ \n            { \n              \"type\" : \"value\", \n              \"value\" : 1 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 2 \n            }, \n            { \n              \"type\" : \"value\", \n              \"value\" : 3 \n            } \n          ] \n        }, \n        \"outVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"canThrow\" : false, \n        \"expressionType\" : \"json\" \n      }, \n      { \n        \"type\" : \"NoResultsNode\", \n        \"dependencies\" : [ \n          2 \n        ], \n        \"id\" : 7, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0 \n      }, \n      { \n        \"type\" : \"EnumerateListNode\", \n        \"dependencies\" : [ \n          7 \n        ], \n        \"id\" : 3, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0, \n        \"inVariable\" : { \n          \"id\" : 2, \n          \"name\" : \"1\" \n        }, \n        \"outVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      }, \n      { \n        \"type\" : \"ReturnNode\", \n        \"dependencies\" : [ \n          3 \n        ], \n        \"id\" : 6, \n        \"estimatedCost\" : 0.5, \n        \"estimatedNrItems\" : 0, \n        \"inVariable\" : { \n          \"id\" : 0, \n          \"name\" : \"i\" \n        } \n      } \n    ], \n    \"rules\" : [ \n      \"move-calculations-up\", \n      \"move-filters-up\", \n      \"remove-unnecessary-filters\", \n      \"remove-unnecessary-calculations\" \n    ], \n    \"collections\" : [ ], \n    \"variables\" : [ \n      { \n        \"id\" : 4, \n        \"name\" : \"3\" \n      }, \n      { \n        \"id\" : 2, \n        \"name\" : \"1\" \n      }, \n      { \n        \"id\" : 0, \n        \"name\" : \"i\" \n      } \n    ], \n    \"estimatedCost\" : 0.5, \n    \"estimatedNrItems\" : 0 \n  }, \n  \"warnings\" : [ ], \n  \"stats\" : { \n    \"rulesExecuted\" : 26, \n    \"rulesSkipped\" : 0, \n    \"plansCreated\" : 1 \n  }, \n  \"cacheable\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -4096,12 +4178,12 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/export": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **count**: boolean flag that indicates whether the number of documents\n in the result set should be returned in the \"count\" attribute of the result\n (optional).\n Calculating the \"count\" attribute might in the future have a performance\n impact so this option is turned off by default, and \"count\" is only returned\n when requested.\n - **restrict**:\n - **fields**: Contains an array of attribute names to *include* or *exclude*. Matching of attribute names\n for *inclusion* or *exclusion* will be done on the top level only.\n Specifying names of nested attributes is not supported at the moment. of type string\n - **type**: has to be be set to either *include* or *exclude* depending on which you want to use\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip (optional). If this attribute is\n not set, a server-controlled default value will be used.\n - **flush**: if set to *true*, a WAL flush operation will be executed prior to the\n export. The flush operation will start copying documents from the WAL to the\n collection's datafiles. There will be an additional wait time of up\n to *flushWait* seconds after the flush to allow the WAL collector to change\n the adjusted document meta-data to point into the datafiles, too.\n The default value is *false* (i.e. no flush) so most recently inserted or\n updated\n documents from the collection might be missing in the export.\n - **flushWait**: maximum wait time in seconds after a flush operation. The default\n value is 10. This option only has an effect when *flush* is set to *true*.\n - **limit**: an optional limit value, determining the maximum number of documents to\n be included in the cursor. Omitting the *limit* attribute or setting it to 0 will\n lead to no limit being used. If a limit is used, it is undefined which documents\n from the collection will be included in the export and which will be excluded. \n This is because there is no natural order of documents in a collection.\n - **ttl**: an optional time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n\n\n\n\nA call to this method creates a cursor containing all documents in the \nspecified collection. In contrast to other data-producing APIs, the internal\ndata structures produced by the export API are more lightweight, so it is\nthe preferred way to retrieve all documents from a collection.\n\nDocuments are returned in a similar manner as in the `/_api/cursor` REST API. \nIf all documents of the collection fit into the first batch, then no cursor\nwill be created, and the result object's *hasMore* attribute will be set to\n*false*. If not all documents fit into the first batch, then the result \nobject's *hasMore* attribute will be set to *true*, and the *id* attribute\nof the result will contain a cursor id.\n\nThe order in which the documents are returned is not specified.\n\nBy default, only those documents from the collection will be returned that are\nstored in the collection's datafiles. Documents that are present in the write-ahead\nlog (WAL) at the time the export is run will not be exported.\n\nTo export these documents as well, the caller can issue a WAL flush request\nbefore calling the export API or set the *flush* attribute. Setting the *flush*\noption will trigger a WAL flush before the export so documents get copied from \nthe WAL to the collection datafiles.\n\nIf the result set can be created by the server, the server will respond with\n*HTTP 201*. The body of the response will contain a JSON object with the\nresult set.\n\nThe returned JSON object has the following properties:\n\n- *error*: boolean flag to indicate that an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: an array of result documents (might be empty if the collection was empty)\n\n- *hasMore*: a boolean indicator whether there are more results\n available for the cursor on the server\n\n- *count*: the total number of result documents available (only\n available if the query was executed with the *count* attribute set)\n\n- *id*: id of temporary cursor created on the server (optional, see above)\n\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\n\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\nClients should always delete an export cursor result as early as possible because a\nlingering export cursor will prevent the underlying collection from being\ncompacted or unloaded. By default, unused cursors will be deleted automatically \nafter a server-defined idle time, and clients can adjust this idle time by setting\nthe *ttl* value.\n\nNote: this API is currently not supported on cluster coordinators.\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **count**: boolean flag that indicates whether the number of documents\n in the result set should be returned in the \"count\" attribute of the result\n (optional).\n Calculating the \"count\" attribute might in the future have a performance\n impact so this option is turned off by default, and \"count\" is only returned\n when requested.\n - **restrict**:\n - **fields** (string): Contains an array of attribute names to *include* or *exclude*. Matching of attribute names\n for *inclusion* or *exclusion* will be done on the top level only.\n Specifying names of nested attributes is not supported at the moment. - **type**: has to be be set to either *include* or *exclude* depending on which you want to use\n - **batchSize**: maximum number of result documents to be transferred from\n the server to the client in one roundtrip (optional). If this attribute is\n not set, a server-controlled default value will be used.\n - **flush**: if set to *true*, a WAL flush operation will be executed prior to the\n export. The flush operation will start copying documents from the WAL to the\n collection's datafiles. There will be an additional wait time of up\n to *flushWait* seconds after the flush to allow the WAL collector to change\n the adjusted document meta-data to point into the datafiles, too.\n The default value is *false* (i.e. no flush) so most recently inserted or\n updated\n documents from the collection might be missing in the export.\n - **flushWait**: maximum wait time in seconds after a flush operation. The default\n value is 10. This option only has an effect when *flush* is set to *true*.\n - **limit**: an optional limit value, determining the maximum number of documents to\n be included in the cursor. Omitting the *limit* attribute or setting it to 0 will\n lead to no limit being used. If a limit is used, it is undefined which documents\n from the collection will be included in the export and which will be excluded. \n This is because there is no natural order of documents in a collection.\n - **ttl**: an optional time-to-live for the cursor (in seconds). The cursor will be\n removed on the server automatically after the specified amount of time. This\n is useful to ensure garbage collection of cursors that are not fully fetched\n by clients. If not set, a server-defined value will be used.\n\n\n\n\nA call to this method creates a cursor containing all documents in the \nspecified collection. In contrast to other data-producing APIs, the internal\ndata structures produced by the export API are more lightweight, so it is\nthe preferred way to retrieve all documents from a collection.\n\nDocuments are returned in a similar manner as in the `/_api/cursor` REST API. \nIf all documents of the collection fit into the first batch, then no cursor\nwill be created, and the result object's *hasMore* attribute will be set to\n*false*. If not all documents fit into the first batch, then the result \nobject's *hasMore* attribute will be set to *true*, and the *id* attribute\nof the result will contain a cursor id.\n\nThe order in which the documents are returned is not specified.\n\nBy default, only those documents from the collection will be returned that are\nstored in the collection's datafiles. Documents that are present in the write-ahead\nlog (WAL) at the time the export is run will not be exported.\n\nTo export these documents as well, the caller can issue a WAL flush request\nbefore calling the export API or set the *flush* attribute. Setting the *flush*\noption will trigger a WAL flush before the export so documents get copied from \nthe WAL to the collection datafiles.\n\nIf the result set can be created by the server, the server will respond with\n*HTTP 201*. The body of the response will contain a JSON object with the\nresult set.\n\nThe returned JSON object has the following properties:\n\n- *error*: boolean flag to indicate that an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: an array of result documents (might be empty if the collection was empty)\n\n- *hasMore*: a boolean indicator whether there are more results\n available for the cursor on the server\n\n- *count*: the total number of result documents available (only\n available if the query was executed with the *count* attribute set)\n\n- *id*: id of temporary cursor created on the server (optional, see above)\n\nIf the JSON representation is malformed or the query specification is\nmissing from the request, the server will respond with *HTTP 400*.\n\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\nClients should always delete an export cursor result as early as possible because a\nlingering export cursor will prevent the underlying collection from being\ncompacted or unloaded. By default, unused cursors will be deleted automatically \nafter a server-defined idle time, and clients can adjust this idle time by setting\nthe *ttl* value.\n\nNote: this API is currently not supported on cluster coordinators.\n\n", "parameters": [ { "in": "body", @@ -4142,12 +4224,12 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md" } }, "/_api/gharial": { "get": { - "description": "\n\nLists all graph names stored in this database.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"graphs\" : [ \n    { \n      \"_key\" : \"routeplanner\", \n      \"_id\" : \"_graphs/routeplanner\", \n      \"_rev\" : \"8658\", \n      \"edgeDefinitions\" : [ \n        { \n          \"collection\" : \"germanHighway\", \n          \"from\" : [ \n            \"germanCity\" \n          ], \n          \"to\" : [ \n            \"germanCity\" \n          ] \n        }, \n        { \n          \"collection\" : \"frenchHighway\", \n          \"from\" : [ \n            \"frenchCity\" \n          ], \n          \"to\" : [ \n            \"frenchCity\" \n          ] \n        }, \n        { \n          \"collection\" : \"internationalHighway\", \n          \"from\" : [ \n            \"frenchCity\", \n            \"germanCity\" \n          ], \n          \"to\" : [ \n            \"frenchCity\", \n            \"germanCity\" \n          ] \n        } \n      ], \n      \"orphanCollections\" : [ ] \n    }, \n    { \n      \"_key\" : \"social\", \n      \"_id\" : \"_graphs/social\", \n      \"_rev\" : \"8613\", \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    } \n  ], \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\nLists all graph names stored in this database.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"graphs\" : [ \n    { \n      \"_key\" : \"routeplanner\", \n      \"_id\" : \"_graphs/routeplanner\", \n      \"_rev\" : \"_Tn2X5sO---\", \n      \"edgeDefinitions\" : [ \n        { \n          \"collection\" : \"germanHighway\", \n          \"from\" : [ \n            \"germanCity\" \n          ], \n          \"to\" : [ \n            \"germanCity\" \n          ] \n        }, \n        { \n          \"collection\" : \"frenchHighway\", \n          \"from\" : [ \n            \"frenchCity\" \n          ], \n          \"to\" : [ \n            \"frenchCity\" \n          ] \n        }, \n        { \n          \"collection\" : \"internationalHighway\", \n          \"from\" : [ \n            \"frenchCity\", \n            \"germanCity\" \n          ], \n          \"to\" : [ \n            \"frenchCity\", \n            \"germanCity\" \n          ] \n        } \n      ], \n      \"orphanCollections\" : [ ] \n    }, \n    { \n      \"_key\" : \"social\", \n      \"_id\" : \"_graphs/social\", \n      \"_rev\" : \"_Tn2X5lu---\", \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    } \n  ], \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -4159,10 +4241,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_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**A json post document 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\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\ncontent-type: application/json; charset=utf-8\netag: 8214\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"8214\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", + "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**A json post document 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\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\netag: _Tn2X4hm---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_Tn2X4hm---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [ { "in": "body", @@ -4190,7 +4272,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}": { @@ -4213,10 +4295,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_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\ncontent-type: application/json; charset=utf-8\netag: 8533\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"8533\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "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\netag: _Tn2X5Ze---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_Tn2X5Ze---\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -4231,7 +4313,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/edge": { @@ -4251,10 +4333,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_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**A json post document with these Properties is required:**\n\n - **to**: One or many edge collections that can contain target vertices. of type string\n - **from**: One or many vertex collections that can contain source vertices. of type string\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\ncontent-type: application/json; charset=utf-8\netag: 8029\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"8029\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", + "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**A json post document with these Properties is required:**\n\n - **to** (string): One or many edge collections that can contain target vertices. - **from** (string): One or many vertex collections that can contain source vertices. - **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\netag: _Tn2X3rm---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_Tn2X3rm---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [ { "in": "body", @@ -4285,12 +4367,12 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}": { "post": { - "description": "\n\nCreates a new edge in the collection.\nWithin the body the has to contain a *\\\\\\_from* and *\\\\\\_to* value referencing to valid vertices in the graph.\nFurthermore the edge has to be valid in the definition of this\n[edge collection](../../Manual/Appendix/Glossary.html#edge-collection).\n\n\nfree style json body\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF\n{ \n  \"type\" : \"friend\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"female/diana\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 8005\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/8005\", \n    \"_key\" : \"8005\", \n    \"_rev\" : \"8005\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", + "description": "\n\nCreates a new edge in the collection.\nWithin the body the has to contain a *\\\\\\_from* and *\\\\\\_to* value referencing to valid vertices in the graph.\nFurthermore the edge has to be valid in the definition of this\n[edge collection](../../Manual/Appendix/Glossary.html#edge-collection).\n\n\nfree style json body\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF\n{ \n  \"type\" : \"friend\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"female/diana\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\netag: _Tn2X3ka---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/7679\", \n    \"_key\" : \"7679\", \n    \"_rev\" : \"_Tn2X3ka---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body has to be the JSON object to be stored.\n\n", @@ -4320,7 +4402,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}": { @@ -4346,10 +4428,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_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/aliceAndBob\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: 8497\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_key\" : \"aliceAndBob\", \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_from\" : \"female/alice\", \n    \"_to\" : \"male/bob\", \n    \"_rev\" : \"8497\", \n    \"type\" : \"married\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "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/aliceAndBob\n\nHTTP/1.1 200 OK\netag: _Tn2X5Q---C\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_key\" : \"aliceAndBob\", \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_from\" : \"female/alice\", \n    \"_to\" : \"male/bob\", \n    \"_rev\" : \"_Tn2X5Q---C\", \n    \"type\" : \"married\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -4367,10 +4449,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "patch": { - "description": "\n\nUpdates the data of the specific edge in the collection.\n\n\nfree style json body\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"since\" : \"01.01.2001\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 8957\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"8957\", \n    \"_oldRev\" : \"8942\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", + "description": "\n\nUpdates the data of the specific edge in the collection.\n\n\nfree style json body\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"since\" : \"01.01.2001\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\netag: _Tn2X58y---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"_Tn2X58y---\", \n    \"_oldRev\" : \"_Tn2X58m--C\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body has to be a JSON object containing the attributes to be updated.\n\n", @@ -4400,10 +4482,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "put": { - "description": "\n\nReplaces the data of an edge in the collection.\n\n\nfree style json body\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"type\" : \"divorced\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"male/bob\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 9015\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"9015\", \n    \"_oldRev\" : \"9000\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", + "description": "\n\nReplaces the data of an edge in the collection.\n\n\nfree style json body\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"type\" : \"divorced\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"male/bob\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\netag: _Tn2X6Au---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"_Tn2X6Au---\", \n    \"_oldRev\" : \"_Tn2X6Ae--C\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [ { "description": "The body has to be the JSON object to be stored.\n\n", @@ -4436,12 +4518,12 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{definition-name}": { "delete": { - "description": "\n\nRemove one edge definition from the graph. This will only remove the\nedge collection, the vertex collections remain untouched and can still\nbe used in your queries.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/edge/relation\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 8421\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ ], \n    \"orphanCollections\" : [ \n      \"female\", \n      \"male\" \n    ], \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"8421\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", + "description": "\n\nRemove one edge definition from the graph. This will only remove the\nedge collection, the vertex collections remain untouched and can still\nbe used in your queries.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/edge/relation\n\nHTTP/1.1 202 Accepted\netag: _Tn2X5IS---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ ], \n    \"orphanCollections\" : [ \n      \"female\", \n      \"male\" \n    ], \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_Tn2X5IS---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [], "responses": { "201": { @@ -4462,10 +4544,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "post": { - "description": "\n\nChange one specific edge definition.\nThis will modify all occurrences of this definition in all graphs known to your database.\n\n**A json post document with these Properties is required:**\n\n - **to**: One or many edge collections that can contain target vertices. of type string\n - **from**: One or many vertex collections that can contain source vertices. of type string\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\ncontent-type: application/json; charset=utf-8\netag: 9161\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"9161\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", + "description": "\n\nChange one specific edge definition.\nThis will modify all occurrences of this definition in all graphs known to your database.\n\n**A json post document with these Properties is required:**\n\n - **to** (string): One or many edge collections that can contain target vertices. - **from** (string): One or many vertex collections that can contain source vertices. - **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\netag: _Tn2X6ee---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_Tn2X6ee---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [ { "in": "body", @@ -4496,7 +4578,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex": { @@ -4516,10 +4598,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_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\ncontent-type: application/json; charset=utf-8\netag: 8153\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"8153\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", + "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\netag: _Tn2X4Pi---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_Tn2X4Pi---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", "parameters": [], "responses": { "201": { @@ -4537,12 +4619,12 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}": { "delete": { - "description": "\n\nRemoves a vertex collection from the graph and optionally deletes the collection,\nif it is not used in any other graph.\n\n\n\n\n#Example:\n You can remove vertex collections that are not used in any edge collection:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/otherVertices\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: 9073\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"9073\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n#Example:\n You cannot remove vertex collections that are used in edge collections:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/male\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json\n\n{ \n  \"error\" : true, \n  \"errorNum\" : 1928, \n  \"errorMessage\" : \"not in orphan collection\", \n  \"code\" : 400 \n}\n
\n\n\n\n\n", + "description": "\n\nRemoves a vertex collection from the graph and optionally deletes the collection,\nif it is not used in any other graph.\n\n\n\n\n#Example:\n You can remove vertex collections that are not used in any edge collection:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/otherVertices\n\nHTTP/1.1 202 Accepted\netag: _Tn2X6EO---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \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    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_Tn2X6EO---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n#Example:\n You cannot remove vertex collections that are used in edge collections:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/gharial/social/vertex/male\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json\n\n{ \n  \"error\" : true, \n  \"errorNum\" : 1928, \n  \"errorMessage\" : \"not in orphan collection\", \n  \"code\" : 400 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "201": { @@ -4563,10 +4645,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "post": { - "description": "\n\nAdds a vertex to the given collection.\n\n\nfree style json body\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\ncontent-type: application/json; charset=utf-8\netag: 8128\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"male/8128\", \n    \"_key\" : \"8128\", \n    \"_rev\" : \"8128\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", + "description": "\n\nAdds a vertex to the given collection.\n\n\nfree style json body\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\netag: _Tn2X4_e---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"male/7781\", \n    \"_key\" : \"7781\", \n    \"_rev\" : \"_Tn2X4_e---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body has to be the JSON object to be stored.\n\n", @@ -4596,7 +4678,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}": { @@ -4622,10 +4704,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_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\ncontent-type: application/json; charset=utf-8\netag: 8562\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_key\" : \"alice\", \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"8562\", \n    \"name\" : \"Alice\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "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\netag: _Tn2X5hW---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_key\" : \"alice\", \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"_Tn2X5hW---\", \n    \"name\" : \"Alice\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -4643,10 +4725,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "patch": { - "description": "\n\nUpdates the data of the specific vertex in the collection.\n\n\nfree style json body\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\ncontent-type: application/json; charset=utf-8\netag: 8898\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"8898\", \n    \"_oldRev\" : \"8868\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", + "description": "\n\nUpdates the data of the specific vertex in the collection.\n\n\nfree style json body\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\netag: _Tn2X55y---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_Tn2X55y---\", \n    \"_oldRev\" : \"_Tn2X55i---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body has to contain a JSON object containing exactly the attributes that should be replaced.\n\n", @@ -4679,10 +4761,10 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" }, "put": { - "description": "\n\nReplaces the data of a vertex in the collection.\n\n\nfree style json body\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\ncontent-type: application/json; charset=utf-8\netag: 9258\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"9258\", \n    \"_oldRev\" : \"9228\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", + "description": "\n\nReplaces the data of a vertex in the collection.\n\n\nfree style json body\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\netag: _Tn2X6u2---\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_Tn2X6u2---\", \n    \"_oldRev\" : \"_Tn2X6uq---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body has to be the JSON object to be stored.\n\n", @@ -4715,12 +4797,12 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md" } }, "/_api/import#document": { "post": { - "description": "\nfree style json body\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates documents in the collection identified by `collection-name`.\nThe first line of the request body must contain a JSON-encoded array of\nattribute names. All following lines in the request body must contain\nJSON-encoded arrays of attribute values. Each line is interpreted as a\nseparate document, and the values specified will be mapped to the array\nof attribute names specified in the first header line.\n\nThe response is a JSON object with the following attributes:\n\n- `created`: number of documents imported.\n\n- `errors`: number of documents that were not imported due to an error.\n\n- `empty`: number of empty lines found in the input (will only contain a\n value greater zero for types `documents` or `auto`).\n\n- `updated`: number of updated/replaced documents (in case `onDuplicate`\n was set to either `update` or `replace`).\n\n- `ignored`: number of failed but ignored insert operations (in case\n `onDuplicate` was set to `ignore`).\n\n- `details`: if query parameter `details` is set to true, the result will\n contain a `details` attribute which is an array with more detailed\n information about which documents could not be inserted.\n\nNote: this API is currently not supported on cluster coordinators.\n\n\n\n\n#Example:\n Importing two documents, with attributes `_key`, `value1` and `value2` each. One\nline in the import data is empty\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n\n[ \"foo\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 1, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, with attributes `_from`, `_to` and `name`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links <<EOF\n[ \"_from\", \"_to\", \"name\" ]\n[ \"products/123\",\"products/234\", \"some name\" ]\n[ \"products/332\", \"products/abc\", \"other name\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, omitting `_from` or `_to`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&details=true <<EOF\n[ \"name\" ]\n[ \"some name\" ]\n[ \"other name\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 0, \n  \"errors\" : 2, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"some name\\\"}\", \n    \"at position 2: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"other name\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, but allow partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&details=true <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"abc\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 1, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 2: creating document failed with error 'unique constraint violated', offending document: {\\\"_key\\\":\\\"abc\\\",\\\"value1\\\":\\\"bar\\\",\\\"value2\\\":\\\"baz\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, not allowing partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&complete=true <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"abc\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 409 Conflict\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cannot create document, unique constraint violated\", \n  \"code\" : 409, \n  \"errorNum\" : 1210 \n}\n
\n\n\n\n\n#Example:\n Using a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"foo\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Using a malformed body\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n{ \"_key\": \"foo\", \"value1\": \"bar\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"no JSON array found in second line\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates documents in the collection identified by `collection-name`.\nThe first line of the request body must contain a JSON-encoded array of\nattribute names. All following lines in the request body must contain\nJSON-encoded arrays of attribute values. Each line is interpreted as a\nseparate document, and the values specified will be mapped to the array\nof attribute names specified in the first header line.\n\nThe response is a JSON object with the following attributes:\n\n- `created`: number of documents imported.\n\n- `errors`: number of documents that were not imported due to an error.\n\n- `empty`: number of empty lines found in the input (will only contain a\n value greater zero for types `documents` or `auto`).\n\n- `updated`: number of updated/replaced documents (in case `onDuplicate`\n was set to either `update` or `replace`).\n\n- `ignored`: number of failed but ignored insert operations (in case\n `onDuplicate` was set to `ignore`).\n\n- `details`: if query parameter `details` is set to true, the result will\n contain a `details` attribute which is an array with more detailed\n information about which documents could not be inserted.\n\nNote: this API is currently not supported on cluster coordinators.\n\n\n\n\n#Example:\n Importing two documents, with attributes `_key`, `value1` and `value2` each. One\nline in the import data is empty\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n\n[ \"foo\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 1, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, with attributes `_from`, `_to` and `name`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links <<EOF\n[ \"_from\", \"_to\", \"name\" ]\n[ \"products/123\",\"products/234\", \"some name\" ]\n[ \"products/332\", \"products/abc\", \"other name\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, omitting `_from` or `_to`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&details=true <<EOF\n[ \"name\" ]\n[ \"some name\" ]\n[ \"other name\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 0, \n  \"errors\" : 2, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"some name\\\"}\", \n    \"at position 2: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"other name\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, but allow partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&details=true <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"abc\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 1, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: creating document failed with error 'unique constraint violated', offending document: {\\\"_key\\\":\\\"abc\\\",\\\"value1\\\":\\\"bar\\\",\\\"value2\\\":\\\"baz\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, not allowing partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&complete=true <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"abc\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 409 Conflict\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cannot create document, unique constraint violated\", \n  \"code\" : 409, \n  \"errorNum\" : 1210 \n}\n
\n\n\n\n\n#Example:\n Using a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n[ \"_key\", \"value1\", \"value2\" ]\n[ \"abc\", 25, \"test\" ]\n[\"foo\", \"bar\", \"baz\" ]\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Using a malformed body\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products <<EOF\n{ \"_key\": \"foo\", \"value1\": \"bar\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"no JSON array found in second line\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body must consist of JSON-encoded arrays of attribute values, with one\nline per document. The first row of the request must be a JSON-encoded\narray of attribute names. These attribute names are used for the data in the\nsubsequent lines.\n\n", @@ -4815,12 +4897,12 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md" } }, "/_api/import#json": { "post": { - "description": "\nfree style json body\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates documents in the collection identified by `collection-name`.\nThe JSON representations of the documents must be passed as the body of the\nPOST request. The request body can either consist of multiple lines, with\neach line being a single stand-alone JSON object, or a singe JSON array with\nsub-objects.\n\nThe response is a JSON object with the following attributes:\n\n- `created`: number of documents imported.\n\n- `errors`: number of documents that were not imported due to an error.\n\n- `empty`: number of empty lines found in the input (will only contain a\n value greater zero for types `documents` or `auto`).\n\n- `updated`: number of updated/replaced documents (in case `onDuplicate`\n was set to either `update` or `replace`).\n\n- `ignored`: number of failed but ignored insert operations (in case\n `onDuplicate` was set to `ignore`).\n\n- `details`: if query parameter `details` is set to true, the result will\n contain a `details` attribute which is an array with more detailed\n information about which documents could not be inserted.\n\nNote: this API is currently not supported on cluster coordinators.\n\n\n\n\n#Example:\n Importing documents with heterogenous attributes from a JSON array\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=list <<EOF\n[ \n  { \n    \"_key\" : \"abc\", \n    \"value1\" : 25, \n    \"value2\" : \"test\", \n    \"allowed\" : true \n  }, \n  { \n    \"_key\" : \"foo\", \n    \"name\" : \"baz\" \n  }, \n  { \n    \"name\" : { \n      \"detailed\" : \"detailed name\", \n      \"short\" : \"short name\" \n    } \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing documents from individual JSON lines\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\",\"allowed\": true }\n{ \"_key\": \"foo\", \"name\": \"baz\" }\n\n{ \"name\": { \"detailed\": \"detailed name\", \"short\": \"short name\" } }\n\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 1, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Using the auto type detection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=auto <<EOF\n[ \n  { \n    \"_key\" : \"abc\", \n    \"value1\" : 25, \n    \"value2\" : \"test\", \n    \"allowed\" : true \n  }, \n  { \n    \"_key\" : \"foo\", \n    \"name\" : \"baz\" \n  }, \n  { \n    \"name\" : { \n      \"detailed\" : \"detailed name\", \n      \"short\" : \"short name\" \n    } \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, with attributes `_from`, `_to` and `name`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&type=documents <<EOF\n{ \"_from\": \"products/123\", \"_to\": \"products/234\" }\n{\"_from\": \"products/332\", \"_to\": \"products/abc\",   \"name\": \"other name\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, omitting `_from` or `_to`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&type=list&details=true <<EOF\n[ \n  { \n    \"name\" : \"some name\" \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 0, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"some name\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, but allow partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents&details=true <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\" }\n{ \"_key\": \"abc\", \"value1\": \"bar\", \"value2\": \"baz\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 1, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 2: creating document failed with error 'unique constraint violated', offending document: {\\\"_key\\\":\\\"abc\\\",\\\"value1\\\":\\\"bar\\\",\\\"value2\\\":\\\"baz\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, not allowing partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents&complete=true <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\" }\n{ \"_key\": \"abc\", \"value1\": \"bar\", \"value2\": \"baz\" }\nEOF\n\nHTTP/1.1 409 Conflict\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cannot create document, unique constraint violated\", \n  \"code\" : 409, \n  \"errorNum\" : 1210 \n}\n
\n\n\n\n\n#Example:\n Using a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents <<EOF\n{ \"name\": \"test\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Using a malformed body\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=list <<EOF\n{ }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting a JSON array in the request\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates documents in the collection identified by `collection-name`.\nThe JSON representations of the documents must be passed as the body of the\nPOST request. The request body can either consist of multiple lines, with\neach line being a single stand-alone JSON object, or a singe JSON array with\nsub-objects.\n\nThe response is a JSON object with the following attributes:\n\n- `created`: number of documents imported.\n\n- `errors`: number of documents that were not imported due to an error.\n\n- `empty`: number of empty lines found in the input (will only contain a\n value greater zero for types `documents` or `auto`).\n\n- `updated`: number of updated/replaced documents (in case `onDuplicate`\n was set to either `update` or `replace`).\n\n- `ignored`: number of failed but ignored insert operations (in case\n `onDuplicate` was set to `ignore`).\n\n- `details`: if query parameter `details` is set to true, the result will\n contain a `details` attribute which is an array with more detailed\n information about which documents could not be inserted.\n\nNote: this API is currently not supported on cluster coordinators.\n\n\n\n\n#Example:\n Importing documents with heterogenous attributes from a JSON array\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=list <<EOF\n[ \n  { \n    \"_key\" : \"abc\", \n    \"value1\" : 25, \n    \"value2\" : \"test\", \n    \"allowed\" : true \n  }, \n  { \n    \"_key\" : \"foo\", \n    \"name\" : \"baz\" \n  }, \n  { \n    \"name\" : { \n      \"detailed\" : \"detailed name\", \n      \"short\" : \"short name\" \n    } \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing documents from individual JSON lines\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\",\"allowed\": true }\n{ \"_key\": \"foo\", \"name\": \"baz\" }\n\n{ \"name\": { \"detailed\": \"detailed name\", \"short\": \"short name\" } }\n\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 1, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Using the auto type detection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=auto <<EOF\n[ \n  { \n    \"_key\" : \"abc\", \n    \"value1\" : 25, \n    \"value2\" : \"test\", \n    \"allowed\" : true \n  }, \n  { \n    \"_key\" : \"foo\", \n    \"name\" : \"baz\" \n  }, \n  { \n    \"name\" : { \n      \"detailed\" : \"detailed name\", \n      \"short\" : \"short name\" \n    } \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 3, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, with attributes `_from`, `_to` and `name`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&type=documents <<EOF\n{ \"_from\": \"products/123\", \"_to\": \"products/234\" }\n{\"_from\": \"products/332\", \"_to\": \"products/abc\",   \"name\": \"other name\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 2, \n  \"errors\" : 0, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0 \n}\n
\n\n\n\n\n#Example:\n Importing into an edge collection, omitting `_from` or `_to`\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=links&type=list&details=true <<EOF\n[ \n  { \n    \"name\" : \"some name\" \n  } \n]\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 0, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: missing '_from' or '_to' attribute, offending document: {\\\"name\\\":\\\"some name\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, but allow partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents&details=true <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\" }\n{ \"_key\": \"abc\", \"value1\": \"bar\", \"value2\": \"baz\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"created\" : 1, \n  \"errors\" : 1, \n  \"empty\" : 0, \n  \"updated\" : 0, \n  \"ignored\" : 0, \n  \"details\" : [ \n    \"at position 1: creating document failed with error 'unique constraint violated', offending document: {\\\"_key\\\":\\\"abc\\\",\\\"value1\\\":\\\"bar\\\",\\\"value2\\\":\\\"baz\\\"}\" \n  ] \n}\n
\n\n\n\n\n#Example:\n Violating a unique constraint, not allowing partial imports\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents&complete=true <<EOF\n{ \"_key\": \"abc\", \"value1\": 25, \"value2\": \"test\" }\n{ \"_key\": \"abc\", \"value1\": \"bar\", \"value2\": \"baz\" }\nEOF\n\nHTTP/1.1 409 Conflict\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cannot create document, unique constraint violated\", \n  \"code\" : 409, \n  \"errorNum\" : 1210 \n}\n
\n\n\n\n\n#Example:\n Using a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=documents <<EOF\n{ \"name\": \"test\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Using a malformed body\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/import?collection=products&type=list <<EOF\n{ }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting a JSON array in the request\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The body must either be a JSON-encoded array of objects or a string with\nmultiple JSON objects separated by newlines.\n\n", @@ -4922,12 +5004,12 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md" } }, "/_api/index": { "get": { - "description": "\n\n\nReturns an object with an attribute *indexes* containing an array of all\nindex descriptions for the given collection. The same information is also\navailable in the *identifiers* as an object with the index handles as\nkeys.\n\n\n\n\n#Example:\n Return information about all indexes\n\n
shell> curl --dump - http://localhost:8529/_api/index?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"indexes\" : [ \n    { \n      \"id\" : \"products/0\", \n      \"type\" : \"primary\", \n      \"fields\" : [ \n        \"_key\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : true, \n      \"sparse\" : false \n    }, \n    { \n      \"id\" : \"products/10859\", \n      \"type\" : \"hash\", \n      \"fields\" : [ \n        \"name\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : false, \n      \"sparse\" : false \n    }, \n    { \n      \"id\" : \"products/10862\", \n      \"type\" : \"skiplist\", \n      \"fields\" : [ \n        \"price\" \n      ], \n      \"unique\" : false, \n      \"sparse\" : true \n    } \n  ], \n  \"identifiers\" : { \n    \"products/0\" : { \n      \"id\" : \"products/0\", \n      \"type\" : \"primary\", \n      \"fields\" : [ \n        \"_key\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : true, \n      \"sparse\" : false \n    }, \n    \"products/10859\" : { \n      \"id\" : \"products/10859\", \n      \"type\" : \"hash\", \n      \"fields\" : [ \n        \"name\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : false, \n      \"sparse\" : false \n    }, \n    \"products/10862\" : { \n      \"id\" : \"products/10862\", \n      \"type\" : \"skiplist\", \n      \"fields\" : [ \n        \"price\" \n      ], \n      \"unique\" : false, \n      \"sparse\" : true \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\n\nReturns an object with an attribute *indexes* containing an array of all\nindex descriptions for the given collection. The same information is also\navailable in the *identifiers* as an object with the index handles as\nkeys.\n\n\n\n\n#Example:\n Return information about all indexes\n\n
shell> curl --dump - http://localhost:8529/_api/index?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"indexes\" : [ \n    { \n      \"id\" : \"products/0\", \n      \"type\" : \"primary\", \n      \"fields\" : [ \n        \"_key\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : true, \n      \"sparse\" : false \n    }, \n    { \n      \"id\" : \"products/10200\", \n      \"type\" : \"hash\", \n      \"fields\" : [ \n        \"name\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : false, \n      \"sparse\" : false \n    }, \n    { \n      \"id\" : \"products/10203\", \n      \"type\" : \"skiplist\", \n      \"fields\" : [ \n        \"price\" \n      ], \n      \"unique\" : false, \n      \"sparse\" : true \n    } \n  ], \n  \"identifiers\" : { \n    \"products/0\" : { \n      \"id\" : \"products/0\", \n      \"type\" : \"primary\", \n      \"fields\" : [ \n        \"_key\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : true, \n      \"sparse\" : false \n    }, \n    \"products/10200\" : { \n      \"id\" : \"products/10200\", \n      \"type\" : \"hash\", \n      \"fields\" : [ \n        \"name\" \n      ], \n      \"selectivityEstimate\" : 1, \n      \"unique\" : false, \n      \"sparse\" : false \n    }, \n    \"products/10203\" : { \n      \"id\" : \"products/10203\", \n      \"type\" : \"skiplist\", \n      \"fields\" : [ \n        \"price\" \n      ], \n      \"unique\" : false, \n      \"sparse\" : true \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", @@ -4947,12 +5029,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index#fulltext": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **fields**: an array of attribute names. Currently, the array is limited\n to exactly one attribute. of type string\n - **type**: must be equal to *\"fulltext\"*.\n - **minLength**: Minimum character length of words to index. Will default\n to a server-defined value if unspecified. It is thus recommended to set\n this value explicitly when creating the index.\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a fulltext index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\n\n\n\n#Example:\n Creating a fulltext index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"fulltext\", \n  \"fields\" : [ \n    \"text\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10881\", \n  \"type\" : \"fulltext\", \n  \"fields\" : [ \n    \"text\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"minLength\" : 2, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute names. Currently, the array is limited\n to exactly one attribute. - **type**: must be equal to *\"fulltext\"*.\n - **minLength**: Minimum character length of words to index. Will default\n to a server-defined value if unspecified. It is thus recommended to set\n this value explicitly when creating the index.\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a fulltext index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\n\n\n\n#Example:\n Creating a fulltext index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"fulltext\", \n  \"fields\" : [ \n    \"text\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10222\", \n  \"type\" : \"fulltext\", \n  \"fields\" : [ \n    \"text\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"minLength\" : 2, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", @@ -4987,7 +5069,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index#general": { @@ -5032,12 +5114,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index#geo": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **fields**: An array with one or two attribute paths.\n If it is an array with one attribute path *location*, then a geo-spatial\n index on all documents is created using *location* as path to the\n coordinates. The value of the attribute must be an array with at least two\n double values. The array must contain the latitude (first value) and the\n longitude (second value). All documents, which do not have the attribute\n path or with value that are not suitable, are ignored.\n If it is an array with two attribute paths *latitude* and *longitude*,\n then a geo-spatial index on all documents is created using *latitude*\n and *longitude* as paths the latitude and the longitude. The value of\n the attribute *latitude* and of the attribute *longitude* must a\n double. All documents, which do not have the attribute paths or which\n values are not suitable, are ignored. of type string\n - **type**: must be equal to *\"geo\"*.\n - **geoJson**: If a geo-spatial index on a *location* is constructed\n and *geoJson* is *true*, then the order within the array is longitude\n followed by latitude. This corresponds to the format described in\n http://geojson.org/geojson-spec.html#positions\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a geo-spatial index in the collection *collection-name*, if\nit does not already exist. Expects an object containing the index details.\n\nGeo indexes are always sparse, meaning that documents that do not contain\nthe index attributes or have non-numeric values in the index attributes\nwill not be indexed.\n\n\n\n\n#Example:\n Creating a geo index with a location attribute\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"geo\", \n  \"fields\" : [ \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10875\", \n  \"type\" : \"geo1\", \n  \"fields\" : [ \n    \"b\" \n  ], \n  \"geoJson\" : false, \n  \"constraint\" : false, \n  \"unique\" : false, \n  \"ignoreNull\" : true, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a geo index with latitude and longitude attributes\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"geo\", \n  \"fields\" : [ \n    \"e\", \n    \"f\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10869\", \n  \"type\" : \"geo2\", \n  \"fields\" : [ \n    \"e\", \n    \"f\" \n  ], \n  \"constraint\" : false, \n  \"unique\" : false, \n  \"ignoreNull\" : true, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **fields** (string): An array with one or two attribute paths.\n If it is an array with one attribute path *location*, then a geo-spatial\n index on all documents is created using *location* as path to the\n coordinates. The value of the attribute must be an array with at least two\n double values. The array must contain the latitude (first value) and the\n longitude (second value). All documents, which do not have the attribute\n path or with value that are not suitable, are ignored.\n If it is an array with two attribute paths *latitude* and *longitude*,\n then a geo-spatial index on all documents is created using *latitude*\n and *longitude* as paths the latitude and the longitude. The value of\n the attribute *latitude* and of the attribute *longitude* must a\n double. All documents, which do not have the attribute paths or which\n values are not suitable, are ignored. - **type**: must be equal to *\"geo\"*.\n - **geoJson**: If a geo-spatial index on a *location* is constructed\n and *geoJson* is *true*, then the order within the array is longitude\n followed by latitude. This corresponds to the format described in\n http://geojson.org/geojson-spec.html#positions\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a geo-spatial index in the collection *collection-name*, if\nit does not already exist. Expects an object containing the index details.\n\nGeo indexes are always sparse, meaning that documents that do not contain\nthe index attributes or have non-numeric values in the index attributes\nwill not be indexed.\n\n\n\n\n#Example:\n Creating a geo index with a location attribute\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"geo\", \n  \"fields\" : [ \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10216\", \n  \"type\" : \"geo1\", \n  \"fields\" : [ \n    \"b\" \n  ], \n  \"geoJson\" : false, \n  \"constraint\" : false, \n  \"unique\" : false, \n  \"ignoreNull\" : true, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a geo index with latitude and longitude attributes\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"geo\", \n  \"fields\" : [ \n    \"e\", \n    \"f\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10210\", \n  \"type\" : \"geo2\", \n  \"fields\" : [ \n    \"e\", \n    \"f\" \n  ], \n  \"constraint\" : false, \n  \"unique\" : false, \n  \"ignoreNull\" : true, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n\n", @@ -5072,12 +5154,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index#hash": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **fields**: an array of attribute paths. of type string\n - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"hash\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a hash index for the collection *collection-name* if it\ndoes not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating an unique constraint\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : true, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10905\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : true, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a non-unique hash index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10887\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10911\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute paths. - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"hash\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n**NOTE** Swagger examples won't work due to the anchor.\n\n\nCreates a hash index for the collection *collection-name* if it\ndoes not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating an unique constraint\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : true, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10246\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : true, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a non-unique hash index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10228\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"hash\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10252\", \n  \"type\" : \"hash\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", @@ -5115,12 +5197,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index#persistent": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **fields**: an array of attribute paths. of type string\n - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"persistent\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n\nCreates a persistent index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating a persistent index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"persistent\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10893\", \n  \"type\" : \"persistent\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse persistent index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"persistent\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10917\", \n  \"type\" : \"persistent\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute paths. - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"persistent\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n\nCreates a persistent index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating a persistent index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"persistent\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10234\", \n  \"type\" : \"persistent\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse persistent index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"persistent\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10258\", \n  \"type\" : \"persistent\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", @@ -5158,12 +5240,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index#skiplist": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **fields**: an array of attribute paths. of type string\n - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"skiplist\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n\nCreates a skip-list index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating a skiplist index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"skiplist\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10899\", \n  \"type\" : \"skiplist\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse skiplist index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"skiplist\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10923\", \n  \"type\" : \"skiplist\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **fields** (string): an array of attribute paths. - **unique**: if *true*, then create a unique index.\n - **type**: must be equal to *\"skiplist\"*.\n - **sparse**: if *true*, then create a sparse index.\n\n\n\n\n\nCreates a skip-list index for the collection *collection-name*, if\nit does not already exist. The call expects an object containing the index\ndetails.\n\nIn a sparse index all documents will be excluded from the index that do not \ncontain at least one of the specified index attributes (i.e. *fields*) or that \nhave a value of *null* in any of the specified index attributes. Such documents \nwill not be indexed, and not be taken into account for uniqueness checks if\nthe *unique* flag is set.\n\nIn a non-sparse index, these documents will be indexed (for non-present\nindexed attributes, a value of *null* will be used) and will be taken into\naccount for uniqueness checks if the *unique* flag is set.\n\n**Note**: unique indexes on non-shard keys are not supported in a cluster.\n\n\n\n\n#Example:\n Creating a skiplist index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"skiplist\", \n  \"unique\" : false, \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10240\", \n  \"type\" : \"skiplist\", \n  \"fields\" : [ \n    \"a\", \n    \"b\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : false, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Creating a sparse skiplist index\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/index?collection=products <<EOF\n{ \n  \"type\" : \"skiplist\", \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"fields\" : [ \n    \"a\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10264\", \n  \"type\" : \"skiplist\", \n  \"fields\" : [ \n    \"a\" \n  ], \n  \"unique\" : false, \n  \"sparse\" : true, \n  \"isNewlyCreated\" : true, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The collection name.\n\n", @@ -5201,12 +5283,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/index/{index-handle}": { "delete": { - "description": "\n\n\nDeletes an index with *index-handle*.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/index/products/10929\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10929\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\n\nDeletes an index with *index-handle*.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/index/products/10270\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"products/10270\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The index handle.\n\n", @@ -5230,7 +5312,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" }, "get": { "description": "\n\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\n\n{ \n  \"id\" : \"products/0\", \n  \"type\" : \"primary\", \n  \"fields\" : [ \n    \"_key\" \n  ], \n  \"selectivityEstimate\" : 1, \n  \"unique\" : true, \n  \"sparse\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -5257,12 +5339,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md" + "x-filename": "Indexes - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md" } }, "/_api/job/{job-id}": { "get": { - "description": "\n\nReturns the processing status of the specified job. The processing status\ncan be\ndetermined by peeking into the HTTP response code of the response.\n\n\n\n\n#Example:\n Querying the status of a done job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456627\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/146616904456627\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 146616904456627\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.x-devel\" \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 --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456631\n\nshell> curl --dump - http://localhost:8529/_api/job/146616904456631\n\nHTTP/1.1 204 No Content\ncontent-type: text/plain; charset=utf-8\n\n
\n\n\n\n\n", + "description": "\n\nReturns the processing status of the specified job. The processing status\ncan be\ndetermined by peeking into the HTTP response code of the response.\n\n\n\n\n#Example:\n Querying the status of a done job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037597\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/147153131037597\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 147153131037597\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.devel\" \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 --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037601\n\nshell> curl --dump - http://localhost:8529/_api/job/147153131037601\n\nHTTP/1.1 204 No Content\ncontent-type: text/plain; charset=utf-8\n\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", @@ -5289,10 +5371,10 @@ "job" ], "x-examples": [], - "x-filename": "job - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" + "x-filename": "job - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.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\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\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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456606\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/146616904456606\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 146616904456606\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.x-devel\" \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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456610\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/146616904456610\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 146616904456610\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 400, \n  \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\" \n}\n
\n\n\n\n\n", + "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\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\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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037576\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/147153131037576\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 147153131037576\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.devel\" \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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037580\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/147153131037580\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 147153131037580\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 400, \n  \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", @@ -5319,12 +5401,12 @@ "job" ], "x-examples": [], - "x-filename": "job - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" + "x-filename": "job - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" } }, "/_api/job/{job-id}/cancel": { "put": { - "description": "\n\nCancels the currently running job identified by job-id. Note that it still\nmight take some time to actually cancel the running async job.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 FOR j IN 1..10 LET x = sleep(1.0) FILTER i == 5 && j == 5 RETURN 42\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456579\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"146616904456579\" \n]\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/146616904456579/cancel\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"146616904456579\" \n]\n
\n\n\n\n\n", + "description": "\n\nCancels the currently running job identified by job-id. Note that it still\nmight take some time to actually cancel the running async job.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR i IN 1..10 FOR j IN 1..10 LET x = sleep(1.0) FILTER i == 5 && j == 5 RETURN 42\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037549\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"147153131037549\" \n]\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/147153131037549/cancel\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"147153131037549\" \n]\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", @@ -5351,12 +5433,12 @@ "job" ], "x-examples": [], - "x-filename": "job - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" + "x-filename": "job - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" } }, "/_api/job/{type}": { "delete": { - "description": "\n\nDeletes either all job results, expired job results, or the result of a\nspecific job.\nClients can use this method to perform an eventual garbage collection of job\nresults.\n\n\n\n\n#Example:\n Deleting all jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456585\n\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/all\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Deleting expired jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456589\n\nshell> curl --dump - http://localhost:8529/_admin/time\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"time\" : 1466169062.076769, \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/expired?stamp=1466169062.076769\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ ]\n
\n\n\n\n\n#Example:\n Deleting the result of a specific job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456596\n\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/146616904456596\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Deleting the result of a non-existing job:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/job/AreYouThere\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"code\" : 404, \n  \"errorNum\" : 404 \n}\n
\n\n\n\n\n", + "description": "\n\nDeletes either all job results, expired job results, or the result of a\nspecific job.\nClients can use this method to perform an eventual garbage collection of job\nresults.\n\n\n\n\n#Example:\n Deleting all jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037555\n\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/all\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Deleting expired jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037559\n\nshell> curl --dump - http://localhost:8529/_admin/time\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"time\" : 1471531316.30896, \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/expired?stamp=1471531316.30896\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ ]\n
\n\n\n\n\n#Example:\n Deleting the result of a specific job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037566\n\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/147153131037566\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Deleting the result of a non-existing job:\n\n
shell> curl -X DELETE --dump - http://localhost:8529/_api/job/AreYouThere\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"code\" : 404, \n  \"errorNum\" : 404 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The type of jobs to delete. type can be:\n* *all*: Deletes all jobs results. Currently executing or queued async \n jobs will not be stopped by this call.\n* *expired*: Deletes expired results. To determine the expiration status of a \n result, pass the stamp query parameter. stamp needs to be a UNIX timestamp, \n and all async job results created at a lower timestamp will be deleted.\n* *an actual job-id*: In this case, the call will remove the result of the\n specified async job. If the job is currently executing or queued, it will\n not be aborted.\n\n", @@ -5383,10 +5465,10 @@ "job" ], "x-examples": [], - "x-filename": "job - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" + "x-filename": "job - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456614\n\nshell> curl --dump - http://localhost:8529/_api/job/done\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"146616904456614\" \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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456618\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\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 --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 146616904456622\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"146616904456622\" \n]\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/146616904456622\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n", + "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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037584\n\nshell> curl --dump - http://localhost:8529/_api/job/done\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"147153131037584\" \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\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037588\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\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 --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-arango-async-id: 147153131037592\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  \"147153131037592\" \n]\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/147153131037592\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The type of jobs to return. The type can be either done or pending. Setting\nthe type to done will make the method return the ids of already completed\nasync\njobs for which results can be fetched. Setting the type to pending will\nreturn\nthe ids of not yet finished async jobs.\n\n", @@ -5410,7 +5492,7 @@ "job" ], "x-examples": [], - "x-filename": "job - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" + "x-filename": "job - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" } }, "/_api/query": { @@ -5440,7 +5522,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/query-cache": { @@ -5460,7 +5542,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/query-cache/properties": { @@ -5480,7 +5562,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.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**A json post document 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", @@ -5508,7 +5590,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/query/current": { @@ -5528,7 +5610,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/query/properties": { @@ -5548,7 +5630,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "put": { "description": "**A json post document with these Properties is required:**\n\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 - **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 - **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 - **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\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", @@ -5576,7 +5658,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/query/slow": { @@ -5596,7 +5678,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" }, "get": { "description": "\n\nReturns an array containing the last AQL queries that exceeded the slow\nquery 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- *started*: the date and time when the query was started\n\n- *runTime*: the query's run time up to the point the list of queries was\n queried\n\n", @@ -5614,7 +5696,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/query/{query-id}": { @@ -5646,7 +5728,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md" } }, "/_api/replication/applier-config": { @@ -5669,10 +5751,10 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "put": { - "description": "**A json post document 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**: the array of collections to include or exclude,\n based on the setting of *restrictType* of type string\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\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  \"sslProtocol\" : 0, \n  \"chunkSize\" : 4194304, \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  \"useCollectionId\" : true, \n  \"restrictType\" : \"\", \n  \"restrictCollections\" : [ ], \n  \"connectionRetryWaitTime\" : 15, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"idleMinWaitTime\" : 1, \n  \"idleMaxWaitTime\" : 2.5 \n}\n
\n\n\n\n\n", + "description": "**A json post document 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* - **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\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  \"sslProtocol\" : 0, \n  \"chunkSize\" : 4194304, \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  \"useCollectionId\" : true, \n  \"restrictType\" : \"\", \n  \"restrictCollections\" : [ ], \n  \"connectionRetryWaitTime\" : 15, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"idleMinWaitTime\" : 1, \n  \"idleMaxWaitTime\" : 2.5 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -5703,12 +5785,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/applier-start": { "put": { - "description": "\n\nStarts the replication applier. This will return immediately if the\nreplication applier is already running.\n\nIf the replication applier is not already running, the applier configuration\nwill be checked, and if it is complete, the applier will be started in a\nbackground thread. This means that even if the applier will encounter any\nerrors while running, they will not be reported in the response to this\nmethod.\n\nTo detect replication applier errors after the applier was started, use the\n*/_api/replication/applier-state* API instead.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-start\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-06-17T13:10:44Z\", \n      \"message\" : \"applier initially created\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 0 \n    }, \n    \"time\" : \"2016-06-17T13:11:54Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.x-devel\", \n    \"serverId\" : \"29298867422456\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", + "description": "\n\nStarts the replication applier. This will return immediately if the\nreplication applier is already running.\n\nIf the replication applier is not already running, the applier configuration\nwill be checked, and if it is complete, the applier will be started in a\nbackground thread. This means that even if the applier will encounter any\nerrors while running, they will not be reported in the response to this\nmethod.\n\nTo detect replication applier errors after the applier was started, use the\n*/_api/replication/applier-state* API instead.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-start\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-08-18T14:41:50Z\", \n      \"message\" : \"applier initially created\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 0 \n    }, \n    \"time\" : \"2016-08-18T14:42:29Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.devel\", \n    \"serverId\" : \"92109534963517\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The remote *lastLogTick* value from which to start applying. If not specified,\nthe last saved tick from the previous applier run is used. If there is no\nprevious applier state saved, the applier will start at the beginning of the\nlogger server's log.\n\n", @@ -5737,12 +5819,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/applier-state": { "get": { - "description": "\n\nReturns the state of the replication applier, regardless of whether the\napplier is currently running or not.\n\nThe response is a JSON object with the following attributes:\n\n- *state*: a JSON object with the following sub-attributes:\n\n - *running*: whether or not the applier is active and running\n\n - *lastAppliedContinuousTick*: the last tick value from the continuous\n replication log the applier has applied.\n\n - *lastProcessedContinuousTick*: the last tick value from the continuous\n replication log the applier has processed.\n\n Regularly, the last applied and last processed tick values should be\n identical. For transactional operations, the replication applier will first\n process incoming log events before applying them, so the processed tick\n value might be higher than the applied tick value. This will be the case\n until the applier encounters the *transaction commit* log event for the\n transaction.\n\n - *lastAvailableContinuousTick*: the last tick value the logger server can\n provide.\n\n - *time*: the time on the applier server.\n\n - *totalRequests*: the total number of requests the applier has made to the\n endpoint.\n\n - *totalFailedConnects*: the total number of failed connection attempts the\n applier has made.\n\n - *totalEvents*: the total number of log events the applier has processed.\n\n - *totalOperationsExcluded*: the total number of log events excluded because\n of *restrictCollections*.\n\n - *progress*: a JSON object with details about the replication applier progress.\n It contains the following sub-attributes if there is progress to report:\n\n - *message*: a textual description of the progress\n\n - *time*: the date and time the progress was logged\n\n - *failedConnects*: the current number of failed connection attempts\n\n - *lastError*: a JSON object with details about the last error that happened on\n the applier. It contains the following sub-attributes if there was an error:\n\n - *errorNum*: a numerical error code\n\n - *errorMessage*: a textual error description\n\n - *time*: the date and time the error occurred\n\n In case no error has occurred, *lastError* will be empty.\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the applier server's version\n\n - *serverId*: the applier server's id\n\n- *endpoint*: the endpoint the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n- *database*: the name of the database the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n\n\n\n#Example:\n Fetching the state of an inactive applier:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : false, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-06-17T13:11:54Z\", \n      \"message\" : \"applier shut down\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 1402, \n      \"time\" : \"2016-06-17T13:11:54Z\", \n      \"errorMessage\" : \"got invalid response from master at tcp://127.0.0.1:8529: HTTP 401: Unauthorized\" \n    }, \n    \"time\" : \"2016-06-17T13:11:54Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.x-devel\", \n    \"serverId\" : \"29298867422456\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n#Example:\n Fetching the state of an active applier:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-06-17T13:11:54Z\", \n      \"message\" : \"applier shut down\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 0 \n    }, \n    \"time\" : \"2016-06-17T13:11:54Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.x-devel\", \n    \"serverId\" : \"29298867422456\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", + "description": "\n\nReturns the state of the replication applier, regardless of whether the\napplier is currently running or not.\n\nThe response is a JSON object with the following attributes:\n\n- *state*: a JSON object with the following sub-attributes:\n\n - *running*: whether or not the applier is active and running\n\n - *lastAppliedContinuousTick*: the last tick value from the continuous\n replication log the applier has applied.\n\n - *lastProcessedContinuousTick*: the last tick value from the continuous\n replication log the applier has processed.\n\n Regularly, the last applied and last processed tick values should be\n identical. For transactional operations, the replication applier will first\n process incoming log events before applying them, so the processed tick\n value might be higher than the applied tick value. This will be the case\n until the applier encounters the *transaction commit* log event for the\n transaction.\n\n - *lastAvailableContinuousTick*: the last tick value the logger server can\n provide.\n\n - *time*: the time on the applier server.\n\n - *totalRequests*: the total number of requests the applier has made to the\n endpoint.\n\n - *totalFailedConnects*: the total number of failed connection attempts the\n applier has made.\n\n - *totalEvents*: the total number of log events the applier has processed.\n\n - *totalOperationsExcluded*: the total number of log events excluded because\n of *restrictCollections*.\n\n - *progress*: a JSON object with details about the replication applier progress.\n It contains the following sub-attributes if there is progress to report:\n\n - *message*: a textual description of the progress\n\n - *time*: the date and time the progress was logged\n\n - *failedConnects*: the current number of failed connection attempts\n\n - *lastError*: a JSON object with details about the last error that happened on\n the applier. It contains the following sub-attributes if there was an error:\n\n - *errorNum*: a numerical error code\n\n - *errorMessage*: a textual error description\n\n - *time*: the date and time the error occurred\n\n In case no error has occurred, *lastError* will be empty.\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the applier server's version\n\n - *serverId*: the applier server's id\n\n- *endpoint*: the endpoint the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n- *database*: the name of the database the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n\n\n\n#Example:\n Fetching the state of an inactive applier:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : false, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-08-18T14:42:29Z\", \n      \"message\" : \"applier shut down\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 1402, \n      \"time\" : \"2016-08-18T14:42:29Z\", \n      \"errorMessage\" : \"got invalid response from master at tcp://127.0.0.1:8529: HTTP 401: Unauthorized\" \n    }, \n    \"time\" : \"2016-08-18T14:42:29Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.devel\", \n    \"serverId\" : \"92109534963517\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n#Example:\n Fetching the state of an active applier:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/applier-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-08-18T14:42:29Z\", \n      \"message\" : \"applier shut down\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 0 \n    }, \n    \"time\" : \"2016-08-18T14:42:29Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.devel\", \n    \"serverId\" : \"92109534963517\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -5760,12 +5842,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/applier-stop": { "put": { - "description": "\n\nStops the replication applier. This will return immediately if the\nreplication applier is not running.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-stop\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : false, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-06-17T13:11:55Z\", \n      \"message\" : \"fetching master state information\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 1402, \n      \"time\" : \"2016-06-17T13:11:55Z\", \n      \"errorMessage\" : \"got invalid response from master at tcp://127.0.0.1:8529: HTTP 401: Unauthorized\" \n    }, \n    \"time\" : \"2016-06-17T13:11:55Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.x-devel\", \n    \"serverId\" : \"29298867422456\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", + "description": "\n\nStops the replication applier. This will return immediately if the\nreplication applier is not running.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/replication/applier-stop\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : false, \n    \"lastAppliedContinuousTick\" : null, \n    \"lastProcessedContinuousTick\" : null, \n    \"lastAvailableContinuousTick\" : null, \n    \"safeResumeTick\" : null, \n    \"progress\" : { \n      \"time\" : \"2016-08-18T14:42:29Z\", \n      \"message\" : \"fetching master state information\", \n      \"failedConnects\" : 0 \n    }, \n    \"totalRequests\" : 0, \n    \"totalFailedConnects\" : 0, \n    \"totalEvents\" : 0, \n    \"totalOperationsExcluded\" : 0, \n    \"lastError\" : { \n      \"errorNum\" : 1402, \n      \"time\" : \"2016-08-18T14:42:29Z\", \n      \"errorMessage\" : \"got invalid response from master at tcp://127.0.0.1:8529: HTTP 401: Unauthorized\" \n    }, \n    \"time\" : \"2016-08-18T14:42:29Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.devel\", \n    \"serverId\" : \"92109534963517\" \n  }, \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\" \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -5783,7 +5865,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/batch": { @@ -5816,7 +5898,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/batch/{id}": { @@ -5848,7 +5930,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" }, "put": { "description": "**A json post document 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", @@ -5887,7 +5969,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/clusterInventory": { @@ -5918,12 +6000,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/dump": { "get": { - "description": "\n\nReturns the data from the collection for the requested range.\n\nWhen the *from* query parameter is not used, collection events are returned from\nthe beginning. When the *from* parameter is used, the result will only contain\ncollection entries which have higher tick values than the specified *from* value\n(note: the log entry with a tick value equal to *from* will be excluded).\n\nThe *to* query parameter can be used to optionally restrict the upper bound of\nthe result to a certain tick value. If used, the result will only contain\ncollection entries with tick values up to (including) *to*.\n\nThe *chunkSize* query parameter can be used to control the size of the result.\nIt must be specified in bytes. The *chunkSize* value will only be honored\napproximately. Otherwise a too low *chunkSize* value could cause the server\nto not be able to put just one entry into the result and return it.\nTherefore, the *chunkSize* value will only be consulted after an entry has\nbeen written into the result. If the result size is then bigger than\n*chunkSize*, the server will respond with as many entries as there are\nin the response already. If the result size is still smaller than *chunkSize*,\nthe server will try to return more data if there's more data left to return.\n\nIf *chunkSize* is not specified, some server-side default value will be used.\n\nThe *Content-Type* of the result is *application/x-arango-dump*. This is an\neasy-to-process format, with all entries going onto separate lines in the\nresponse body.\n\nEach line itself is a JSON object, with at least the following attributes:\n\n- *tick*: the operation's tick attribute\n\n- *key*: the key of the document/edge or the key used in the deletion operation\n\n- *rev*: the revision id of the document/edge or the deletion operation\n\n- *data*: the actual document/edge data for types 2300 and 2301. The full\n document/edge data will be returned even for updates.\n\n- *type*: the type of entry. Possible values for *type* are:\n\n - 2300: document insertion/update\n\n - 2301: edge insertion/update\n\n - 2302: document/edge deletion\n\n**Note**: there will be no distinction between inserts and updates when calling this method.\n\n\n\n\n#Example:\n Empty collection:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\n\n
\n\n\n\n\n#Example:\n Non-empty collection:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 10970\n\n\"{\\\"tick\\\":\\\"10961\\\",\\\"type\\\":2300,\\\"data\\\":{\\\"_id\\\":\\\"testCollection/123456\\\",\\\"_key\\\":\\\"123456\\\",\\\"_rev\\\":\\\"10960\\\",\\\"b\\\":1,\\\"c\\\":false,\\\"d\\\":\\\"additional value\\\"}}\\n{\\\"tick\\\":\\\"10967\\\",\\\"type\\\":2302,\\\"data\\\":{\\\"_key\\\":\\\"foobar\\\",\\\"_rev\\\":\\\"10966\\\"}}\\n{\\\"tick\\\":\\\"10970\\\",\\\"type\\\":2302,\\\"data\\\":{\\\"_key\\\":\\\"abcdef\\\",\\\"_rev\\\":\\\"10969\\\"}}\\n\"\n
\n\n\n\n\n", + "description": "\n\nReturns the data from the collection for the requested range.\n\nWhen the *from* query parameter is not used, collection events are returned from\nthe beginning. When the *from* parameter is used, the result will only contain\ncollection entries which have higher tick values than the specified *from* value\n(note: the log entry with a tick value equal to *from* will be excluded).\n\nThe *to* query parameter can be used to optionally restrict the upper bound of\nthe result to a certain tick value. If used, the result will only contain\ncollection entries with tick values up to (including) *to*.\n\nThe *chunkSize* query parameter can be used to control the size of the result.\nIt must be specified in bytes. The *chunkSize* value will only be honored\napproximately. Otherwise a too low *chunkSize* value could cause the server\nto not be able to put just one entry into the result and return it.\nTherefore, the *chunkSize* value will only be consulted after an entry has\nbeen written into the result. If the result size is then bigger than\n*chunkSize*, the server will respond with as many entries as there are\nin the response already. If the result size is still smaller than *chunkSize*,\nthe server will try to return more data if there's more data left to return.\n\nIf *chunkSize* is not specified, some server-side default value will be used.\n\nThe *Content-Type* of the result is *application/x-arango-dump*. This is an\neasy-to-process format, with all entries going onto separate lines in the\nresponse body.\n\nEach line itself is a JSON object, with at least the following attributes:\n\n- *tick*: the operation's tick attribute\n\n- *key*: the key of the document/edge or the key used in the deletion operation\n\n- *rev*: the revision id of the document/edge or the deletion operation\n\n- *data*: the actual document/edge data for types 2300 and 2301. The full\n document/edge data will be returned even for updates.\n\n- *type*: the type of entry. Possible values for *type* are:\n\n - 2300: document insertion/update\n\n - 2301: edge insertion/update\n\n - 2302: document/edge deletion\n\n**Note**: there will be no distinction between inserts and updates when calling this method.\n\n\n\n\n#Example:\n Empty collection:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-lastincluded: 0\nx-arango-replication-checkmore: false\n\n
\n\n\n\n\n#Example:\n Non-empty collection:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/dump?collection=testCollection\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-lastincluded: 10307\nx-arango-replication-checkmore: false\n\n\"{\\\"tick\\\":\\\"10301\\\",\\\"type\\\":2300,\\\"data\\\":{\\\"_id\\\":\\\"testCollection/123456\\\",\\\"_key\\\":\\\"123456\\\",\\\"_rev\\\":\\\"_Tn2Ybk2--A\\\",\\\"b\\\":1,\\\"c\\\":false,\\\"d\\\":\\\"additional value\\\"}}\\n{\\\"tick\\\":\\\"10305\\\",\\\"type\\\":2302,\\\"data\\\":{\\\"_key\\\":\\\"foobar\\\",\\\"_rev\\\":\\\"_Tn2Ybk6--_\\\"}}\\n{\\\"tick\\\":\\\"10307\\\",\\\"type\\\":2302,\\\"data\\\":{\\\"_key\\\":\\\"abcdef\\\",\\\"_rev\\\":\\\"_Tn2Ybk6--A\\\"}}\\n\"\n
\n\n\n\n\n", "parameters": [ { "description": "The name or id of the collection to dump.\n\n", @@ -6007,12 +6089,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/inventory": { "get": { - "description": "\n\nReturns the array of collections and indexes available on the server. This\narray can be used by replication clients to initiate an initial sync with the\nserver.\n\nThe response will contain a JSON object with the *collection* and *state* and\n*tick* attributes.\n\n*collections* is a array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: a array of the indexes of a the collection. Primary indexes and edges indexes\n are not included in this array.\n\nThe *state* attribute contains the current state of the replication logger. It\ncontains the following sub-attributes:\n\n- *running*: whether or not the replication logger is currently active. Note:\n since ArangoDB 2.2, the value will always be *true*\n\n- *lastLogTick*: the value of the last tick the replication logger has written\n\n- *time*: the current time on the server\n\nReplication clients should note the *lastLogTick* value returned. They can then\nfetch collections' data using the dump method up to the value of lastLogTick, and\nquery the continuous replication log for log events after this tick value.\n\nTo create a full copy of the collections on the server, a replication client\ncan execute these steps:\n\n- call the */inventory* API method. This returns the *lastLogTick* value and the\n array of collections and indexes from the server.\n\n- for each collection returned by */inventory*, create the collection locally and\n call */dump* to stream the collection data to the client, up to the value of\n *lastLogTick*.\n After that, the client can create the indexes on the collections as they were\n reported by */inventory*.\n\nIf the clients wants to continuously stream replication log events from the logger\nserver, the following additional steps need to be carried out:\n\n- the client should call */logger-follow* initially to fetch the first batch of\n replication events that were logged after the client's call to */inventory*.\n\n The call to */logger-follow* should use a *from* parameter with the value of the\n *lastLogTick* as reported by */inventory*. The call to */logger-follow* will return the\n *x-arango-replication-lastincluded* which will contain the last tick value included\n in the response.\n\n- the client can then continuously call */logger-follow* to incrementally fetch new\n replication events that occurred after the last transfer.\n\n Calls should use a *from* parameter with the value of the *x-arango-replication-lastincluded*\n header of the previous response. If there are no more replication events, the\n response will be empty and clients can go to sleep for a while and try again\n later.\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\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"cid\" : \"38\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_aqlfunctions\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"55\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_frontend\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"4\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_graphs\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"23\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_modules\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"25\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_routing\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"8\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_users\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"11\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"95\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"animals\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"89\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"demo\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11002\", \n    \"lastUncommittedLogTick\" : \"11006\", \n    \"totalEvents\" : 3768, \n    \"time\" : \"2016-06-17T13:12:17Z\" \n  }, \n  \"tick\" : \"11006\" \n}\n
\n\n\n\n\n#Example:\n With some additional indexes:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"cid\" : \"38\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_aqlfunctions\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"55\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_frontend\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"4\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_graphs\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"23\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_modules\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"25\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_routing\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"8\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_users\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"11\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"95\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"animals\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"89\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"demo\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"11007\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"IndexedCollection1\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"name\" \n          ], \n          \"id\" : \"11010\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : false, \n          \"type\" : \"hash\", \n          \"unique\" : false \n        }, \n        { \n          \"fields\" : [ \n            \"a\", \n            \"b\" \n          ], \n          \"id\" : \"11013\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"11015\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"IndexedCollection2\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"text\" \n          ], \n          \"id\" : \"11018\", \n          \"minLength\" : 10, \n          \"sparse\" : true, \n          \"type\" : \"fulltext\", \n          \"unique\" : false \n        }, \n        { \n          \"fields\" : [ \n            \"a\" \n          ], \n          \"id\" : \"11021\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : false \n        } \n      ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11011\", \n    \"lastUncommittedLogTick\" : \"11022\", \n    \"totalEvents\" : 3774, \n    \"time\" : \"2016-06-17T13:12:17Z\" \n  }, \n  \"tick\" : \"11022\" \n}\n
\n\n\n\n\n", + "description": "\n\nReturns the array of collections and indexes available on the server. This\narray can be used by replication clients to initiate an initial sync with the\nserver.\n\nThe response will contain a JSON object with the *collection* and *state* and\n*tick* attributes.\n\n*collections* is a array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: a array of the indexes of a the collection. Primary indexes and edges indexes\n are not included in this array.\n\nThe *state* attribute contains the current state of the replication logger. It\ncontains the following sub-attributes:\n\n- *running*: whether or not the replication logger is currently active. Note:\n since ArangoDB 2.2, the value will always be *true*\n\n- *lastLogTick*: the value of the last tick the replication logger has written\n\n- *time*: the current time on the server\n\nReplication clients should note the *lastLogTick* value returned. They can then\nfetch collections' data using the dump method up to the value of lastLogTick, and\nquery the continuous replication log for log events after this tick value.\n\nTo create a full copy of the collections on the server, a replication client\ncan execute these steps:\n\n- call the */inventory* API method. This returns the *lastLogTick* value and the\n array of collections and indexes from the server.\n\n- for each collection returned by */inventory*, create the collection locally and\n call */dump* to stream the collection data to the client, up to the value of\n *lastLogTick*.\n After that, the client can create the indexes on the collections as they were\n reported by */inventory*.\n\nIf the clients wants to continuously stream replication log events from the logger\nserver, the following additional steps need to be carried out:\n\n- the client should call */logger-follow* initially to fetch the first batch of\n replication events that were logged after the client's call to */inventory*.\n\n The call to */logger-follow* should use a *from* parameter with the value of the\n *lastLogTick* as reported by */inventory*. The call to */logger-follow* will return the\n *x-arango-replication-lastincluded* which will contain the last tick value included\n in the response.\n\n- the client can then continuously call */logger-follow* to incrementally fetch new\n replication events that occurred after the last transfer.\n\n Calls should use a *from* parameter with the value of the *x-arango-replication-lastincluded*\n header of the previous response. If there are no more replication events, the\n response will be empty and clients can go to sleep for a while and try again\n later.\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\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"cid\" : \"37\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_aqlfunctions\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"54\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_frontend\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"2\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_graphs\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"22\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_modules\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"24\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_routing\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"7\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_users\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"10\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"92\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"animals\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"87\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"demo\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"10342\", \n    \"lastUncommittedLogTick\" : \"10346\", \n    \"totalEvents\" : 3775, \n    \"time\" : \"2016-08-18T14:43:00Z\" \n  }, \n  \"tick\" : \"10346\" \n}\n
\n\n\n\n\n#Example:\n With some additional indexes:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"cid\" : \"37\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_aqlfunctions\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"54\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_frontend\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"2\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_graphs\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"22\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 1048576, \n        \"name\" : \"_modules\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"24\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_routing\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"7\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 4194304, \n        \"name\" : \"_users\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"10\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"92\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"animals\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"87\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"demo\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"10347\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"IndexedCollection1\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"name\" \n          ], \n          \"id\" : \"10350\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : false, \n          \"type\" : \"hash\", \n          \"unique\" : false \n        }, \n        { \n          \"fields\" : [ \n            \"a\", \n            \"b\" \n          ], \n          \"id\" : \"10353\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"cid\" : \"10355\", \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"indexBuckets\" : 8, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"maximalSize\" : 33554432, \n        \"name\" : \"IndexedCollection2\", \n        \"type\" : 2, \n        \"version\" : 5, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"text\" \n          ], \n          \"id\" : \"10358\", \n          \"minLength\" : 10, \n          \"sparse\" : true, \n          \"type\" : \"fulltext\", \n          \"unique\" : false \n        }, \n        { \n          \"fields\" : [ \n            \"a\" \n          ], \n          \"id\" : \"10361\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : false \n        } \n      ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"10342\", \n    \"lastUncommittedLogTick\" : \"10362\", \n    \"totalEvents\" : 3781, \n    \"time\" : \"2016-08-18T14:43:00Z\" \n  }, \n  \"tick\" : \"10362\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "Include system collections in the result. The default value is *true*.\n\n", @@ -6038,12 +6120,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/logger-first-tick": { "get": { - "description": "\n\nReturns the first available tick value that can be served from the server's\nreplication log. This method can be called by replication clients after to\ndetermine if certain data (identified by a tick value) is still available\nfor replication.\n\nThe result is a JSON object containing the attribute *firstTick*. This\nattribute contains the minimum tick value available in the server's\nreplication\nlog.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n\n\n\n#Example:\n Returning the first available tick\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-first-tick\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n\"{\\\"firstTick\\\":\\\"7\\\"}\"\n
\n\n\n\n\n", + "description": "\n\nReturns the first available tick value that can be served from the server's\nreplication log. This method can be called by replication clients after to\ndetermine if certain data (identified by a tick value) is still available\nfor replication.\n\nThe result is a JSON object containing the attribute *firstTick*. This\nattribute contains the minimum tick value available in the server's\nreplication\nlog.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n\n\n\n#Example:\n Returning the first available tick\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-first-tick\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n\"{\\\"firstTick\\\":\\\"6\\\"}\"\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -6064,12 +6146,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/logger-follow": { "get": { - "description": "\n\nReturns data from the server's replication log. This method can be called\nby replication clients after an initial synchronization of data. The method\nwill return all \"recent\" log entries from the logger server, and the clients\ncan replay and apply these entries locally so they get to the same data\nstate as the logger server.\n\nClients can call this method repeatedly to incrementally fetch all changes\nfrom the logger server. In this case, they should provide the *from* value so\nthey will only get returned the log events since their last fetch.\n\nWhen the *from* query parameter is not used, the logger server will return log\nentries starting at the beginning of its replication log. When the *from*\nparameter is used, the logger server will only return log entries which have\nhigher tick values than the specified *from* value (note: the log entry with a\ntick value equal to *from* will be excluded). Use the *from* value when\nincrementally fetching log data.\n\nThe *to* query parameter can be used to optionally restrict the upper bound of\nthe result to a certain tick value. If used, the result will contain only log events\nwith tick values up to (including) *to*. In incremental fetching, there is no\nneed to use the *to* parameter. It only makes sense in special situations,\nwhen only parts of the change log are required.\n\nThe *chunkSize* query parameter can be used to control the size of the result.\nIt must be specified in bytes. The *chunkSize* value will only be honored\napproximately. Otherwise a too low *chunkSize* value could cause the server\nto not be able to put just one log entry into the result and return it.\nTherefore, the *chunkSize* value will only be consulted after a log entry has\nbeen written into the result. If the result size is then bigger than\n*chunkSize*, the server will respond with as many log entries as there are\nin the response already. If the result size is still smaller than *chunkSize*,\nthe server will try to return more data if there's more data left to return.\n\nIf *chunkSize* is not specified, some server-side default value will be used.\n\nThe *Content-Type* of the result is *application/x-arango-dump*. This is an\neasy-to-process format, with all log events going onto separate lines in the\nresponse body. Each log event itself is a JSON object, with at least the\nfollowing attributes:\n\n- *tick*: the log event tick value\n\n- *type*: the log event type\n\nIndividual log events will also have additional attributes, depending on the\nevent type. A few common attributes which are used for multiple events types\nare:\n\n- *cid*: id of the collection the event was for\n\n- *tid*: id of the transaction the event was contained in\n\n- *key*: document key\n\n- *rev*: document revision id\n\n- *data*: the original document data\n\nA more detailed description of the individual replication event types and their\ndata structures can be found in the manual.\n\nThe response will also contain the following HTTP headers:\n\n- *x-arango-replication-active*: whether or not the logger is active. Clients\n can use this flag as an indication for their polling frequency. If the\n logger is not active and there are no more replication events available, it\n might be sensible for a client to abort, or to go to sleep for a long time\n and try again later to check whether the logger has been activated.\n\n- *x-arango-replication-lastincluded*: the tick value of the last included\n value in the result. In incremental log fetching, this value can be used\n as the *from* value for the following request. **Note** that if the result is\n empty, the value will be *0*. This value should not be used as *from* value\n by clients in the next request (otherwise the server would return the log\n events from the start of the log again).\n\n- *x-arango-replication-lasttick*: the last tick value the logger server has\n logged (not necessarily included in the result). By comparing the the last\n tick and last included tick values, clients have an approximate indication of\n how many events there are still left to fetch.\n\n- *x-arango-replication-checkmore*: whether or not there already exists more\n log data which the client could fetch immediately. If there is more log data\n available, the client could call *logger-follow* again with an adjusted *from*\n value to fetch remaining log entries until there are no more.\n\n If there isn't any more log data to fetch, the client might decide to go\n to sleep for a while before calling the logger again.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n\n\n\n#Example:\n No log events available\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=11040\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\nx-arango-replication-lasttick: 11040\nx-arango-replication-active: true\nx-arango-replication-frompresent: true\n\n
\n\n\n\n\n#Example:\n A few log events\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=11040\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 11056\nx-arango-replication-lasttick: 11056\nx-arango-replication-active: true\nx-arango-replication-frompresent: true\n\n\"{\\\"tick\\\":\\\"11042\\\",\\\"type\\\":2000,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11041\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"cid\\\":\\\"11041\\\",\\\"deleted\\\":false,\\\"doCompact\\\":true,\\\"indexBuckets\\\":8,\\\"isVolatile\\\":false,\\\"maximalSize\\\":33554432,\\\"name\\\":\\\"products\\\",\\\"type\\\":2,\\\"version\\\":5,\\\"waitForSync\\\":false}}\\n{\\\"tick\\\":\\\"11046\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11041\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p1\\\",\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"11044\\\",\\\"name\\\":\\\"flux compensator\\\"}}\\n{\\\"tick\\\":\\\"11049\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11041\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p2\\\",\\\"_key\\\":\\\"p2\\\",\\\"_rev\\\":\\\"11048\\\",\\\"hp\\\":5100,\\\"name\\\":\\\"hybrid hovercraft\\\"}}\\n{\\\"tick\\\":\\\"11052\\\",\\\"type\\\":2302,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11041\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"11051\\\"}}\\n{\\\"tick\\\":\\\"11055\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11041\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p2\\\",\\\"_key\\\":\\\"p2\\\",\\\"_rev\\\":\\\"11054\\\",\\\"hp\\\":5100,\\\"name\\\":\\\"broken hovercraft\\\"}}\\n{\\\"tick\\\":\\\"11056\\\",\\\"type\\\":2001,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11041\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"id\\\":\\\"11041\\\",\\\"name\\\":\\\"products\\\"}}\\n\"\n
\n\n\n\n\n#Example:\n More events than would fit into the response\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=11024&chunkSize=400\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-checkmore: true\nx-arango-replication-lastincluded: 11030\nx-arango-replication-lasttick: 11040\nx-arango-replication-active: true\nx-arango-replication-frompresent: true\n\n\"{\\\"tick\\\":\\\"11026\\\",\\\"type\\\":2000,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11025\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"cid\\\":\\\"11025\\\",\\\"deleted\\\":false,\\\"doCompact\\\":true,\\\"indexBuckets\\\":8,\\\"isVolatile\\\":false,\\\"maximalSize\\\":33554432,\\\"name\\\":\\\"products\\\",\\\"type\\\":2,\\\"version\\\":5,\\\"waitForSync\\\":false}}\\n{\\\"tick\\\":\\\"11030\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"11025\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p1\\\",\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"11028\\\",\\\"name\\\":\\\"flux compensator\\\"}}\\n\"\n
\n\n\n\n\n", + "description": "\n\nReturns data from the server's replication log. This method can be called\nby replication clients after an initial synchronization of data. The method\nwill return all \"recent\" log entries from the logger server, and the clients\ncan replay and apply these entries locally so they get to the same data\nstate as the logger server.\n\nClients can call this method repeatedly to incrementally fetch all changes\nfrom the logger server. In this case, they should provide the *from* value so\nthey will only get returned the log events since their last fetch.\n\nWhen the *from* query parameter is not used, the logger server will return log\nentries starting at the beginning of its replication log. When the *from*\nparameter is used, the logger server will only return log entries which have\nhigher tick values than the specified *from* value (note: the log entry with a\ntick value equal to *from* will be excluded). Use the *from* value when\nincrementally fetching log data.\n\nThe *to* query parameter can be used to optionally restrict the upper bound of\nthe result to a certain tick value. If used, the result will contain only log events\nwith tick values up to (including) *to*. In incremental fetching, there is no\nneed to use the *to* parameter. It only makes sense in special situations,\nwhen only parts of the change log are required.\n\nThe *chunkSize* query parameter can be used to control the size of the result.\nIt must be specified in bytes. The *chunkSize* value will only be honored\napproximately. Otherwise a too low *chunkSize* value could cause the server\nto not be able to put just one log entry into the result and return it.\nTherefore, the *chunkSize* value will only be consulted after a log entry has\nbeen written into the result. If the result size is then bigger than\n*chunkSize*, the server will respond with as many log entries as there are\nin the response already. If the result size is still smaller than *chunkSize*,\nthe server will try to return more data if there's more data left to return.\n\nIf *chunkSize* is not specified, some server-side default value will be used.\n\nThe *Content-Type* of the result is *application/x-arango-dump*. This is an\neasy-to-process format, with all log events going onto separate lines in the\nresponse body. Each log event itself is a JSON object, with at least the\nfollowing attributes:\n\n- *tick*: the log event tick value\n\n- *type*: the log event type\n\nIndividual log events will also have additional attributes, depending on the\nevent type. A few common attributes which are used for multiple events types\nare:\n\n- *cid*: id of the collection the event was for\n\n- *tid*: id of the transaction the event was contained in\n\n- *key*: document key\n\n- *rev*: document revision id\n\n- *data*: the original document data\n\nA more detailed description of the individual replication event types and their\ndata structures can be found in the manual.\n\nThe response will also contain the following HTTP headers:\n\n- *x-arango-replication-active*: whether or not the logger is active. Clients\n can use this flag as an indication for their polling frequency. If the\n logger is not active and there are no more replication events available, it\n might be sensible for a client to abort, or to go to sleep for a long time\n and try again later to check whether the logger has been activated.\n\n- *x-arango-replication-lastincluded*: the tick value of the last included\n value in the result. In incremental log fetching, this value can be used\n as the *from* value for the following request. **Note** that if the result is\n empty, the value will be *0*. This value should not be used as *from* value\n by clients in the next request (otherwise the server would return the log\n events from the start of the log again).\n\n- *x-arango-replication-lasttick*: the last tick value the logger server has\n logged (not necessarily included in the result). By comparing the the last\n tick and last included tick values, clients have an approximate indication of\n how many events there are still left to fetch.\n\n- *x-arango-replication-checkmore*: whether or not there already exists more\n log data which the client could fetch immediately. If there is more log data\n available, the client could call *logger-follow* again with an adjusted *from*\n value to fetch remaining log entries until there are no more.\n\n If there isn't any more log data to fetch, the client might decide to go\n to sleep for a while before calling the logger again.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n\n\n\n#Example:\n No log events available\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=10385\n\nHTTP/1.1 204 No Content\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-lasttick: 10385\nx-arango-replication-active: true\nx-arango-replication-frompresent: true\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 0\n\n
\n\n\n\n\n#Example:\n A few log events\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=10385\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-lasttick: 10397\nx-arango-replication-active: true\nx-arango-replication-frompresent: true\nx-arango-replication-checkmore: false\nx-arango-replication-lastincluded: 10397\n\n\"{\\\"tick\\\":\\\"10387\\\",\\\"type\\\":2000,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10386\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"cid\\\":\\\"10386\\\",\\\"deleted\\\":false,\\\"doCompact\\\":true,\\\"indexBuckets\\\":8,\\\"isSystem\\\":false,\\\"isVolatile\\\":false,\\\"maximalSize\\\":33554432,\\\"name\\\":\\\"products\\\",\\\"type\\\":2,\\\"version\\\":5,\\\"waitForSync\\\":false}}\\n{\\\"tick\\\":\\\"10390\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10386\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p1\\\",\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"_Tn2Y7jS---\\\",\\\"name\\\":\\\"flux compensator\\\"}}\\n{\\\"tick\\\":\\\"10392\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10386\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p2\\\",\\\"_key\\\":\\\"p2\\\",\\\"_rev\\\":\\\"_Tn2Y7jS--_\\\",\\\"hp\\\":5100,\\\"name\\\":\\\"hybrid hovercraft\\\"}}\\n{\\\"tick\\\":\\\"10394\\\",\\\"type\\\":2302,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10386\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"_Tn2Y7jS--A\\\"}}\\n{\\\"tick\\\":\\\"10396\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10386\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p2\\\",\\\"_key\\\":\\\"p2\\\",\\\"_rev\\\":\\\"_Tn2Y7jW---\\\",\\\"hp\\\":5100,\\\"name\\\":\\\"broken hovercraft\\\"}}\\n{\\\"tick\\\":\\\"10397\\\",\\\"type\\\":2001,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10386\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"id\\\":\\\"10386\\\",\\\"name\\\":\\\"products\\\"}}\\n\"\n
\n\n\n\n\n#Example:\n More events than would fit into the response\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-follow?from=10364&chunkSize=400\n\nHTTP/1.1 200 OK\ncontent-type: application/x-arango-dump; charset=utf-8\nx-arango-replication-lasttick: 10385\nx-arango-replication-active: true\nx-arango-replication-frompresent: true\nx-arango-replication-checkmore: true\nx-arango-replication-lastincluded: 10378\n\n\"{\\\"tick\\\":\\\"10375\\\",\\\"type\\\":2000,\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10374\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"cid\\\":\\\"10374\\\",\\\"deleted\\\":false,\\\"doCompact\\\":true,\\\"indexBuckets\\\":8,\\\"isSystem\\\":false,\\\"isVolatile\\\":false,\\\"maximalSize\\\":33554432,\\\"name\\\":\\\"products\\\",\\\"type\\\":2,\\\"version\\\":5,\\\"waitForSync\\\":false}}\\n{\\\"tick\\\":\\\"10378\\\",\\\"type\\\":2300,\\\"tid\\\":\\\"0\\\",\\\"database\\\":\\\"1\\\",\\\"cid\\\":\\\"10374\\\",\\\"cname\\\":\\\"products\\\",\\\"data\\\":{\\\"_id\\\":\\\"_unknown/p1\\\",\\\"_key\\\":\\\"p1\\\",\\\"_rev\\\":\\\"_Tn2Y6fC---\\\",\\\"name\\\":\\\"flux compensator\\\"}}\\n\"\n
\n\n\n\n\n", "parameters": [ { "description": "Lower bound tick value for results.\n\n", @@ -6125,12 +6207,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/logger-state": { "get": { - "description": "\n\nReturns the current state of the server's replication logger. The state will\ninclude information about whether the logger is running and about the last\nlogged tick value. This tick value is important for incremental fetching of\ndata.\n\nThe body of the response contains a JSON object with the following\nattributes:\n\n- *state*: the current logger state as a JSON object with the following\n sub-attributes:\n\n - *running*: whether or not the logger is running\n\n - *lastLogTick*: the tick value of the latest tick the logger has logged.\n This value can be used for incremental fetching of log data.\n\n - *totalEvents*: total number of events logged since the server was started.\n The value is not reset between multiple stops and re-starts of the logger.\n\n - *time*: the current date and time on the logger server\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the logger server's version\n\n - *serverId*: the logger server's id\n\n- *clients*: returns the last fetch status by replication clients connected to\n the logger. Each client is returned as a JSON object with the following attributes:\n\n - *serverId*: server id of client\n\n - *lastServedTick*: last tick value served to this client via the *logger-follow* API\n\n - *time*: date and time when this client last called the *logger-follow* API\n\n\n\n\n#Example:\n Returns the state of the replication logger.\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11056\", \n    \"lastUncommittedLogTick\" : \"11056\", \n    \"totalEvents\" : 3788, \n    \"time\" : \"2016-06-17T13:12:19Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.x-devel\", \n    \"serverId\" : \"29298867422456\" \n  }, \n  \"clients\" : [ ] \n}\n
\n\n\n\n\n", + "description": "\n\nReturns the current state of the server's replication logger. The state will\ninclude information about whether the logger is running and about the last\nlogged tick value. This tick value is important for incremental fetching of\ndata.\n\nThe body of the response contains a JSON object with the following\nattributes:\n\n- *state*: the current logger state as a JSON object with the following\n sub-attributes:\n\n - *running*: whether or not the logger is running\n\n - *lastLogTick*: the tick value of the latest tick the logger has logged.\n This value can be used for incremental fetching of log data.\n\n - *totalEvents*: total number of events logged since the server was started.\n The value is not reset between multiple stops and re-starts of the logger.\n\n - *time*: the current date and time on the logger server\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the logger server's version\n\n - *serverId*: the logger server's id\n\n- *clients*: returns the last fetch status by replication clients connected to\n the logger. Each client is returned as a JSON object with the following attributes:\n\n - *serverId*: server id of client\n\n - *lastServedTick*: last tick value served to this client via the *logger-follow* API\n\n - *time*: date and time when this client last called the *logger-follow* API\n\n\n\n\n#Example:\n Returns the state of the replication logger.\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-state\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"10397\", \n    \"lastUncommittedLogTick\" : \"10397\", \n    \"totalEvents\" : 3797, \n    \"time\" : \"2016-08-18T14:43:03Z\" \n  }, \n  \"server\" : { \n    \"version\" : \"3.0.devel\", \n    \"serverId\" : \"92109534963517\" \n  }, \n  \"clients\" : [ ] \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -6148,12 +6230,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/logger-tick-ranges": { "get": { - "description": "\n\nReturns the currently available ranges of tick values for all currently\navailable WAL logfiles. The tick values can be used to determine if certain\ndata (identified by tick value) are still available for replication.\n\nThe body of the response contains a JSON array. Each array member is an\nobject\nthat describes a single logfile. Each object has the following attributes:\n\n* *datafile*: name of the logfile\n\n* *status*: status of the datafile, in textual form (e.g. \"sealed\", \"open\")\n\n* *tickMin*: minimum tick value contained in logfile\n\n* *tickMax*: maximum tick value contained in logfile\n\n\n\n\n#Example:\n Returns the available tick ranges.\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-tick-ranges\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  { \n    \"datafile\" : \"/tmp/arangosh_HRvSiM/tmp-26887-1938238700/data/journals/logfile-2.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"7\", \n    \"tickMax\" : \"9890\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_HRvSiM/tmp-26887-1938238700/data/journals/logfile-3.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"9907\", \n    \"tickMax\" : \"9943\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_HRvSiM/tmp-26887-1938238700/data/journals/logfile-5.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"9950\", \n    \"tickMax\" : \"10970\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_HRvSiM/tmp-26887-1938238700/data/journals/logfile-9893.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"10977\", \n    \"tickMax\" : \"11000\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_HRvSiM/tmp-26887-1938238700/data/journals/logfile-9956.db\", \n    \"status\" : \"open\", \n    \"tickMin\" : \"11006\", \n    \"tickMax\" : \"11056\" \n  } \n]\n
\n\n\n\n\n", + "description": "\n\nReturns the currently available ranges of tick values for all currently\navailable WAL logfiles. The tick values can be used to determine if certain\ndata (identified by tick value) are still available for replication.\n\nThe body of the response contains a JSON array. Each array member is an\nobject\nthat describes a single logfile. Each object has the following attributes:\n\n* *datafile*: name of the logfile\n\n* *status*: status of the datafile, in textual form (e.g. \"sealed\", \"open\")\n\n* *tickMin*: minimum tick value contained in logfile\n\n* *tickMax*: maximum tick value contained in logfile\n\n\n\n\n#Example:\n Returns the available tick ranges.\n\n
shell> curl --dump - http://localhost:8529/_api/replication/logger-tick-ranges\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  { \n    \"datafile\" : \"/tmp/arangosh_pfFFNd/tmp-26625-4130755256/data/journals/logfile-3.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"6\", \n    \"tickMax\" : \"9300\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_pfFFNd/tmp-26625-4130755256/data/journals/logfile-4.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"9316\", \n    \"tickMax\" : \"9352\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_pfFFNd/tmp-26625-4130755256/data/journals/logfile-18.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"9357\", \n    \"tickMax\" : \"10307\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_pfFFNd/tmp-26625-4130755256/data/journals/logfile-9303.db\", \n    \"status\" : \"collected\", \n    \"tickMin\" : \"10314\", \n    \"tickMax\" : \"10340\" \n  }, \n  { \n    \"datafile\" : \"/tmp/arangosh_pfFFNd/tmp-26625-4130755256/data/journals/logfile-9355.db\", \n    \"status\" : \"open\", \n    \"tickMin\" : \"10346\", \n    \"tickMax\" : \"10397\" \n  } \n]\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -6174,12 +6256,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/make-slave": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the master.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\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\n 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 an automatic resynchronization with\n the master in case the master cannot serve log data requested by the slave,\n or when the replication is started and no tick value can be found.\n - **database**: the database name on the master (if not specified, defaults to the\n name of the local current database).\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 - **restrictType**: an optional string value for collection filtering. When\n specified, the allowed values are *include* or *exclude*.\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 - **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 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 - **restrictCollections**: an optional array of collections for use with *restrictType*.\n If *restrictType* is *include*, only the specified collections\n will be sychronised. If *restrictType* is *exclude*, all but the specified\n collections will be synchronized. of type string\n - **requireFromPresent**: if set to *true*, then the replication applier will check\n at start of its continuous replication if the start tick from the dump phase\n is 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 - **adaptivePolling**: whether or not the replication applier will use adaptive polling.\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 - **password**: the password to use when connecting to the master.\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* 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 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\nStarts a full data synchronization from a remote endpoint into the local ArangoDB\ndatabase and afterwards starts the continuous replication.\nThe operation works on a per-database level.\n\nAll local database data will be removed prior to the synchronization.\n\nIn case of success, the body of the response is a JSON object with the following\nattributes:\n\n- *state*: a JSON object with the following sub-attributes:\n\n - *running*: whether or not the applier is active and running\n\n - *lastAppliedContinuousTick*: the last tick value from the continuous\n replication log the applier has applied.\n\n - *lastProcessedContinuousTick*: the last tick value from the continuous\n replication log the applier has processed.\n\n Regularly, the last applied and last processed tick values should be\n identical. For transactional operations, the replication applier will first\n process incoming log events before applying them, so the processed tick\n value might be higher than the applied tick value. This will be the case\n until the applier encounters the *transaction commit* log event for the\n transaction.\n\n - *lastAvailableContinuousTick*: the last tick value the logger server can\n provide.\n\n - *time*: the time on the applier server.\n\n - *totalRequests*: the total number of requests the applier has made to the\n endpoint.\n\n - *totalFailedConnects*: the total number of failed connection attempts the\n applier has made.\n\n - *totalEvents*: the total number of log events the applier has processed.\n\n - *totalOperationsExcluded*: the total number of log events excluded because\n of *restrictCollections*.\n\n - *progress*: a JSON object with details about the replication applier progress.\n It contains the following sub-attributes if there is progress to report:\n\n - *message*: a textual description of the progress\n\n - *time*: the date and time the progress was logged\n\n - *failedConnects*: the current number of failed connection attempts\n\n - *lastError*: a JSON object with details about the last error that happened on\n the applier. It contains the following sub-attributes if there was an error:\n\n - *errorNum*: a numerical error code\n\n - *errorMessage*: a textual error description\n\n - *time*: the date and time the error occurred\n\n In case no error has occurred, *lastError* will be empty.\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the applier server's version\n\n - *serverId*: the applier server's id\n\n- *endpoint*: the endpoint the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n- *database*: the name of the database the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\nWARNING: calling this method will sychronize data from the collections found\non the remote master to the local ArangoDB database. All data in the local\ncollections will be purged and replaced with data from the master.\n\nUse with caution!\n\nPlease also keep in mind that this command may take a long time to complete\nand return. This is because it will first do a full data synchronization with\nthe master, which will take time roughly proportional to the amount of data.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the master.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\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\n 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 an automatic resynchronization with\n the master in case the master cannot serve log data requested by the slave,\n or when the replication is started and no tick value can be found.\n - **database**: the database name on the master (if not specified, defaults to the\n name of the local current database).\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 - **restrictType**: an optional string value for collection filtering. When\n specified, the allowed values are *include* or *exclude*.\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 - **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 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 - **restrictCollections** (string): an optional array of collections for use with *restrictType*.\n If *restrictType* is *include*, only the specified collections\n will be sychronised. If *restrictType* is *exclude*, all but the specified\n collections will be synchronized. - **requireFromPresent**: if set to *true*, then the replication applier will check\n at start of its continuous replication if the start tick from the dump phase\n is 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 - **adaptivePolling**: whether or not the replication applier will use adaptive polling.\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 - **password**: the password to use when connecting to the master.\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* 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 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\nStarts a full data synchronization from a remote endpoint into the local ArangoDB\ndatabase and afterwards starts the continuous replication.\nThe operation works on a per-database level.\n\nAll local database data will be removed prior to the synchronization.\n\nIn case of success, the body of the response is a JSON object with the following\nattributes:\n\n- *state*: a JSON object with the following sub-attributes:\n\n - *running*: whether or not the applier is active and running\n\n - *lastAppliedContinuousTick*: the last tick value from the continuous\n replication log the applier has applied.\n\n - *lastProcessedContinuousTick*: the last tick value from the continuous\n replication log the applier has processed.\n\n Regularly, the last applied and last processed tick values should be\n identical. For transactional operations, the replication applier will first\n process incoming log events before applying them, so the processed tick\n value might be higher than the applied tick value. This will be the case\n until the applier encounters the *transaction commit* log event for the\n transaction.\n\n - *lastAvailableContinuousTick*: the last tick value the logger server can\n provide.\n\n - *time*: the time on the applier server.\n\n - *totalRequests*: the total number of requests the applier has made to the\n endpoint.\n\n - *totalFailedConnects*: the total number of failed connection attempts the\n applier has made.\n\n - *totalEvents*: the total number of log events the applier has processed.\n\n - *totalOperationsExcluded*: the total number of log events excluded because\n of *restrictCollections*.\n\n - *progress*: a JSON object with details about the replication applier progress.\n It contains the following sub-attributes if there is progress to report:\n\n - *message*: a textual description of the progress\n\n - *time*: the date and time the progress was logged\n\n - *failedConnects*: the current number of failed connection attempts\n\n - *lastError*: a JSON object with details about the last error that happened on\n the applier. It contains the following sub-attributes if there was an error:\n\n - *errorNum*: a numerical error code\n\n - *errorMessage*: a textual error description\n\n - *time*: the date and time the error occurred\n\n In case no error has occurred, *lastError* will be empty.\n\n- *server*: a JSON object with the following sub-attributes:\n\n - *version*: the applier server's version\n\n - *serverId*: the applier server's id\n\n- *endpoint*: the endpoint the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\n- *database*: the name of the database the applier is connected to (if applier is\n active) or will connect to (if applier is currently inactive)\n\nWARNING: calling this method will sychronize data from the collections found\non the remote master to the local ArangoDB database. All data in the local\ncollections will be purged and replaced with data from the master.\n\nUse with caution!\n\nPlease also keep in mind that this command may take a long time to complete\nand return. This is because it will first do a full data synchronization with\nthe master, which will take time roughly proportional to the amount of data.\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n", "parameters": [ { "in": "body", @@ -6213,12 +6295,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/server-id": { "get": { - "description": "\n\nReturns the servers id. The id is also returned by other replication API\nmethods, and this method is an easy means of determining a server's id.\n\nThe body of the response is a JSON object with the attribute *serverId*. The\nserver id is returned as a string.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/server-id\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"serverId\" : \"29298867422456\" \n}\n
\n\n\n\n\n", + "description": "\n\nReturns the servers id. The id is also returned by other replication API\nmethods, and this method is an easy means of determining a server's id.\n\nThe body of the response is a JSON object with the attribute *serverId*. The\nserver id is returned as a string.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/server-id\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"serverId\" : \"92109534963517\" \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -6236,12 +6318,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/replication/sync": { "put": { - "description": "**A json post document 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 master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\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 synchronization\n will give up waiting for a response and fail.\n This value will be ignored if set to *0*.\n - **database**: the database name on the master (if not specified, defaults to the\n name of the local current database).\n - **restrictType**: an optional string value for collection filtering. When\n specified, the allowed values are *include* or *exclude*.\n - **incremental**: if set to *true*, then an incremental synchronization method will be used\n for synchronizing data in collections. This method is useful when\n collections already exist locally, and only the remaining differences need\n to be transferred from the remote endpoint. In this case, the incremental\n synchronization can be faster than a full synchronization.\n The default value is *false*, meaning that the complete data from the remote\n collection will be transferred.\n - **restrictCollections**: an optional array of collections for use with\n *restrictType*. If *restrictType* is *include*, only the specified collections\n will be sychronised. If *restrictType* is *exclude*, all but the specified\n collections will be synchronized. of type string\n - **password**: the password to use when connecting to the endpoint.\n\n\n\n\nStarts a full data synchronization from a remote endpoint into the local\nArangoDB database.\n\nThe *sync* method can be used by replication clients to connect an ArangoDB database\nto a remote endpoint, fetch the remote list of collections and indexes, and collection\ndata. It will thus create a local backup of the state of data at the remote ArangoDB\ndatabase. *sync* works on a per-database level.\n\n*sync* will first fetch the list of collections and indexes from the remote endpoint.\nIt does so by calling the *inventory* API of the remote database. It will then purge\ndata in the local ArangoDB database, and after start will transfer collection data\nfrom the remote database to the local ArangoDB database. It will extract data from the\nremote database by calling the remote database's *dump* API until all data are fetched.\n\nIn case of success, the body of the response is a JSON object with the following\nattributes:\n\n- *collections*: an array of collections that were transferred from the endpoint\n\n- *lastLogTick*: the last log tick on the endpoint at the time the transfer\n was started. Use this value as the *from* value when starting the continuous\n synchronization later.\n\nWARNING: calling this method will sychronize data from the collections found\non the remote endpoint to the local ArangoDB database. All data in the local\ncollections will be purged and replaced with data from the endpoint.\n\nUse with caution!\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n", + "description": "**A json post document 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 master endpoint to connect to (e.g. \"tcp://192.168.173.13:8529\").\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 synchronization\n will give up waiting for a response and fail.\n This value will be ignored if set to *0*.\n - **database**: the database name on the master (if not specified, defaults to the\n name of the local current database).\n - **restrictType**: an optional string value for collection filtering. When\n specified, the allowed values are *include* or *exclude*.\n - **incremental**: if set to *true*, then an incremental synchronization method will be used\n for synchronizing data in collections. This method is useful when\n collections already exist locally, and only the remaining differences need\n to be transferred from the remote endpoint. In this case, the incremental\n synchronization can be faster than a full synchronization.\n The default value is *false*, meaning that the complete data from the remote\n collection will be transferred.\n - **restrictCollections** (string): an optional array of collections for use with\n *restrictType*. If *restrictType* is *include*, only the specified collections\n will be sychronised. If *restrictType* is *exclude*, all but the specified\n collections will be synchronized. - **password**: the password to use when connecting to the endpoint.\n\n\n\n\nStarts a full data synchronization from a remote endpoint into the local\nArangoDB database.\n\nThe *sync* method can be used by replication clients to connect an ArangoDB database\nto a remote endpoint, fetch the remote list of collections and indexes, and collection\ndata. It will thus create a local backup of the state of data at the remote ArangoDB\ndatabase. *sync* works on a per-database level.\n\n*sync* will first fetch the list of collections and indexes from the remote endpoint.\nIt does so by calling the *inventory* API of the remote database. It will then purge\ndata in the local ArangoDB database, and after start will transfer collection data\nfrom the remote database to the local ArangoDB database. It will extract data from the\nremote database by calling the remote database's *dump* API until all data are fetched.\n\nIn case of success, the body of the response is a JSON object with the following\nattributes:\n\n- *collections*: an array of collections that were transferred from the endpoint\n\n- *lastLogTick*: the last log tick on the endpoint at the time the transfer\n was started. Use this value as the *from* value when starting the continuous\n synchronization later.\n\nWARNING: calling this method will sychronize data from the collections found\non the remote endpoint to the local ArangoDB database. All data in the local\ncollections will be purged and replaced with data from the endpoint.\n\nUse with caution!\n\n**Note**: this method is not supported on a coordinator in a cluster.\n\n", "parameters": [ { "in": "body", @@ -6275,12 +6357,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md" } }, "/_api/simple/all": { "put": { - "description": "\nfree style json body\n\n\n\n\nReturns all documents of a collections. The call expects a JSON object\nas body with the following attributes:\n\n- *collection*: The name of the collection to query.\n\n- *skip*: The number of documents to skip in the query (optional).\n\n- *limit*: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n Limit the amount of documents using *limit*\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all <<EOF\n{ \"collection\": \"products\", \"skip\": 2, \"limit\" : 2 }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11094\", \n      \"_id\" : \"products/11094\", \n      \"_rev\" : \"11094\", \n      \"Hello5\" : \"World5\" \n    }, \n    { \n      \"_key\" : \"11081\", \n      \"_id\" : \"products/11081\", \n      \"_rev\" : \"11081\", \n      \"Hello1\" : \"World1\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 4, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00019598007202148438 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Using a *batchSize* value\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all <<EOF\n{ \"collection\": \"products\", \"batchSize\" : 3 }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11060\", \n      \"_id\" : \"products/11060\", \n      \"_rev\" : \"11060\", \n      \"Hello1\" : \"World1\" \n    }, \n    { \n      \"_key\" : \"11073\", \n      \"_id\" : \"products/11073\", \n      \"_rev\" : \"11073\", \n      \"Hello5\" : \"World5\" \n    }, \n    { \n      \"_key\" : \"11067\", \n      \"_id\" : \"products/11067\", \n      \"_rev\" : \"11067\", \n      \"Hello3\" : \"World3\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"11076\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00019502639770507812 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "\nfree style json body\n\n\n\n\nReturns all documents of a collections. The call expects a JSON object\nas body with the following attributes:\n\n- *collection*: The name of the collection to query.\n\n- *skip*: The number of documents to skip in the query (optional).\n\n- *limit*: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n Limit the amount of documents using *limit*\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all <<EOF\n{ \"collection\": \"products\", \"skip\": 2, \"limit\" : 2 }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10426\", \n      \"_id\" : \"products/10426\", \n      \"_rev\" : \"_Tn2Y8mu---\", \n      \"Hello2\" : \"World2\" \n    }, \n    { \n      \"_key\" : \"10422\", \n      \"_id\" : \"products/10422\", \n      \"_rev\" : \"_Tn2Y8mq---\", \n      \"Hello1\" : \"World1\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 4, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00011110305786132812 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Using a *batchSize* value\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all <<EOF\n{ \"collection\": \"products\", \"batchSize\" : 3 }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10401\", \n      \"_id\" : \"products/10401\", \n      \"_rev\" : \"_Tn2Y8mG---\", \n      \"Hello1\" : \"World1\" \n    }, \n    { \n      \"_key\" : \"10414\", \n      \"_id\" : \"products/10414\", \n      \"_rev\" : \"_Tn2Y8mK--B\", \n      \"Hello5\" : \"World5\" \n    }, \n    { \n      \"_key\" : \"10408\", \n      \"_id\" : \"products/10408\", \n      \"_rev\" : \"_Tn2Y8mK--_\", \n      \"Hello3\" : \"World3\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"10417\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.00012302398681640625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "Contains the query.\n\n", @@ -6310,12 +6392,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/all-keys": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **type**: The type of the result. The following values are allowed:\n - *id*: returns an array of document ids (*_id* attributes)\n - *key*: returns an array of document keys (*_key* attributes)\n - *path*: returns an array of document URI paths. This is the default.\n - **collection**: The name of the collection. This is only for backward compatibility.\n In ArangoDB versions < 3.0, the URL path was */_api/document* and\n this was passed in via the query parameter \"collection\".\n This combination was removed.\n\n\n\n\nReturns an array of all keys, ids, or URI paths for all documents in the\ncollection identified by *collection*. The type of the result array is\ndetermined by the *type* attribute.\n\nNote that the results have no defined order and thus the order should\nnot be relied on.\n\n\n\n\n#Example:\n Return all document paths\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all-keys <<EOF\n{ \n  \"collection\" : \"products\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    \"/_db/_system/_api/document/products/10427\", \n    \"/_db/_system/_api/document/products/10424\", \n    \"/_db/_system/_api/document/products/10420\" \n  ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 3, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.000247955322265625 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Return all document keys\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all-keys <<EOF\n{ \n  \"collection\" : \"products\", \n  \"type\" : \"id\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    \"products/10410\", \n    \"products/10406\", \n    \"products/10413\" \n  ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 3, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0002720355987548828 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Collection does not exist\n\n
shell> curl --dump - http://localhost:8529/_api/document/doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting GET /_api/document/<document-handle>\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **type**: The type of the result. The following values are allowed:\n - *id*: returns an array of document ids (*_id* attributes)\n - *key*: returns an array of document keys (*_key* attributes)\n - *path*: returns an array of document URI paths. This is the default.\n - **collection**: The name of the collection. This is only for backward compatibility.\n In ArangoDB versions < 3.0, the URL path was */_api/document* and\n this was passed in via the query parameter \"collection\".\n This combination was removed.\n\n\n\n\nReturns an array of all keys, ids, or URI paths for all documents in the\ncollection identified by *collection*. The type of the result array is\ndetermined by the *type* attribute.\n\nNote that the results have no defined order and thus the order should\nnot be relied on.\n\n\n\n\n#Example:\n Return all document paths\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all-keys <<EOF\n{ \n  \"collection\" : \"products\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    \"/_db/_system/_api/document/products/9801\", \n    \"/_db/_system/_api/document/products/9797\", \n    \"/_db/_system/_api/document/products/9804\" \n  ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 3, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0001418590545654297 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Return all document keys\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/all-keys <<EOF\n{ \n  \"collection\" : \"products\", \n  \"type\" : \"id\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    \"products/9783\", \n    \"products/9787\", \n    \"products/9790\" \n  ], \n  \"hasMore\" : false, \n  \"cached\" : false, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 3, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"executionTime\" : 0.0001399517059326172 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Collection does not exist\n\n
shell> curl --dump - http://localhost:8529/_api/document/doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting GET /_api/document/<document-handle>\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6340,12 +6422,12 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md" + "x-filename": "Documents - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" } }, "/_api/simple/any": { "put": { - "description": "\n\n\nReturns a random document from a collection. The call expects a JSON object\nas body with the following attributes:\n\n**A json post document with these Properties is required:**\n\n - **collection**: The identifier or name of the collection to query.\n Returns a JSON object with the document stored in the attribute\n *document* if the collection contains at least one document. If\n the collection is empty, the *document* attrbute contains null.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/any <<EOF\n{ \n  \"collection\" : \"products\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"document\" : { \n    \"_key\" : \"11111\", \n    \"_id\" : \"products/11111\", \n    \"_rev\" : \"11111\", \n    \"Hello4\" : \"World4\" \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\n\nReturns a random document from a collection. The call expects a JSON object\nas body with the following attributes:\n\n**A json post document with these Properties is required:**\n\n - **collection**: The identifier or name of the collection to query.\n Returns a JSON object with the document stored in the attribute\n *document* if the collection contains at least one document. If\n the collection is empty, the *document* attrbute contains null.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/any <<EOF\n{ \n  \"collection\" : \"products\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"document\" : { \n    \"_key\" : \"10455\", \n    \"_id\" : \"products/10455\", \n    \"_rev\" : \"_Tn2Y8nW---\", \n    \"Hello5\" : \"World5\" \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6373,12 +6455,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/by-example": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **skip**: The number of documents to skip in the query (optional).\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **example**: The example document.\n - **collection**: The name of the collection to query.\n\n\n\n\n\nThis will find all documents matching a given example.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n Matching an attribute\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"i\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11121\", \n      \"_id\" : \"products/11121\", \n      \"_rev\" : \"11121\", \n      \"a\" : { \n        \"k\" : 1, \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"11125\", \n      \"_id\" : \"products/11125\", \n      \"_rev\" : \"11125\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"11131\", \n      \"_id\" : \"products/11131\", \n      \"_rev\" : \"11131\", \n      \"a\" : { \n        \"k\" : 2, \n        \"j\" : 2 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"11128\", \n      \"_id\" : \"products/11128\", \n      \"_rev\" : \"11128\", \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 4, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Matching an attribute which is a sub-document\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a.j\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11143\", \n      \"_id\" : \"products/11143\", \n      \"_rev\" : \"11143\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"11139\", \n      \"_id\" : \"products/11139\", \n      \"_rev\" : \"11139\", \n      \"a\" : { \n        \"k\" : 1, \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Matching an attribute within a sub-document\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11161\", \n      \"_id\" : \"products/11161\", \n      \"_rev\" : \"11161\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 1, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **skip**: The number of documents to skip in the query (optional).\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **example**: The example document.\n - **collection**: The name of the collection to query.\n\n\n\n\n\nThis will find all documents matching a given example.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n Matching an attribute\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"i\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10462\", \n      \"_id\" : \"products/10462\", \n      \"_rev\" : \"_Tn2Y8n2---\", \n      \"a\" : { \n        \"k\" : 1, \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10469\", \n      \"_id\" : \"products/10469\", \n      \"_rev\" : \"_Tn2Y8n2--A\", \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10466\", \n      \"_id\" : \"products/10466\", \n      \"_rev\" : \"_Tn2Y8n2--_\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10472\", \n      \"_id\" : \"products/10472\", \n      \"_rev\" : \"_Tn2Y8n6---\", \n      \"a\" : { \n        \"k\" : 2, \n        \"j\" : 2 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 4, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Matching an attribute which is a sub-document\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a.j\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10480\", \n      \"_id\" : \"products/10480\", \n      \"_rev\" : \"_Tn2Y8oe---\", \n      \"a\" : { \n        \"k\" : 1, \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    }, \n    { \n      \"_key\" : \"10484\", \n      \"_id\" : \"products/10484\", \n      \"_rev\" : \"_Tn2Y8oi---\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n Matching an attribute within a sub-document\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  } \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10502\", \n      \"_id\" : \"products/10502\", \n      \"_rev\" : \"_Tn2Y8pK--_\", \n      \"a\" : { \n        \"j\" : 1 \n      }, \n      \"i\" : 1 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 1, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6406,12 +6488,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/first-example": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **example**: The example document.\n - **collection**: The name of the collection to query.\n\n\n\n\n\nThis will return the first document matching a given example.\n\nReturns a result containing the document or *HTTP 404* if no\ndocument matched the example.\n\nIf more than one document in the collection matches the specified example, only\none of these documents will be returned, and it is undefined which of the matching\ndocuments is returned.\n\n\n\n\n#Example:\n If a matching document was found\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/first-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"i\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"document\" : { \n    \"_key\" : \"11175\", \n    \"_id\" : \"products/11175\", \n    \"_rev\" : \"11175\", \n    \"a\" : { \n      \"k\" : 1, \n      \"j\" : 1 \n    }, \n    \"i\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n If no document was found\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/first-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"l\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 404, \n  \"errorMessage\" : \"no match\" \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **example**: The example document.\n - **collection**: The name of the collection to query.\n\n\n\n\n\nThis will return the first document matching a given example.\n\nReturns a result containing the document or *HTTP 404* if no\ndocument matched the example.\n\nIf more than one document in the collection matches the specified example, only\none of these documents will be returned, and it is undefined which of the matching\ndocuments is returned.\n\n\n\n\n#Example:\n If a matching document was found\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/first-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"i\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"document\" : { \n    \"_key\" : \"10526\", \n    \"_id\" : \"products/10526\", \n    \"_rev\" : \"_Tn2Y8py--_\", \n    \"a\" : { \n      \"k\" : 2, \n      \"j\" : 2 \n    }, \n    \"i\" : 1 \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n If no document was found\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/first-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"l\" : 1 \n  } \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 404, \n  \"errorMessage\" : \"no match\" \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6439,12 +6521,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/fulltext": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **index**: The identifier of the fulltext-index to use.\n - **attribute**: The attribute that contains the texts.\n - **collection**: The name of the collection to query.\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **skip**: The number of documents to skip in the query (optional).\n - **query**: The fulltext query. Please refer to [Fulltext queries](../../Manual/Appendix/Deprecated/SimpleQueries/FulltextQueries.html)\n for details.\n\n\n\n\n\nThis will find all documents from the collection that match the fulltext\nquery specified in *query*.\n\nIn order to use the *fulltext* operator, a fulltext index must be defined\nfor the collection and the specified attribute.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *fulltext* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an AQL query using the *FULLTEXT* [AQL function](../../AQL/Functions/Fulltext.html) \nas follows:\n\n\n FOR doc IN FULLTEXT(@@collection, @attributeName, @queryString, @limit) \n RETURN doc\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/fulltext <<EOF\n{ \n  \"collection\" : \"products\", \n  \"attribute\" : \"text\", \n  \"query\" : \"word\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11213\", \n      \"_id\" : \"products/11213\", \n      \"_rev\" : \"11213\", \n      \"text\" : \"this text also has a word\" \n    }, \n    { \n      \"_key\" : \"11209\", \n      \"_id\" : \"products/11209\", \n      \"_rev\" : \"11209\", \n      \"text\" : \"this text contains word\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **index**: The identifier of the fulltext-index to use.\n - **attribute**: The attribute that contains the texts.\n - **collection**: The name of the collection to query.\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **skip**: The number of documents to skip in the query (optional).\n - **query**: The fulltext query. Please refer to [Fulltext queries](../../Manual/Appendix/Deprecated/SimpleQueries/FulltextQueries.html)\n for details.\n\n\n\n\n\nThis will find all documents from the collection that match the fulltext\nquery specified in *query*.\n\nIn order to use the *fulltext* operator, a fulltext index must be defined\nfor the collection and the specified attribute.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *fulltext* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an AQL query using the *FULLTEXT* [AQL function](../../AQL/Functions/Fulltext.html) \nas follows:\n\n\n FOR doc IN FULLTEXT(@@collection, @attributeName, @queryString, @limit) \n RETURN doc\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/fulltext <<EOF\n{ \n  \"collection\" : \"products\", \n  \"attribute\" : \"text\", \n  \"query\" : \"word\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10550\", \n      \"_id\" : \"products/10550\", \n      \"_rev\" : \"_Tn2Y8r----\", \n      \"text\" : \"this text contains word\" \n    }, \n    { \n      \"_key\" : \"10554\", \n      \"_id\" : \"products/10554\", \n      \"_rev\" : \"_Tn2Y8r---_\", \n      \"text\" : \"this text also has a word\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6472,12 +6554,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/lookup-by-keys": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **keys**: array with the _keys of documents to remove. of type string\n - **collection**: The name of the collection to look in for the documents\n\n\n\n\nLooks up the documents in the specified collection\nusing the array of keys provided. All documents for which a matching\nkey was specified in the *keys* array and that exist in the collection\nwill be returned. Keys for which no document can be found in the\nunderlying collection are ignored, and no exception will be thrown for\nthem.\n\nThe body of the response contains a JSON object with a *documents*\nattribute. The *documents* attribute is an array containing the\nmatching documents. The order in which matching documents are present\nin the result array is unspecified.\n\n\n\n\n#Example:\n Looking up existing documents\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/lookup-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"test0\", \n    \"test1\", \n    \"test2\", \n    \"test3\", \n    \"test4\", \n    \"test5\", \n    \"test6\", \n    \"test7\", \n    \"test8\", \n    \"test9\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 200, \n  \"documents\" : [ \n    { \n      \"_id\" : \"test/test0\", \n      \"_key\" : \"test0\", \n      \"_rev\" : \"11237\", \n      \"value\" : 0 \n    }, \n    { \n      \"_id\" : \"test/test1\", \n      \"_key\" : \"test1\", \n      \"_rev\" : \"11241\", \n      \"value\" : 1 \n    }, \n    { \n      \"_id\" : \"test/test2\", \n      \"_key\" : \"test2\", \n      \"_rev\" : \"11244\", \n      \"value\" : 2 \n    }, \n    { \n      \"_id\" : \"test/test3\", \n      \"_key\" : \"test3\", \n      \"_rev\" : \"11247\", \n      \"value\" : 3 \n    }, \n    { \n      \"_id\" : \"test/test4\", \n      \"_key\" : \"test4\", \n      \"_rev\" : \"11250\", \n      \"value\" : 4 \n    }, \n    { \n      \"_id\" : \"test/test5\", \n      \"_key\" : \"test5\", \n      \"_rev\" : \"11253\", \n      \"value\" : 5 \n    }, \n    { \n      \"_id\" : \"test/test6\", \n      \"_key\" : \"test6\", \n      \"_rev\" : \"11256\", \n      \"value\" : 6 \n    }, \n    { \n      \"_id\" : \"test/test7\", \n      \"_key\" : \"test7\", \n      \"_rev\" : \"11259\", \n      \"value\" : 7 \n    }, \n    { \n      \"_id\" : \"test/test8\", \n      \"_key\" : \"test8\", \n      \"_rev\" : \"11262\", \n      \"value\" : 8 \n    }, \n    { \n      \"_id\" : \"test/test9\", \n      \"_key\" : \"test9\", \n      \"_rev\" : \"11265\", \n      \"value\" : 9 \n    } \n  ], \n  \"error\" : false \n}\n
\n\n\n\n\n#Example:\n Looking up non-existing documents\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/lookup-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"foo\", \n    \"bar\", \n    \"baz\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 200, \n  \"documents\" : [ ], \n  \"error\" : false \n}\n
\n\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **keys** (string): array with the _keys of documents to remove. - **collection**: The name of the collection to look in for the documents\n\n\n\n\nLooks up the documents in the specified collection\nusing the array of keys provided. All documents for which a matching\nkey was specified in the *keys* array and that exist in the collection\nwill be returned. Keys for which no document can be found in the\nunderlying collection are ignored, and no exception will be thrown for\nthem.\n\nThe body of the response contains a JSON object with a *documents*\nattribute. The *documents* attribute is an array containing the\nmatching documents. The order in which matching documents are present\nin the result array is unspecified.\n\n\n\n\n#Example:\n Looking up existing documents\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/lookup-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"test0\", \n    \"test1\", \n    \"test2\", \n    \"test3\", \n    \"test4\", \n    \"test5\", \n    \"test6\", \n    \"test7\", \n    \"test8\", \n    \"test9\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 200, \n  \"documents\" : [ \n    { \n      \"_id\" : \"test/test0\", \n      \"_key\" : \"test0\", \n      \"_rev\" : \"_Tn2Y8ru---\", \n      \"value\" : 0 \n    }, \n    { \n      \"_id\" : \"test/test1\", \n      \"_key\" : \"test1\", \n      \"_rev\" : \"_Tn2Y8ru--_\", \n      \"value\" : 1 \n    }, \n    { \n      \"_id\" : \"test/test2\", \n      \"_key\" : \"test2\", \n      \"_rev\" : \"_Tn2Y8ru--A\", \n      \"value\" : 2 \n    }, \n    { \n      \"_id\" : \"test/test3\", \n      \"_key\" : \"test3\", \n      \"_rev\" : \"_Tn2Y8ru--B\", \n      \"value\" : 3 \n    }, \n    { \n      \"_id\" : \"test/test4\", \n      \"_key\" : \"test4\", \n      \"_rev\" : \"_Tn2Y8ru--C\", \n      \"value\" : 4 \n    }, \n    { \n      \"_id\" : \"test/test5\", \n      \"_key\" : \"test5\", \n      \"_rev\" : \"_Tn2Y8ru--D\", \n      \"value\" : 5 \n    }, \n    { \n      \"_id\" : \"test/test6\", \n      \"_key\" : \"test6\", \n      \"_rev\" : \"_Tn2Y8ry---\", \n      \"value\" : 6 \n    }, \n    { \n      \"_id\" : \"test/test7\", \n      \"_key\" : \"test7\", \n      \"_rev\" : \"_Tn2Y8ry--_\", \n      \"value\" : 7 \n    }, \n    { \n      \"_id\" : \"test/test8\", \n      \"_key\" : \"test8\", \n      \"_rev\" : \"_Tn2Y8ry--A\", \n      \"value\" : 8 \n    }, \n    { \n      \"_id\" : \"test/test9\", \n      \"_key\" : \"test9\", \n      \"_rev\" : \"_Tn2Y8ry--B\", \n      \"value\" : 9 \n    } \n  ], \n  \"error\" : false \n}\n
\n\n\n\n\n#Example:\n Looking up non-existing documents\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/lookup-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"foo\", \n    \"bar\", \n    \"baz\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 200, \n  \"documents\" : [ ], \n  \"error\" : false \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6505,12 +6587,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/near": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **distance**: If given, the attribute key used to return the distance to\n the given coordinate. (optional). If specified, distances are returned in meters.\n - **skip**: The number of documents to skip in the query. (optional)\n - **longitude**: The longitude of the coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **collection**: The name of the collection to query.\n - **latitude**: The latitude of the coordinate.\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThe default will find at most 100 documents near the given coordinate. The\nreturned array is sorted according to the distance, with the nearest document\nbeing first in the return array. If there are near documents of equal distance, documents\nare chosen randomly from this set until the limit is reached.\n\nIn order to use the *near* operator, a geo index must be defined for the\ncollection. This index also defines which attribute holds the coordinates\nfor the document. If you have more than one geo-spatial index, you can use\nthe *geo* field to select a particular index.\n\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *near* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an [AQL query](../../AQL/Functions/Geo.html) using the *NEAR* function as follows: \n\n\n FOR doc IN NEAR(@@collection, @latitude, @longitude, @limit)\n RETURN doc`\n\n\n\n\n#Example:\n Without distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11329\", \n      \"_id\" : \"products/11329\", \n      \"_rev\" : \"11329\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"_key\" : \"11323\", \n      \"_id\" : \"products/11323\", \n      \"_rev\" : \"11323\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n With distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 3, \n  \"distance\" : \"distance\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11366\", \n      \"_key\" : \"11366\", \n      \"_rev\" : \"11366\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    }, \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11372\", \n      \"_key\" : \"11372\", \n      \"_rev\" : \"11372\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"distance\" : 444.779706578235, \n      \"_id\" : \"products/11363\", \n      \"_key\" : \"11363\", \n      \"_rev\" : \"11363\", \n      \"loc\" : [ \n        -0.004, \n        0 \n      ], \n      \"name\" : \"Name/-0.004/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 3, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **distance**: If given, the attribute key used to return the distance to\n the given coordinate. (optional). If specified, distances are returned in meters.\n - **skip**: The number of documents to skip in the query. (optional)\n - **longitude**: The longitude of the coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **collection**: The name of the collection to query.\n - **latitude**: The latitude of the coordinate.\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThe default will find at most 100 documents near the given coordinate. The\nreturned array is sorted according to the distance, with the nearest document\nbeing first in the return array. If there are near documents of equal distance, documents\nare chosen randomly from this set until the limit is reached.\n\nIn order to use the *near* operator, a geo index must be defined for the\ncollection. This index also defines which attribute holds the coordinates\nfor the document. If you have more than one geo-spatial index, you can use\nthe *geo* field to select a particular index.\n\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *near* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an [AQL query](../../AQL/Functions/Geo.html) using the *NEAR* function as follows: \n\n\n FOR doc IN NEAR(@@collection, @latitude, @longitude, @limit)\n RETURN doc`\n\n\n\n\n#Example:\n Without distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10641\", \n      \"_id\" : \"products/10641\", \n      \"_rev\" : \"_Tn2Y8tK--_\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"_key\" : \"10635\", \n      \"_id\" : \"products/10635\", \n      \"_rev\" : \"_Tn2Y8tG--C\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n With distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 3, \n  \"distance\" : \"distance\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/10678\", \n      \"_key\" : \"10678\", \n      \"_rev\" : \"_Tn2Y8uC---\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    }, \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/10684\", \n      \"_key\" : \"10684\", \n      \"_rev\" : \"_Tn2Y8uC--A\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"distance\" : 444.779706578235, \n      \"_id\" : \"products/10675\", \n      \"_key\" : \"10675\", \n      \"_rev\" : \"_Tn2Y8u---B\", \n      \"loc\" : [ \n        -0.004, \n        0 \n      ], \n      \"name\" : \"Name/-0.004/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 3, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6538,12 +6620,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/range": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **right**: The upper bound.\n - **attribute**: The attribute path to check.\n - **collection**: The name of the collection to query.\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **closed**: If *true*, use interval including *left* and *right*,\n otherwise exclude *right*, but include *left*.\n - **skip**: The number of documents to skip in the query (optional).\n - **left**: The lower bound.\n\n\n\n\n\nThis will find all documents within a given range. In order to execute a\nrange query, a skip-list index on the queried attribute must be present.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *range* simple query is **deprecated** as of ArangoDB 2.6. \nThe function may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection within a specific range\nis to use an AQL query as follows: \n\n\n FOR doc IN @@collection \n FILTER doc.value >= @left && doc.value < @right \n LIMIT @skip, @limit \n RETURN doc`\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/range <<EOF\n{ \n  \"collection\" : \"products\", \n  \"attribute\" : \"i\", \n  \"left\" : 2, \n  \"right\" : 4 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11400\", \n      \"_id\" : \"products/11400\", \n      \"_rev\" : \"11400\", \n      \"i\" : 2 \n    }, \n    { \n      \"_key\" : \"11403\", \n      \"_id\" : \"products/11403\", \n      \"_rev\" : \"11403\", \n      \"i\" : 3 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **right**: The upper bound.\n - **attribute**: The attribute path to check.\n - **collection**: The name of the collection to query.\n - **limit**: The maximal amount of documents to return. The *skip*\n is applied before the *limit* restriction. (optional)\n - **closed**: If *true*, use interval including *left* and *right*,\n otherwise exclude *right*, but include *left*.\n - **skip**: The number of documents to skip in the query (optional).\n - **left**: The lower bound.\n\n\n\n\n\nThis will find all documents within a given range. In order to execute a\nrange query, a skip-list index on the queried attribute must be present.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *range* simple query is **deprecated** as of ArangoDB 2.6. \nThe function may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection within a specific range\nis to use an AQL query as follows: \n\n\n FOR doc IN @@collection \n FILTER doc.value >= @left && doc.value < @right \n LIMIT @skip, @limit \n RETURN doc`\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/range <<EOF\n{ \n  \"collection\" : \"products\", \n  \"attribute\" : \"i\", \n  \"left\" : 2, \n  \"right\" : 4 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10712\", \n      \"_id\" : \"products/10712\", \n      \"_rev\" : \"_Tn2Y8uy---\", \n      \"i\" : 2 \n    }, \n    { \n      \"_key\" : \"10715\", \n      \"_id\" : \"products/10715\", \n      \"_rev\" : \"_Tn2Y8uy--_\", \n      \"i\" : 3 \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6571,7 +6653,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/remove-by-example": { @@ -6604,12 +6686,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/remove-by-keys": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **keys**: array with the _keys of documents to remove. of type string\n - **options**:\n - **returnOld**: if set to *true* and *silent* above is *false*, then the above\n information about the removed documents contains the complete\n removed documents.\n - **silent**: if set to *false*, then the result will contain an additional\n attribute *old* which contains an array with one entry for each\n removed document. By default, these entries will have the *_id*,\n *_key* and *_rev* attributes.\n - **waitForSync**: if set to true, then all removal operations will\n instantly be synchronized to disk. If this is not specified, then the\n collection's default sync behavior will be applied.\n - **collection**: The name of the collection to look in for the documents to remove\n\n\n\n\nLooks up the documents in the specified collection using the array of keys\nprovided, and removes all documents from the collection whose keys are\ncontained in the *keys* array. Keys for which no document can be found in\nthe underlying collection are ignored, and no exception will be thrown for\nthem.\n\nThe body of the response contains a JSON object with information how many\ndocuments were removed (and how many were not). The *removed* attribute will\ncontain the number of actually removed documents. The *ignored* attribute \nwill contain the number of keys in the request for which no matching document\ncould be found.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"test0\", \n    \"test1\", \n    \"test2\", \n    \"test3\", \n    \"test4\", \n    \"test5\", \n    \"test6\", \n    \"test7\", \n    \"test8\", \n    \"test9\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"removed\" : 10, \n  \"ignored\" : 0, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"foo\", \n    \"bar\", \n    \"baz\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"removed\" : 0, \n  \"ignored\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **keys** (string): array with the _keys of documents to remove. - **options**:\n - **returnOld**: if set to *true* and *silent* above is *false*, then the above\n information about the removed documents contains the complete\n removed documents.\n - **silent**: if set to *false*, then the result will contain an additional\n attribute *old* which contains an array with one entry for each\n removed document. By default, these entries will have the *_id*,\n *_key* and *_rev* attributes.\n - **waitForSync**: if set to true, then all removal operations will\n instantly be synchronized to disk. If this is not specified, then the\n collection's default sync behavior will be applied.\n - **collection**: The name of the collection to look in for the documents to remove\n\n\n\n\nLooks up the documents in the specified collection using the array of keys\nprovided, and removes all documents from the collection whose keys are\ncontained in the *keys* array. Keys for which no document can be found in\nthe underlying collection are ignored, and no exception will be thrown for\nthem.\n\nThe body of the response contains a JSON object with information how many\ndocuments were removed (and how many were not). The *removed* attribute will\ncontain the number of actually removed documents. The *ignored* attribute \nwill contain the number of keys in the request for which no matching document\ncould be found.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"test0\", \n    \"test1\", \n    \"test2\", \n    \"test3\", \n    \"test4\", \n    \"test5\", \n    \"test6\", \n    \"test7\", \n    \"test8\", \n    \"test9\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"removed\" : 10, \n  \"ignored\" : 0, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-keys <<EOF\n{ \n  \"keys\" : [ \n    \"foo\", \n    \"bar\", \n    \"baz\" \n  ], \n  \"collection\" : \"test\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"removed\" : 0, \n  \"ignored\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6637,7 +6719,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/replace-by-example": { @@ -6670,7 +6752,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/update-by-example": { @@ -6703,12 +6785,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/within": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **distance**: If given, the attribute key used to return the distance to\n the given coordinate. (optional). If specified, distances are returned in meters.\n - **skip**: The number of documents to skip in the query. (optional)\n - **longitude**: The longitude of the coordinate.\n - **radius**: The maximal radius (in meters).\n - **collection**: The name of the collection to query.\n - **latitude**: The latitude of the coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThis will find all documents within a given radius around the coordinate\n(*latitude*, *longitude*). The returned list is sorted by distance.\n\nIn order to use the *within* operator, a geo index must be defined for\nthe collection. This index also defines which attribute holds the\ncoordinates for the document. If you have more than one geo-spatial index,\nyou can use the *geo* field to select a particular index.\n\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *within* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an [AQL query](../../AQL/Functions/Geo.html) using the *WITHIN* function as follows: \n\n\n FOR doc IN WITHIN(@@collection, @latitude, @longitude, @radius, @distanceAttributeName)\n RETURN doc\n\n\n\n\n#Example:\n Without distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 2, \n  \"radius\" : 500 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11686\", \n      \"_id\" : \"products/11686\", \n      \"_rev\" : \"11686\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"_key\" : \"11680\", \n      \"_id\" : \"products/11680\", \n      \"_rev\" : \"11680\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n With distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 3, \n  \"distance\" : \"distance\", \n  \"radius\" : 300 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11723\", \n      \"_key\" : \"11723\", \n      \"_rev\" : \"11723\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    }, \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11729\", \n      \"_key\" : \"11729\", \n      \"_rev\" : \"11729\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"distance\" : 444.779706578235, \n      \"_id\" : \"products/11720\", \n      \"_key\" : \"11720\", \n      \"_rev\" : \"11720\", \n      \"loc\" : [ \n        -0.004, \n        0 \n      ], \n      \"name\" : \"Name/-0.004/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 3, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **distance**: If given, the attribute key used to return the distance to\n the given coordinate. (optional). If specified, distances are returned in meters.\n - **skip**: The number of documents to skip in the query. (optional)\n - **longitude**: The longitude of the coordinate.\n - **radius**: The maximal radius (in meters).\n - **collection**: The name of the collection to query.\n - **latitude**: The latitude of the coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThis will find all documents within a given radius around the coordinate\n(*latitude*, *longitude*). The returned list is sorted by distance.\n\nIn order to use the *within* operator, a geo index must be defined for\nthe collection. This index also defines which attribute holds the\ncoordinates for the document. If you have more than one geo-spatial index,\nyou can use the *geo* field to select a particular index.\n\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\nNote: the *within* simple query is **deprecated** as of ArangoDB 2.6. \nThis API may be removed in future versions of ArangoDB. The preferred\nway for retrieving documents from a collection using the near operator is\nto issue an [AQL query](../../AQL/Functions/Geo.html) using the *WITHIN* function as follows: \n\n\n FOR doc IN WITHIN(@@collection, @latitude, @longitude, @radius, @distanceAttributeName)\n RETURN doc\n\n\n\n\n#Example:\n Without distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 2, \n  \"radius\" : 500 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"10958\", \n      \"_id\" : \"products/10958\", \n      \"_rev\" : \"_Tn2Y81O--B\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"_key\" : \"10952\", \n      \"_id\" : \"products/10952\", \n      \"_rev\" : \"_Tn2Y81O--_\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n#Example:\n With distance\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/near <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude\" : 0, \n  \"longitude\" : 0, \n  \"skip\" : 1, \n  \"limit\" : 3, \n  \"distance\" : \"distance\", \n  \"radius\" : 300 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/10995\", \n      \"_key\" : \"10995\", \n      \"_rev\" : \"_Tn2Y82C--_\", \n      \"loc\" : [ \n        -0.002, \n        0 \n      ], \n      \"name\" : \"Name/-0.002/\" \n    }, \n    { \n      \"distance\" : 222.38985328911744, \n      \"_id\" : \"products/11001\", \n      \"_key\" : \"11001\", \n      \"_rev\" : \"_Tn2Y82C--B\", \n      \"loc\" : [ \n        0.002, \n        0 \n      ], \n      \"name\" : \"Name/0.002/\" \n    }, \n    { \n      \"distance\" : 444.779706578235, \n      \"_id\" : \"products/10992\", \n      \"_key\" : \"10992\", \n      \"_rev\" : \"_Tn2Y82C---\", \n      \"loc\" : [ \n        -0.004, \n        0 \n      ], \n      \"name\" : \"Name/-0.004/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 3, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6736,12 +6818,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/simple/within-rectangle": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **latitude1**: The latitude of the first rectangle coordinate.\n - **skip**: The number of documents to skip in the query. (optional)\n - **latitude2**: The latitude of the second rectangle coordinate.\n - **longitude2**: The longitude of the second rectangle coordinate.\n - **longitude1**: The longitude of the first rectangle coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **collection**: The name of the collection to query.\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThis will find all documents within the specified rectangle (determined by\nthe given coordinates (*latitude1*, *longitude1*, *latitude2*, *longitude2*). \n\nIn order to use the *within-rectangle* query, a geo index must be defined for\nthe collection. This index also defines which attribute holds the\ncoordinates for the document. If you have more than one geo-spatial index,\nyou can use the *geo* field to select a particular index.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/within-rectangle <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude1\" : 0, \n  \"longitude1\" : 0, \n  \"latitude2\" : 0.2, \n  \"longitude2\" : 0.2, \n  \"skip\" : 1, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11781\", \n      \"_id\" : \"products/11781\", \n      \"_rev\" : \"11781\", \n      \"loc\" : [ \n        0.008, \n        0 \n      ], \n      \"name\" : \"Name/0.008/\" \n    }, \n    { \n      \"_key\" : \"11778\", \n      \"_id\" : \"products/11778\", \n      \"_rev\" : \"11778\", \n      \"loc\" : [ \n        0.006, \n        0 \n      ], \n      \"name\" : \"Name/0.006/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **latitude1**: The latitude of the first rectangle coordinate.\n - **skip**: The number of documents to skip in the query. (optional)\n - **latitude2**: The latitude of the second rectangle coordinate.\n - **longitude2**: The longitude of the second rectangle coordinate.\n - **longitude1**: The longitude of the first rectangle coordinate.\n - **limit**: The maximal amount of documents to return. The *skip* is\n applied before the *limit* restriction. The default is 100. (optional)\n - **collection**: The name of the collection to query.\n - **geo**: If given, the identifier of the geo-index to use. (optional)\n\n\n\n\n\nThis will find all documents within the specified rectangle (determined by\nthe given coordinates (*latitude1*, *longitude1*, *latitude2*, *longitude2*). \n\nIn order to use the *within-rectangle* query, a geo index must be defined for\nthe collection. This index also defines which attribute holds the\ncoordinates for the document. If you have more than one geo-spatial index,\nyou can use the *geo* field to select a particular index.\n\nReturns a cursor containing the result, see [Http Cursor](../AqlQueryCursor/README.md) for details.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/within-rectangle <<EOF\n{ \n  \"collection\" : \"products\", \n  \"latitude1\" : 0, \n  \"longitude1\" : 0, \n  \"latitude2\" : 0.2, \n  \"longitude2\" : 0.2, \n  \"skip\" : 1, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"_key\" : \"11053\", \n      \"_id\" : \"products/11053\", \n      \"_rev\" : \"_Tn2Y82y--E\", \n      \"loc\" : [ \n        0.008, \n        0 \n      ], \n      \"name\" : \"Name/0.008/\" \n    }, \n    { \n      \"_key\" : \"11050\", \n      \"_id\" : \"products/11050\", \n      \"_rev\" : \"_Tn2Y82y--D\", \n      \"loc\" : [ \n        0.006, \n        0 \n      ], \n      \"name\" : \"Name/0.006/\" \n    } \n  ], \n  \"hasMore\" : false, \n  \"count\" : 2, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6769,12 +6851,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md" } }, "/_api/tasks": { "post": { - "description": "**A json post document 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\ncreates a new task with a generated id\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/tasks/ <<EOF\n{ \n  \"name\" : \"SampleTask\", \n  \"command\" : \"(function(params) { require('internal').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\n\n{ \n  \"id\" : \"11792\", \n  \"name\" : \"SampleTask\", \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"created\" : 1466169143.759251, \n  \"command\" : \"(function(params) { require('internal').print(params); })(params)\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/tasks/11792\n\n
\n\n\n\n\n", + "description": "**A json post document 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\ncreates a new task with a generated id\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/tasks/ <<EOF\n{ \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\n\n{ \n  \"id\" : \"11064\", \n  \"name\" : \"SampleTask\", \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"created\" : 1471531383.701037, \n  \"command\" : \"(function(params) { require('@arangodb').print(params); })(params)\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\nshell> curl -X DELETE --dump - http://localhost:8529/_api/tasks/11064\n\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6796,12 +6878,12 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_api/tasks/": { "get": { - "description": "\n\nfetches all existing tasks on the server\n\n\n\n\n#Example:\n Fetching all tasks\n\n
shell> curl --dump - http://localhost:8529/_api/tasks\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  { \n    \"id\" : \"statistics-gc\", \n    \"name\" : \"statistics-gc\", \n    \"type\" : \"periodic\", \n    \"period\" : 450, \n    \"created\" : 1466169056.480405, \n    \"command\" : \"require('@arangodb/statistics').garbageCollector();\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"statistics-average-collector\", \n    \"name\" : \"statistics-average-collector\", \n    \"type\" : \"periodic\", \n    \"period\" : 900, \n    \"created\" : 1466169056.480054, \n    \"command\" : \"require('@arangodb/statistics').historianAverage();\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"statistics-collector\", \n    \"name\" : \"statistics-collector\", \n    \"type\" : \"periodic\", \n    \"period\" : 10, \n    \"created\" : 1466169056.479813, \n    \"command\" : \"require('@arangodb/statistics').historian();\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"88\", \n    \"name\" : \"user-defined task\", \n    \"type\" : \"periodic\", \n    \"period\" : 1, \n    \"created\" : 1466169046.617287, \n    \"command\" : \"(function () {\\n        require('@arangodb/foxx/queues/manager').manage();\\n      })(params)\", \n    \"database\" : \"_system\" \n  } \n]\n
\n\n\n\n\n", + "description": "\n\nfetches all existing tasks on the server\n\n\n\n\n#Example:\n Fetching all tasks\n\n
shell> curl --dump - http://localhost:8529/_api/tasks\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n[ \n  { \n    \"id\" : \"statistics-gc\", \n    \"name\" : \"statistics-gc\", \n    \"type\" : \"periodic\", \n    \"period\" : 450, \n    \"created\" : 1471531346.339777, \n    \"command\" : \"require('@arangodb/statistics').garbageCollector();\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"statistics-average-collector\", \n    \"name\" : \"statistics-average-collector\", \n    \"type\" : \"periodic\", \n    \"period\" : 900, \n    \"created\" : 1471531346.339429, \n    \"command\" : \"require('@arangodb/statistics').historianAverage();\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"statistics-collector\", \n    \"name\" : \"statistics-collector\", \n    \"type\" : \"periodic\", \n    \"period\" : 10, \n    \"created\" : 1471531346.339196, \n    \"command\" : \"require('@arangodb/statistics').historian();\", \n    \"database\" : \"_system\" \n  }, \n  { \n    \"id\" : \"86\", \n    \"name\" : \"user-defined task\", \n    \"type\" : \"periodic\", \n    \"period\" : 1, \n    \"created\" : 1471531310.896084, \n    \"command\" : \"(function () {\\n        require('@arangodb/foxx/queues/manager').manage();\\n      })(params)\", \n    \"database\" : \"_system\" \n  } \n]\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -6813,7 +6895,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_api/tasks/{id}": { @@ -6839,10 +6921,10 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" }, "get": { - "description": "\n\nfetches one existing tasks on the server specified by *id*\n\n\n\n\n#Example:\n Fetching a single task by its id\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/statistics-average-collector\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"statistics-average-collector\", \n  \"name\" : \"statistics-average-collector\", \n  \"type\" : \"periodic\", \n  \"period\" : 900, \n  \"created\" : 1466169056.480054, \n  \"command\" : \"require('@arangodb/statistics').historianAverage();\", \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\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1852, \n  \"errorMessage\" : \"task not found\" \n}\n
\n\n\n\n\n", + "description": "\n\nfetches one existing tasks on the server specified by *id*\n\n\n\n\n#Example:\n Fetching a single task by its id\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/statistics-average-collector\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"id\" : \"statistics-average-collector\", \n  \"name\" : \"statistics-average-collector\", \n  \"type\" : \"periodic\", \n  \"period\" : 900, \n  \"created\" : 1471531346.339429, \n  \"command\" : \"require('@arangodb/statistics').historianAverage();\", \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\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1852, \n  \"errorMessage\" : \"task not found\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the task to fetch.\n\n", @@ -6863,10 +6945,10 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" }, "put": { - "description": "**A json post document 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('internal').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\n\n{ \n  \"id\" : \"sampleTask\", \n  \"name\" : \"SampleTask\", \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"created\" : 1466169143.796633, \n  \"command\" : \"(function(params) { require('internal').print(params); })(params)\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "**A json post document 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\n\n{ \n  \"id\" : \"sampleTask\", \n  \"name\" : \"SampleTask\", \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"created\" : 1471531383.715269, \n  \"command\" : \"(function(params) { require('@arangodb').print(params); })(params)\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [ { "description": "The id of the task to create\n\n", @@ -6896,12 +6978,12 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } }, "/_api/transaction": { "post": { - "description": "**A json post document with these Properties is required:**\n\n - **action**: the actual transaction operations to be executed, in the\n form of stringified JavaScript code. The code will be executed on server\n side, with late binding. It is thus critical that the code specified in\n *action* properly sets up all the variables it needs.\n If the code specified in *action* ends with a return statement, the\n value returned will also be returned by the REST API in the *result*\n attribute if the transaction committed successfully.\n - **params**: optional arguments passed to *action*.\n - **collections**: contains the array of collections to be used in the\n transaction (mandatory). *collections* must be a JSON object that can\n have the optional sub-attributes *read* and *write*. *read*\n and *write* must each be either arrays of collections names or strings\n with a single collection name.\n - **lockTimeout**: an optional numeric value that can be used to set a\n timeout for waiting on collection locks. If not specified, a default\n value will be used. Setting *lockTimeout* to *0* will make ArangoDB\n not time out waiting for a lock.\n - **waitForSync**: an optional boolean flag that, if set, will force the\n transaction to write all data to disk before returning.\n\n\n\n\n\nContains the *collections* and *action*.\n\nThe transaction description must be passed in the body of the POST request.\n\nIf the transaction is fully executed and committed on the server,\n*HTTP 200* will be returned. Additionally, the return value of the\ncode defined in *action* will be returned in the *result* attribute.\n\nFor successfully committed transactions, the returned JSON object has the\nfollowing properties:\n\n- *error*: boolean flag to indicate if an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: the return value of the transaction\n\nIf the transaction specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\nThe body of the response will then contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\nIf a transaction fails to commit, either by an exception thrown in the\n*action* code, or by an internal error, the server will respond with\nan error.\nAny other errors will be returned with any of the return codes\n*HTTP 400*, *HTTP 409*, or *HTTP 500*.\n\n\n\n\n#Example:\n Executing a transaction on a single collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : \"products\" \n  }, \n  \"action\" : \"function () { var db = require('internal').db; db.products.save({});  return db.products.count(); }\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Executing a transaction using multiple collections\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : [ \n      \"products\", \n      \"materials\" \n    ] \n  }, \n  \"action\" : \"function () {var db = require('internal').db;db.products.save({});db.materials.save({});return 'worked!';}\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : \"worked!\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Aborting a transaction due to an internal error\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : \"products\" \n  }, \n  \"action\" : \"function () {var db = require('internal').db;db.products.save({ _key: 'abc'});db.products.save({ _key: 'abc'});}\" \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"exception\" : \"ArangoError 1210: unique constraint violated\", \n  \"stacktrace\" : [ \n    \"ArangoError: unique constraint violated\", \n    \"    at Error (native)\", \n    \"    at eval (eval at post_api_transaction (js/actions/api-transaction.js:49:16), <anonymous>:3:99)\", \n    \"    at eval (eval at post_api_transaction (js/actions/api-transaction.js:49:16), <anonymous>:3:122)\", \n    \"    at post_api_transaction (js/actions/api-transaction.js:49:16)\", \n    \"    at Function.actions.defineHttp.callback (js/actions/api-transaction.js:66:11)\" \n  ], \n  \"message\" : \"unique constraint violated\", \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1210, \n  \"errorMessage\" : \"unique constraint violated\" \n}\n
\n\n\n\n\n#Example:\n Aborting a transaction by explicitly throwing an exception\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : \"products\" \n  }, \n  \"action\" : \"function () { throw 'doh!'; }\" \n}\nEOF\n\nHTTP/1.1 500 Internal Server Error\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"exception\" : \"doh!\", \n  \"error\" : true, \n  \"code\" : 500, \n  \"errorNum\" : 500, \n  \"errorMessage\" : \"internal server error\" \n}\n
\n\n\n\n\n#Example:\n Referring to a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : \"products\" \n  }, \n  \"action\" : \"function () { return true; }\" \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"exception\" : \"ArangoError 1203: collection not found\", \n  \"stacktrace\" : [ \n    \"ArangoError: collection not found\", \n    \"    at Error (native)\", \n    \"    at post_api_transaction (js/actions/api-transaction.js:49:16)\", \n    \"    at Function.actions.defineHttp.callback (js/actions/api-transaction.js:66:11)\" \n  ], \n  \"message\" : \"collection not found\", \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1203, \n  \"errorMessage\" : \"collection not found\" \n}\n
\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **action**: the actual transaction operations to be executed, in the\n form of stringified JavaScript code. The code will be executed on server\n side, with late binding. It is thus critical that the code specified in\n *action* properly sets up all the variables it needs.\n If the code specified in *action* ends with a return statement, the\n value returned will also be returned by the REST API in the *result*\n attribute if the transaction committed successfully.\n - **params**: optional arguments passed to *action*.\n - **collections**: contains the array of collections to be used in the\n transaction (mandatory). *collections* must be a JSON object that can\n have the optional sub-attributes *read* and *write*. *read*\n and *write* must each be either arrays of collections names or strings\n with a single collection name.\n - **lockTimeout**: an optional numeric value that can be used to set a\n timeout for waiting on collection locks. If not specified, a default\n value will be used. Setting *lockTimeout* to *0* will make ArangoDB\n not time out waiting for a lock.\n - **waitForSync**: an optional boolean flag that, if set, will force the\n transaction to write all data to disk before returning.\n\n\n\n\n\nContains the *collections* and *action*.\n\nThe transaction description must be passed in the body of the POST request.\n\nIf the transaction is fully executed and committed on the server,\n*HTTP 200* will be returned. Additionally, the return value of the\ncode defined in *action* will be returned in the *result* attribute.\n\nFor successfully committed transactions, the returned JSON object has the\nfollowing properties:\n\n- *error*: boolean flag to indicate if an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: the return value of the transaction\n\nIf the transaction specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\nThe body of the response will then contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\nIf a transaction fails to commit, either by an exception thrown in the\n*action* code, or by an internal error, the server will respond with\nan error.\nAny other errors will be returned with any of the return codes\n*HTTP 400*, *HTTP 409*, or *HTTP 500*.\n\n\n\n\n#Example:\n Executing a transaction on a single collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : \"products\" \n  }, \n  \"action\" : \"function () { var db = require('@arangodb').db; db.products.save({});  return db.products.count(); }\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Executing a transaction using multiple collections\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : [ \n      \"products\", \n      \"materials\" \n    ] \n  }, \n  \"action\" : \"function () {var db = require('@arangodb').db;db.products.save({});db.materials.save({});return 'worked!';}\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : \"worked!\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Aborting a transaction due to an internal error\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"write\" : \"products\" \n  }, \n  \"action\" : \"function () {var db = require('@arangodb').db;db.products.save({ _key: 'abc'});db.products.save({ _key: 'abc'});}\" \n}\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"exception\" : \"ArangoError 1210: unique constraint violated\", \n  \"stacktrace\" : [ \n    \"ArangoError: unique constraint violated\", \n    \"    at Error (native)\", \n    \"    at eval (eval at post_api_transaction (js/actions/api-transaction.js:48:16), <anonymous>:3:100)\", \n    \"    at eval (eval at post_api_transaction (js/actions/api-transaction.js:48:16), <anonymous>:3:123)\", \n    \"    at post_api_transaction (js/actions/api-transaction.js:48:16)\", \n    \"    at Function.actions.defineHttp.callback (js/actions/api-transaction.js:64:11)\" \n  ], \n  \"message\" : \"unique constraint violated\", \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 1210, \n  \"errorMessage\" : \"unique constraint violated\" \n}\n
\n\n\n\n\n#Example:\n Aborting a transaction by explicitly throwing an exception\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : \"products\" \n  }, \n  \"action\" : \"function () { throw 'doh!'; }\" \n}\nEOF\n\nHTTP/1.1 500 Internal Server Error\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"exception\" : \"doh!\", \n  \"error\" : true, \n  \"code\" : 500, \n  \"errorNum\" : 500, \n  \"errorMessage\" : \"internal server error\" \n}\n
\n\n\n\n\n#Example:\n Referring to a non-existing collection\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/transaction <<EOF\n{ \n  \"collections\" : { \n    \"read\" : \"products\" \n  }, \n  \"action\" : \"function () { return true; }\" \n}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"exception\" : \"ArangoError 1203: collection not found\", \n  \"stacktrace\" : [ \n    \"ArangoError: collection not found\", \n    \"    at Error (native)\", \n    \"    at post_api_transaction (js/actions/api-transaction.js:48:16)\", \n    \"    at Function.actions.defineHttp.callback (js/actions/api-transaction.js:64:11)\" \n  ], \n  \"message\" : \"collection not found\", \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1203, \n  \"errorMessage\" : \"collection not found\" \n}\n
\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6932,12 +7014,12 @@ "Transactions" ], "x-examples": [], - "x-filename": "Transactions - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" + "x-filename": "Transactions - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" } }, "/_api/traversal": { "post": { - "description": "\n\nStarts a traversal starting from a given vertex and following.\nedges contained in a given edgeCollection. The request must\ncontain the following attributes.\n\n**A json post document with these Properties is required:**\n\n - **sort**: body (JavaScript) code of a custom comparison function\n for the edges. The signature of this function is\n *(l, r) -> integer* (where l and r are edges) and must\n return -1 if l is smaller than, +1 if l is greater than,\n and 0 if l and r are equal. The reason for this is the\n following: The order of edges returned for a certain\n vertex is undefined. This is because there is no natural\n order of edges for a vertex with multiple connected edges.\n To explicitly define the order in which edges on the\n vertex are followed, you can specify an edge comparator\n function with this attribute. Note that the value here has\n to be a string to conform to the JSON standard, which in\n turn is parsed as function body on the server side. Furthermore\n note that this attribute is only used for the standard\n expanders. If you use your custom expander you have to\n do the sorting yourself within the expander code.\n - **direction**: direction for traversal\n - *if set*, must be either *\"outbound\"*, *\"inbound\"*, or *\"any\"*\n - *if not set*, the *expander* attribute must be specified\n - **minDepth**: ANDed with any existing filters):\n visits only nodes in at least the given depth\n - **startVertex**: id of the startVertex, e.g. *\"users/foo\"*.\n - **visitor**: body (JavaScript) code of custom visitor function\n function signature: *(config, result, vertex, path, connected) -> void*\n The visitor function can do anything, but its return value is ignored. To\n populate a result, use the *result* variable by reference. Note that the\n *connected* argument is only populated when the *order* attribute is set\n to *\"preorder-expander\"*.\n - **itemOrder**: item iteration order can be *\"forward\"* or *\"backward\"*\n - **strategy**: traversal strategy can be *\"depthfirst\"* or *\"breadthfirst\"*\n - **filter**: default is to include all nodes:\n body (JavaScript code) of custom filter function\n function signature: *(config, vertex, path) -> mixed*\n can return four different string values:\n - *\"exclude\"* -> this vertex will not be visited.\n - *\"prune\"* -> the edges of this vertex will not be followed.\n - *\"\"* or *undefined* -> visit the vertex and follow it's edges.\n - *Array* -> containing any combination of the above.\n If there is at least one *\"exclude\"* or *\"prune\"* respectivly\n is contained, it's effect will occur.\n - **init**: body (JavaScript) code of custom result initialization function\n function signature: *(config, result) -> void*\n initialize any values in result with what is required\n - **maxIterations**: Maximum number of iterations in each traversal. This number can be\n set to prevent endless loops in traversal of cyclic graphs. When a traversal performs\n as many iterations as the *maxIterations* value, the traversal will abort with an\n error. If *maxIterations* is not set, a server-defined value may be used.\n - **maxDepth**: ANDed with any existing filters visits only nodes in at most the given depth\n - **uniqueness**: specifies uniqueness for vertices and edges visited\n if set, must be an object like this:\n *\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}*\n - **order**: traversal order can be *\"preorder\"*, *\"postorder\"* or *\"preorder-expander\"*\n - **graphName**: name of the graph that contains the edges.\n Either *edgeCollection* or *graphName* has to be given.\n In case both values are set the *graphName* is prefered.\n - **expander**: body (JavaScript) code of custom expander function\n *must* be set if *direction* attribute is **not** set\n function signature: *(config, vertex, path) -> array*\n expander must return an array of the connections for *vertex*\n each connection is an object with the attributes *edge* and *vertex*\n - **edgeCollection**: name of the collection that contains the edges.\n\n\n\n\n\nIf the Traversal is successfully executed *HTTP 200* will be returned.\nAdditionally the *result* object will be returned by the traversal.\n\nFor successful traversals, the returned JSON object has the\nfollowing properties:\n\n- *error*: boolean flag to indicate if an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: the return value of the traversal\n\nIf the traversal specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\nThe body of the response will then contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\n\n\n\n#Example:\n In the following examples the underlying graph will contain five persons\n*Alice*, *Bob*, *Charlie*, *Dave* and *Eve*.\nWe will have the following directed relations:\n - *Alice* knows *Bob*\n - *Bob* knows *Charlie*\n - *Bob* knows *Dave*\n - *Eve* knows *Alice*\n - *Eve* knows *Bob*\n\nThe starting vertex will always be Alice.\n\nFollow only outbound edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12598\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12602\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12605\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12608\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12598\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12614\", \n              \"_id\" : \"knows/12614\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12614\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12598\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12602\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12614\", \n              \"_id\" : \"knows/12614\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12614\" \n            }, \n            { \n              \"_key\" : \"12618\", \n              \"_id\" : \"knows/12618\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12618\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12598\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12602\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12605\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12614\", \n              \"_id\" : \"knows/12614\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12614\" \n            }, \n            { \n              \"_key\" : \"12621\", \n              \"_id\" : \"knows/12621\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12621\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12598\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12602\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12608\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow only inbound edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"inbound\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12314\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12327\", \n          \"name\" : \"Eve\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12314\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12340\", \n              \"_id\" : \"knows/12340\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12340\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12314\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12327\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow any direction of edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"global\" \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"11855\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"11859\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"11862\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"11865\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"11868\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"11855\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11871\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11859\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11871\" \n            }, \n            { \n              \"_key\" : \"11875\", \n              \"_id\" : \"knows/11875\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"11875\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11859\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"11862\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11871\" \n            }, \n            { \n              \"_key\" : \"11878\", \n              \"_id\" : \"knows/11878\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"11878\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11859\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"11865\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11871\" \n            }, \n            { \n              \"_key\" : \"11884\", \n              \"_id\" : \"knows/11884\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11884\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11859\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11868\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11871\" \n            }, \n            { \n              \"_key\" : \"11884\", \n              \"_id\" : \"knows/11884\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11884\" \n            }, \n            { \n              \"_key\" : \"11881\", \n              \"_id\" : \"knows/11881\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11881\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11859\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11868\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11855\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Excluding *Charlie* and *Bob*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"filter\" : \"if (vertex.name === \\\"Bob\\\" ||     vertex.name === \\\"Charlie\\\") {  return \\\"exclude\\\";}return;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12189\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12199\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12189\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12205\", \n              \"_id\" : \"knows/12205\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12205\" \n            }, \n            { \n              \"_key\" : \"12212\", \n              \"_id\" : \"knows/12212\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12212\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12189\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12193\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12199\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Do not follow edges from *Bob*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"filter\" : \"if (vertex.name === \\\"Bob\\\") {return \\\"prune\\\";}return;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12254\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12258\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12254\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12270\", \n              \"_id\" : \"knows/12270\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12270\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12254\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12258\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Visit only nodes in a depth of at least 2\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"minDepth\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12540\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12543\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12549\", \n              \"_id\" : \"knows/12549\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12549\" \n            }, \n            { \n              \"_key\" : \"12553\", \n              \"_id\" : \"knows/12553\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12553\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12533\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12537\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12540\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12549\", \n              \"_id\" : \"knows/12549\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12549\" \n            }, \n            { \n              \"_key\" : \"12556\", \n              \"_id\" : \"knows/12556\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12556\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12533\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12537\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12543\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Visit only nodes in a depth of at most 1\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"maxDepth\" : 1 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12375\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12379\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12375\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12391\", \n              \"_id\" : \"knows/12391\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12391\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12375\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12379\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a visitor function to return vertex ids only\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"visitor\" : \"result.visited.vertices.push(vertex._id);\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        \"persons/alice\", \n        \"persons/bob\", \n        \"persons/charlie\", \n        \"persons/dave\" \n      ], \n      \"paths\" : [ ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Count all visited nodes and return a list of nodes only\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"init\" : \"result.visited = 0; result.myVertices = [ ];\", \n  \"visitor\" : \"result.visited++; result.myVertices.push(vertex);\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : 4, \n    \"myVertices\" : [ \n      { \n        \"_key\" : \"alice\", \n        \"_id\" : \"persons/alice\", \n        \"_rev\" : \"12754\", \n        \"name\" : \"Alice\" \n      }, \n      { \n        \"_key\" : \"bob\", \n        \"_id\" : \"persons/bob\", \n        \"_rev\" : \"12758\", \n        \"name\" : \"Bob\" \n      }, \n      { \n        \"_key\" : \"charlie\", \n        \"_id\" : \"persons/charlie\", \n        \"_rev\" : \"12761\", \n        \"name\" : \"Charlie\" \n      }, \n      { \n        \"_key\" : \"dave\", \n        \"_id\" : \"persons/dave\", \n        \"_rev\" : \"12764\", \n        \"name\" : \"Dave\" \n      } \n    ] \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Expand only inbound edges of *Alice* and outbound edges of *Eve*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"expander\" : \"var connections = [ ];if (vertex.name === \\\"Alice\\\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\\\"internal\\\").db._document(e._from), edge: e});});}if (vertex.name === \\\"Eve\\\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\\\"internal\\\").db._document(e._to), edge: e});});}return connections;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12819\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12832\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12823\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12819\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12845\", \n              \"_id\" : \"knows/12845\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12845\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12819\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12832\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12845\", \n              \"_id\" : \"knows/12845\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12845\" \n            }, \n            { \n              \"_key\" : \"12848\", \n              \"_id\" : \"knows/12848\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12848\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12819\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12832\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12823\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow the *depthfirst* strategy\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"strategy\" : \"depthfirst\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12022\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12026\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12029\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12032\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12035\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12022\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12035\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12026\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12029\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12032\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12022\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12038\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12038\" \n            }, \n            { \n              \"_key\" : \"12042\", \n              \"_id\" : \"knows/12042\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12042\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12029\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12038\" \n            }, \n            { \n              \"_key\" : \"12045\", \n              \"_id\" : \"knows/12045\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12045\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12032\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12038\" \n            }, \n            { \n              \"_key\" : \"12051\", \n              \"_id\" : \"knows/12051\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12051\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12038\" \n            }, \n            { \n              \"_key\" : \"12051\", \n              \"_id\" : \"knows/12051\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12051\" \n            }, \n            { \n              \"_key\" : \"12048\", \n              \"_id\" : \"knows/12048\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12048\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12048\", \n              \"_id\" : \"knows/12048\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12048\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12048\", \n              \"_id\" : \"knows/12048\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12048\" \n            }, \n            { \n              \"_key\" : \"12051\", \n              \"_id\" : \"knows/12051\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12051\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12048\", \n              \"_id\" : \"knows/12048\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12048\" \n            }, \n            { \n              \"_key\" : \"12051\", \n              \"_id\" : \"knows/12051\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12051\" \n            }, \n            { \n              \"_key\" : \"12042\", \n              \"_id\" : \"knows/12042\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12042\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12029\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12048\", \n              \"_id\" : \"knows/12048\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12048\" \n            }, \n            { \n              \"_key\" : \"12051\", \n              \"_id\" : \"knows/12051\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12051\" \n            }, \n            { \n              \"_key\" : \"12045\", \n              \"_id\" : \"knows/12045\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12045\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12032\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12048\", \n              \"_id\" : \"knows/12048\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12048\" \n            }, \n            { \n              \"_key\" : \"12051\", \n              \"_id\" : \"knows/12051\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12051\" \n            }, \n            { \n              \"_key\" : \"12038\", \n              \"_id\" : \"knows/12038\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12038\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12035\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12026\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12022\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using *postorder* ordering\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"order\" : \"postorder\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12670\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12673\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12663\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12676\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12667\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12670\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12673\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12663\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12667\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12676\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12663\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12679\", \n              \"_id\" : \"knows/12679\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12679\" \n            }, \n            { \n              \"_key\" : \"12683\", \n              \"_id\" : \"knows/12683\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12683\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12670\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12679\", \n              \"_id\" : \"knows/12679\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12679\" \n            }, \n            { \n              \"_key\" : \"12686\", \n              \"_id\" : \"knows/12686\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12686\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12673\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12679\", \n              \"_id\" : \"knows/12679\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12679\" \n            }, \n            { \n              \"_key\" : \"12692\", \n              \"_id\" : \"knows/12692\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12692\" \n            }, \n            { \n              \"_key\" : \"12689\", \n              \"_id\" : \"knows/12689\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12689\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12679\", \n              \"_id\" : \"knows/12679\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12679\" \n            }, \n            { \n              \"_key\" : \"12692\", \n              \"_id\" : \"knows/12692\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12692\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12679\", \n              \"_id\" : \"knows/12679\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12679\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12689\", \n              \"_id\" : \"knows/12689\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12689\" \n            }, \n            { \n              \"_key\" : \"12692\", \n              \"_id\" : \"knows/12692\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12692\" \n            }, \n            { \n              \"_key\" : \"12683\", \n              \"_id\" : \"knows/12683\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12683\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12670\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12689\", \n              \"_id\" : \"knows/12689\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12689\" \n            }, \n            { \n              \"_key\" : \"12692\", \n              \"_id\" : \"knows/12692\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12692\" \n            }, \n            { \n              \"_key\" : \"12686\", \n              \"_id\" : \"knows/12686\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12686\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12673\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12689\", \n              \"_id\" : \"knows/12689\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12689\" \n            }, \n            { \n              \"_key\" : \"12692\", \n              \"_id\" : \"knows/12692\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12692\" \n            }, \n            { \n              \"_key\" : \"12679\", \n              \"_id\" : \"knows/12679\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12679\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12689\", \n              \"_id\" : \"knows/12689\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12689\" \n            }, \n            { \n              \"_key\" : \"12692\", \n              \"_id\" : \"knows/12692\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12692\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12667\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12689\", \n              \"_id\" : \"knows/12689\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12689\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12676\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12663\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using *backward* item-ordering:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"itemOrder\" : \"backward\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"11931\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"11944\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"11935\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"11931\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"11941\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"11938\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"11935\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"11944\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"11931\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"11941\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"11938\", \n          \"name\" : \"Charlie\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11957\", \n              \"_id\" : \"knows/11957\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11957\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11957\", \n              \"_id\" : \"knows/11957\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11957\" \n            }, \n            { \n              \"_key\" : \"11960\", \n              \"_id\" : \"knows/11960\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11960\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11957\", \n              \"_id\" : \"knows/11957\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11957\" \n            }, \n            { \n              \"_key\" : \"11960\", \n              \"_id\" : \"knows/11960\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11960\" \n            }, \n            { \n              \"_key\" : \"11947\", \n              \"_id\" : \"knows/11947\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11947\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11957\", \n              \"_id\" : \"knows/11957\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11957\" \n            }, \n            { \n              \"_key\" : \"11960\", \n              \"_id\" : \"knows/11960\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11960\" \n            }, \n            { \n              \"_key\" : \"11954\", \n              \"_id\" : \"knows/11954\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"11954\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"11941\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11957\", \n              \"_id\" : \"knows/11957\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11957\" \n            }, \n            { \n              \"_key\" : \"11960\", \n              \"_id\" : \"knows/11960\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11960\" \n            }, \n            { \n              \"_key\" : \"11951\", \n              \"_id\" : \"knows/11951\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"11951\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"11938\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11947\", \n              \"_id\" : \"knows/11947\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11947\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11947\", \n              \"_id\" : \"knows/11947\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11947\" \n            }, \n            { \n              \"_key\" : \"11960\", \n              \"_id\" : \"knows/11960\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11960\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11947\", \n              \"_id\" : \"knows/11947\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11947\" \n            }, \n            { \n              \"_key\" : \"11960\", \n              \"_id\" : \"knows/11960\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11960\" \n            }, \n            { \n              \"_key\" : \"11957\", \n              \"_id\" : \"knows/11957\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"11957\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"11944\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11947\", \n              \"_id\" : \"knows/11947\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11947\" \n            }, \n            { \n              \"_key\" : \"11954\", \n              \"_id\" : \"knows/11954\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"11954\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"11941\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11947\", \n              \"_id\" : \"knows/11947\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"11947\" \n            }, \n            { \n              \"_key\" : \"11951\", \n              \"_id\" : \"knows/11951\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"11951\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"11931\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"11935\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"11938\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Edges should only be included once globally,\nbut nodes are included every time they are visited\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"global\" \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12113\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"12117\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"12120\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"12123\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"12126\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"12113\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12129\", \n              \"_id\" : \"knows/12129\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12129\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12117\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12129\", \n              \"_id\" : \"knows/12129\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12129\" \n            }, \n            { \n              \"_key\" : \"12133\", \n              \"_id\" : \"knows/12133\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"12133\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12117\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"12120\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12129\", \n              \"_id\" : \"knows/12129\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12129\" \n            }, \n            { \n              \"_key\" : \"12136\", \n              \"_id\" : \"knows/12136\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"12136\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12117\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"12123\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12129\", \n              \"_id\" : \"knows/12129\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12129\" \n            }, \n            { \n              \"_key\" : \"12142\", \n              \"_id\" : \"knows/12142\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12142\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12117\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12126\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12129\", \n              \"_id\" : \"knows/12129\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12129\" \n            }, \n            { \n              \"_key\" : \"12142\", \n              \"_id\" : \"knows/12142\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"12142\" \n            }, \n            { \n              \"_key\" : \"12139\", \n              \"_id\" : \"knows/12139\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"12139\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"12117\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"12126\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"12113\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n If the underlying graph is cyclic, *maxIterations* should be set\n\nThe underlying graph has two vertices *Alice* and *Bob*.\nWith the directed edges:\n- *Alice* knows *Bob*\n_ *Bob* knows *Alice*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"none\" \n  }, \n  \"maxIterations\" : 5 \n}\nEOF\n\nHTTP/1.1 500 Internal Server Error\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"code\" : 500, \n  \"errorNum\" : 1909, \n  \"errorMessage\" : \"too many iterations - try increasing the value of 'maxIterations'\" \n}\n
\n\n\n\n\n\n", + "description": "\n\nStarts a traversal starting from a given vertex and following.\nedges contained in a given edgeCollection. The request must\ncontain the following attributes.\n\n**A json post document with these Properties is required:**\n\n - **sort**: body (JavaScript) code of a custom comparison function\n for the edges. The signature of this function is\n *(l, r) -> integer* (where l and r are edges) and must\n return -1 if l is smaller than, +1 if l is greater than,\n and 0 if l and r are equal. The reason for this is the\n following: The order of edges returned for a certain\n vertex is undefined. This is because there is no natural\n order of edges for a vertex with multiple connected edges.\n To explicitly define the order in which edges on the\n vertex are followed, you can specify an edge comparator\n function with this attribute. Note that the value here has\n to be a string to conform to the JSON standard, which in\n turn is parsed as function body on the server side. Furthermore\n note that this attribute is only used for the standard\n expanders. If you use your custom expander you have to\n do the sorting yourself within the expander code.\n - **direction**: direction for traversal\n - *if set*, must be either *\"outbound\"*, *\"inbound\"*, or *\"any\"*\n - *if not set*, the *expander* attribute must be specified\n - **minDepth**: ANDed with any existing filters):\n visits only nodes in at least the given depth\n - **startVertex**: id of the startVertex, e.g. *\"users/foo\"*.\n - **visitor**: body (JavaScript) code of custom visitor function\n function signature: *(config, result, vertex, path, connected) -> void*\n The visitor function can do anything, but its return value is ignored. To\n populate a result, use the *result* variable by reference. Note that the\n *connected* argument is only populated when the *order* attribute is set\n to *\"preorder-expander\"*.\n - **itemOrder**: item iteration order can be *\"forward\"* or *\"backward\"*\n - **strategy**: traversal strategy can be *\"depthfirst\"* or *\"breadthfirst\"*\n - **filter**: default is to include all nodes:\n body (JavaScript code) of custom filter function\n function signature: *(config, vertex, path) -> mixed*\n can return four different string values:\n - *\"exclude\"* -> this vertex will not be visited.\n - *\"prune\"* -> the edges of this vertex will not be followed.\n - *\"\"* or *undefined* -> visit the vertex and follow it's edges.\n - *Array* -> containing any combination of the above.\n If there is at least one *\"exclude\"* or *\"prune\"* respectivly\n is contained, it's effect will occur.\n - **init**: body (JavaScript) code of custom result initialization function\n function signature: *(config, result) -> void*\n initialize any values in result with what is required\n - **maxIterations**: Maximum number of iterations in each traversal. This number can be\n set to prevent endless loops in traversal of cyclic graphs. When a traversal performs\n as many iterations as the *maxIterations* value, the traversal will abort with an\n error. If *maxIterations* is not set, a server-defined value may be used.\n - **maxDepth**: ANDed with any existing filters visits only nodes in at most the given depth\n - **uniqueness**: specifies uniqueness for vertices and edges visited.\n If set, must be an object like this:\n `\"uniqueness\": {\"vertices\": \"none\"|\"global\"|\"path\", \"edges\": \"none\"|\"global\"|\"path\"}`\n - **order**: traversal order can be *\"preorder\"*, *\"postorder\"* or *\"preorder-expander\"*\n - **graphName**: name of the graph that contains the edges.\n Either *edgeCollection* or *graphName* has to be given.\n In case both values are set the *graphName* is prefered.\n - **expander**: body (JavaScript) code of custom expander function\n *must* be set if *direction* attribute is **not** set\n function signature: *(config, vertex, path) -> array*\n expander must return an array of the connections for *vertex*\n each connection is an object with the attributes *edge* and *vertex*\n - **edgeCollection**: name of the collection that contains the edges.\n\n\n\n\n\nIf the Traversal is successfully executed *HTTP 200* will be returned.\nAdditionally the *result* object will be returned by the traversal.\n\nFor successful traversals, the returned JSON object has the\nfollowing properties:\n\n- *error*: boolean flag to indicate if an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\n- *result*: the return value of the traversal\n\nIf the traversal specification is either missing or malformed, the server\nwill respond with *HTTP 400*.\n\nThe body of the response will then contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\n\n\n\n#Example:\n In the following examples the underlying graph will contain five persons\n*Alice*, *Bob*, *Charlie*, *Dave* and *Eve*.\nWe will have the following directed relations:\n\n- *Alice* knows *Bob*\n- *Bob* knows *Charlie*\n- *Bob* knows *Dave*\n- *Eve* knows *Alice*\n- *Eve* knows *Bob*\n\nThe starting vertex will always be Alice.\n\nFollow only outbound edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9Lm---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9Lm--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9Lm--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9Lm--B\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Lm---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11803\", \n              \"_id\" : \"knows/11803\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Lm--D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Lm---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Lm--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11803\", \n              \"_id\" : \"knows/11803\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Lm--D\" \n            }, \n            { \n              \"_key\" : \"11807\", \n              \"_id\" : \"knows/11807\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9Lm--E\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Lm---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Lm--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9Lm--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11803\", \n              \"_id\" : \"knows/11803\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Lm--D\" \n            }, \n            { \n              \"_key\" : \"11810\", \n              \"_id\" : \"knows/11810\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9Lq---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Lm---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Lm--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9Lm--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow only inbound edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"inbound\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9Ga---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9Ga--C\", \n          \"name\" : \"Eve\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Ga---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11562\", \n              \"_id\" : \"knows/11562\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Ge--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Ga---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9Ga--C\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow any direction of edges\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"global\" \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y872---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y872--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y872--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y876---\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y876--_\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y872---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11135\", \n              \"_id\" : \"knows/11135\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y876--A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y872--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11135\", \n              \"_id\" : \"knows/11135\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y876--A\" \n            }, \n            { \n              \"_key\" : \"11139\", \n              \"_id\" : \"knows/11139\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y876--B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y872--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y872--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11135\", \n              \"_id\" : \"knows/11135\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y876--A\" \n            }, \n            { \n              \"_key\" : \"11142\", \n              \"_id\" : \"knows/11142\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y876--C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y872--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y876---\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11135\", \n              \"_id\" : \"knows/11135\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y876--A\" \n            }, \n            { \n              \"_key\" : \"11148\", \n              \"_id\" : \"knows/11148\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y88----\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y872--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y876--_\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11135\", \n              \"_id\" : \"knows/11135\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y876--A\" \n            }, \n            { \n              \"_key\" : \"11148\", \n              \"_id\" : \"knows/11148\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y88----\" \n            }, \n            { \n              \"_key\" : \"11145\", \n              \"_id\" : \"knows/11145\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y876--D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y872--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y876--_\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y872---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Excluding *Charlie* and *Bob*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"filter\" : \"if (vertex.name === \\\"Bob\\\" ||     vertex.name === \\\"Charlie\\\") {  return \\\"exclude\\\";}return;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9Di---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9Di--B\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Di---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11441\", \n              \"_id\" : \"knows/11441\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Di--D\" \n            }, \n            { \n              \"_key\" : \"11448\", \n              \"_id\" : \"knows/11448\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9Dm---\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Di---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Di--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9Di--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Do not follow edges from *Bob*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"filter\" : \"if (vertex.name === \\\"Bob\\\") {return \\\"prune\\\";}return;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9FC---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9FC--_\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9FC---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11499\", \n              \"_id\" : \"knows/11499\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9FG--_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9FC---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9FC--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Visit only nodes in a depth of at least 2\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"minDepth\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9KS--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9KS--B\", \n          \"name\" : \"Dave\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11745\", \n              \"_id\" : \"knows/11745\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9KS--D\" \n            }, \n            { \n              \"_key\" : \"11749\", \n              \"_id\" : \"knows/11749\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9KS--E\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9KS---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9KS--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9KS--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11745\", \n              \"_id\" : \"knows/11745\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9KS--D\" \n            }, \n            { \n              \"_key\" : \"11752\", \n              \"_id\" : \"knows/11752\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9KS--F\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9KS---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9KS--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9KS--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Visit only nodes in a depth of at most 1\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"maxDepth\" : 1 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9Hq---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9Hq--_\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Hq---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11606\", \n              \"_id\" : \"knows/11606\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Hq--D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9Hq---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9Hq--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using a visitor function to return vertex ids only\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"visitor\" : \"result.visited.vertices.push(vertex._id);\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        \"persons/alice\", \n        \"persons/bob\", \n        \"persons/charlie\", \n        \"persons/dave\" \n      ], \n      \"paths\" : [ ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Count all visited nodes and return a list of nodes only\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"outbound\", \n  \"init\" : \"result.visited = 0; result.myVertices = [ ];\", \n  \"visitor\" : \"result.visited++; result.myVertices.push(vertex);\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : 4, \n    \"myVertices\" : [ \n      { \n        \"_key\" : \"alice\", \n        \"_id\" : \"persons/alice\", \n        \"_rev\" : \"_Tn2Y9O6---\", \n        \"name\" : \"Alice\" \n      }, \n      { \n        \"_key\" : \"bob\", \n        \"_id\" : \"persons/bob\", \n        \"_rev\" : \"_Tn2Y9O6--_\", \n        \"name\" : \"Bob\" \n      }, \n      { \n        \"_key\" : \"charlie\", \n        \"_id\" : \"persons/charlie\", \n        \"_rev\" : \"_Tn2Y9O6--A\", \n        \"name\" : \"Charlie\" \n      }, \n      { \n        \"_key\" : \"dave\", \n        \"_id\" : \"persons/dave\", \n        \"_rev\" : \"_Tn2Y9P----\", \n        \"name\" : \"Dave\" \n      } \n    ] \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Expand only inbound edges of *Alice* and outbound edges of *Eve*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"expander\" : \"var connections = [ ];if (vertex.name === \\\"Alice\\\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\\\"internal\\\").db._document(e._from), edge: e});});}if (vertex.name === \\\"Eve\\\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\\\"internal\\\").db._document(e._to), edge: e});});}return connections;\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9QK---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9QK--C\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9QK--_\", \n          \"name\" : \"Bob\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9QK---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12013\", \n              \"_id\" : \"knows/12013\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9QO--A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9QK---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9QK--C\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"12013\", \n              \"_id\" : \"knows/12013\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9QO--A\" \n            }, \n            { \n              \"_key\" : \"12016\", \n              \"_id\" : \"knows/12016\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9QO--B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9QK---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9QK--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9QK--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Follow the *depthfirst* strategy\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"strategy\" : \"depthfirst\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9_6---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9_6--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9_6--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9_6--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9_6--C\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9_6---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9_6--C\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9_6--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9_6--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9_6--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9_6---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11288\", \n              \"_id\" : \"knows/11288\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A----\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11288\", \n              \"_id\" : \"knows/11288\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A----\" \n            }, \n            { \n              \"_key\" : \"11292\", \n              \"_id\" : \"knows/11292\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9A---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9_6--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11288\", \n              \"_id\" : \"knows/11288\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A----\" \n            }, \n            { \n              \"_key\" : \"11295\", \n              \"_id\" : \"knows/11295\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9A---A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9_6--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11288\", \n              \"_id\" : \"knows/11288\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A----\" \n            }, \n            { \n              \"_key\" : \"11301\", \n              \"_id\" : \"knows/11301\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A---C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11288\", \n              \"_id\" : \"knows/11288\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A----\" \n            }, \n            { \n              \"_key\" : \"11301\", \n              \"_id\" : \"knows/11301\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A---C\" \n            }, \n            { \n              \"_key\" : \"11298\", \n              \"_id\" : \"knows/11298\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9A---B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11298\", \n              \"_id\" : \"knows/11298\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9A---B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11298\", \n              \"_id\" : \"knows/11298\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9A---B\" \n            }, \n            { \n              \"_key\" : \"11301\", \n              \"_id\" : \"knows/11301\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A---C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11298\", \n              \"_id\" : \"knows/11298\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9A---B\" \n            }, \n            { \n              \"_key\" : \"11301\", \n              \"_id\" : \"knows/11301\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A---C\" \n            }, \n            { \n              \"_key\" : \"11292\", \n              \"_id\" : \"knows/11292\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9A---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9_6--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11298\", \n              \"_id\" : \"knows/11298\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9A---B\" \n            }, \n            { \n              \"_key\" : \"11301\", \n              \"_id\" : \"knows/11301\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A---C\" \n            }, \n            { \n              \"_key\" : \"11295\", \n              \"_id\" : \"knows/11295\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9A---A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9_6--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11298\", \n              \"_id\" : \"knows/11298\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9A---B\" \n            }, \n            { \n              \"_key\" : \"11301\", \n              \"_id\" : \"knows/11301\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A---C\" \n            }, \n            { \n              \"_key\" : \"11288\", \n              \"_id\" : \"knows/11288\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9A----\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9_6--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9_6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9_6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using *postorder* ordering\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"order\" : \"postorder\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9M6--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9M6--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9M6---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9N----\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9M6--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9M6--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9M6--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9M6---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9M6--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9N----\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9M6---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11861\", \n              \"_id\" : \"knows/11861\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---_\" \n            }, \n            { \n              \"_key\" : \"11865\", \n              \"_id\" : \"knows/11865\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9N---A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9M6--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11861\", \n              \"_id\" : \"knows/11861\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---_\" \n            }, \n            { \n              \"_key\" : \"11868\", \n              \"_id\" : \"knows/11868\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9N---B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9M6--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11861\", \n              \"_id\" : \"knows/11861\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---_\" \n            }, \n            { \n              \"_key\" : \"11874\", \n              \"_id\" : \"knows/11874\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---D\" \n            }, \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9N---C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11861\", \n              \"_id\" : \"knows/11861\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---_\" \n            }, \n            { \n              \"_key\" : \"11874\", \n              \"_id\" : \"knows/11874\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11861\", \n              \"_id\" : \"knows/11861\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9N---C\" \n            }, \n            { \n              \"_key\" : \"11874\", \n              \"_id\" : \"knows/11874\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---D\" \n            }, \n            { \n              \"_key\" : \"11865\", \n              \"_id\" : \"knows/11865\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9N---A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9M6--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9N---C\" \n            }, \n            { \n              \"_key\" : \"11874\", \n              \"_id\" : \"knows/11874\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---D\" \n            }, \n            { \n              \"_key\" : \"11868\", \n              \"_id\" : \"knows/11868\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9N---B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9M6--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9N---C\" \n            }, \n            { \n              \"_key\" : \"11874\", \n              \"_id\" : \"knows/11874\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---D\" \n            }, \n            { \n              \"_key\" : \"11861\", \n              \"_id\" : \"knows/11861\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9N---C\" \n            }, \n            { \n              \"_key\" : \"11874\", \n              \"_id\" : \"knows/11874\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9N---D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9M6--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11871\", \n              \"_id\" : \"knows/11871\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9N---C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9N----\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9M6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Using *backward* item-ordering:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"itemOrder\" : \"backward\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y896---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9-----\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y896--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y896---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y896--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y896--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y896--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9-----\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y896---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y896--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y896--A\", \n          \"name\" : \"Charlie\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11214\", \n              \"_id\" : \"knows/11214\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9----C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11214\", \n              \"_id\" : \"knows/11214\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9----C\" \n            }, \n            { \n              \"_key\" : \"11217\", \n              \"_id\" : \"knows/11217\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11214\", \n              \"_id\" : \"knows/11214\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9----C\" \n            }, \n            { \n              \"_key\" : \"11217\", \n              \"_id\" : \"knows/11217\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----D\" \n            }, \n            { \n              \"_key\" : \"11204\", \n              \"_id\" : \"knows/11204\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11214\", \n              \"_id\" : \"knows/11214\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9----C\" \n            }, \n            { \n              \"_key\" : \"11217\", \n              \"_id\" : \"knows/11217\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----D\" \n            }, \n            { \n              \"_key\" : \"11211\", \n              \"_id\" : \"knows/11211\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9----B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y896--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11214\", \n              \"_id\" : \"knows/11214\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9----C\" \n            }, \n            { \n              \"_key\" : \"11217\", \n              \"_id\" : \"knows/11217\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----D\" \n            }, \n            { \n              \"_key\" : \"11208\", \n              \"_id\" : \"knows/11208\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9----A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y896--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11204\", \n              \"_id\" : \"knows/11204\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11204\", \n              \"_id\" : \"knows/11204\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----_\" \n            }, \n            { \n              \"_key\" : \"11217\", \n              \"_id\" : \"knows/11217\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11204\", \n              \"_id\" : \"knows/11204\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----_\" \n            }, \n            { \n              \"_key\" : \"11217\", \n              \"_id\" : \"knows/11217\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----D\" \n            }, \n            { \n              \"_key\" : \"11214\", \n              \"_id\" : \"knows/11214\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9----C\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9-----\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11204\", \n              \"_id\" : \"knows/11204\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----_\" \n            }, \n            { \n              \"_key\" : \"11211\", \n              \"_id\" : \"knows/11211\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9----B\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y896--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11204\", \n              \"_id\" : \"knows/11204\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9----_\" \n            }, \n            { \n              \"_key\" : \"11208\", \n              \"_id\" : \"knows/11208\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9----A\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y896---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y896--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y896--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n Edges should only be included once globally,\nbut nodes are included every time they are visited\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"global\" \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n    \"visited\" : { \n      \"vertices\" : [ \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9B6---\", \n          \"name\" : \"Alice\" \n        }, \n        { \n          \"_key\" : \"bob\", \n          \"_id\" : \"persons/bob\", \n          \"_rev\" : \"_Tn2Y9B6--_\", \n          \"name\" : \"Bob\" \n        }, \n        { \n          \"_key\" : \"charlie\", \n          \"_id\" : \"persons/charlie\", \n          \"_rev\" : \"_Tn2Y9B6--A\", \n          \"name\" : \"Charlie\" \n        }, \n        { \n          \"_key\" : \"dave\", \n          \"_id\" : \"persons/dave\", \n          \"_rev\" : \"_Tn2Y9B6--B\", \n          \"name\" : \"Dave\" \n        }, \n        { \n          \"_key\" : \"eve\", \n          \"_id\" : \"persons/eve\", \n          \"_rev\" : \"_Tn2Y9B6--C\", \n          \"name\" : \"Eve\" \n        }, \n        { \n          \"_key\" : \"alice\", \n          \"_id\" : \"persons/alice\", \n          \"_rev\" : \"_Tn2Y9B6---\", \n          \"name\" : \"Alice\" \n        } \n      ], \n      \"paths\" : [ \n        { \n          \"edges\" : [ ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11372\", \n              \"_id\" : \"knows/11372\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--D\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--_\", \n              \"name\" : \"Bob\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11372\", \n              \"_id\" : \"knows/11372\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--D\" \n            }, \n            { \n              \"_key\" : \"11376\", \n              \"_id\" : \"knows/11376\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9B6--E\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"charlie\", \n              \"_id\" : \"persons/charlie\", \n              \"_rev\" : \"_Tn2Y9B6--A\", \n              \"name\" : \"Charlie\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11372\", \n              \"_id\" : \"knows/11372\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--D\" \n            }, \n            { \n              \"_key\" : \"11379\", \n              \"_id\" : \"knows/11379\", \n              \"_from\" : \"persons/bob\", \n              \"_to\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9B6--F\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"dave\", \n              \"_id\" : \"persons/dave\", \n              \"_rev\" : \"_Tn2Y9B6--B\", \n              \"name\" : \"Dave\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11372\", \n              \"_id\" : \"knows/11372\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--D\" \n            }, \n            { \n              \"_key\" : \"11385\", \n              \"_id\" : \"knows/11385\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9C---_\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9B6--C\", \n              \"name\" : \"Eve\" \n            } \n          ] \n        }, \n        { \n          \"edges\" : [ \n            { \n              \"_key\" : \"11372\", \n              \"_id\" : \"knows/11372\", \n              \"_from\" : \"persons/alice\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--D\" \n            }, \n            { \n              \"_key\" : \"11385\", \n              \"_id\" : \"knows/11385\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9C---_\" \n            }, \n            { \n              \"_key\" : \"11382\", \n              \"_id\" : \"knows/11382\", \n              \"_from\" : \"persons/eve\", \n              \"_to\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9C----\" \n            } \n          ], \n          \"vertices\" : [ \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            }, \n            { \n              \"_key\" : \"bob\", \n              \"_id\" : \"persons/bob\", \n              \"_rev\" : \"_Tn2Y9B6--_\", \n              \"name\" : \"Bob\" \n            }, \n            { \n              \"_key\" : \"eve\", \n              \"_id\" : \"persons/eve\", \n              \"_rev\" : \"_Tn2Y9B6--C\", \n              \"name\" : \"Eve\" \n            }, \n            { \n              \"_key\" : \"alice\", \n              \"_id\" : \"persons/alice\", \n              \"_rev\" : \"_Tn2Y9B6---\", \n              \"name\" : \"Alice\" \n            } \n          ] \n        } \n      ] \n    } \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n If the underlying graph is cyclic, *maxIterations* should be set\n\nThe underlying graph has two vertices *Alice* and *Bob*.\nWith the directed edges:\n\n- *Alice* knows *Bob*\n- *Bob* knows *Alice*\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF\n{ \n  \"startVertex\" : \"persons/alice\", \n  \"graphName\" : \"knows_graph\", \n  \"direction\" : \"any\", \n  \"uniqueness\" : { \n    \"vertices\" : \"none\", \n    \"edges\" : \"none\" \n  }, \n  \"maxIterations\" : 5 \n}\nEOF\n\nHTTP/1.1 500 Internal Server Error\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : true, \n  \"code\" : 500, \n  \"errorNum\" : 1909, \n  \"errorMessage\" : \"too many iterations - try increasing the value of 'maxIterations'\" \n}\n
\n\n\n\n\n\n", "parameters": [ { "in": "body", @@ -6968,13 +7050,23 @@ "Graph Traversal" ], "x-examples": [], - "x-filename": "Graph Traversal - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" + "x-filename": "Graph Traversal - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" } }, "/_api/user": { "post": { - "description": "\n\n\nCreate a new user. This user will not have access to any database. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/user <<EOF\n{ \n  \"user\" : \"admin@example\", \n  \"password\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"user\" : \"admin@example\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n\n\n\n", - "parameters": [], + "description": "**A json post document with these Properties is required:**\n\n - **passwd**: The user password as a string. If no password is specified, the empty\n string will be used. If you pass the special value\n *ARANGODB_DEFAULT_ROOT_PASSWORD*, the password will be set the value\n stored in the environment variable\n `ARANGODB_DEFAULT_ROOT_PASSWORD`. This can be used to pass an instance\n variable into ArangoDB. For example, the instance identifier from\n Amazon.\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **user**: The name of the user as a string. This is mandatory.\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\n\nCreate a new user. This user will not have access to any database. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/user <<EOF\n{ \n  \"user\" : \"admin@example\", \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"user\" : \"admin@example\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n\n\n\n", + "parameters": [ + { + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "$ref": "#/definitions/UserHandling_create" + }, + "x-description-offset": 60 + } + ], "responses": { "201": { "description": "Returned if the user can be added by the server\n\n" @@ -6988,12 +7080,12 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/": { "get": { - "description": "\n\n\nFetches data about all users. You can only execute this call if you\nhave access to the *_system* database.\n\nThe call will return a JSON object with at least the following\nattributes on success:\n\n- *user*: The name of the user as a string.\n- *active*: An optional flag that specifies whether the user is active.\n- *extra*: An optional JSON object with arbitrary extra data about the user.\n- *changePassword*: An optional flag that specifies whether the user must\n change the password or not.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"user\" : \"admin\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"admin@example\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"tester\", \n      \"active\" : false, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"root\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", + "description": "\n\n\nFetches data about all users. You can only execute this call if you\nhave access to the *_system* database.\n\nThe call will return a JSON object with at least the following\nattributes on success:\n\n- *user*: The name of the user as a string.\n- *active*: An optional flag that specifies whether the user is active.\n- *extra*: An optional JSON object with arbitrary extra data about the user.\n- *changePassword*: An optional flag that specifies whether the user must\n change the password or not.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"user\" : \"tester\", \n      \"active\" : false, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"root\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"admin@example\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    }, \n    { \n      \"user\" : \"admin\", \n      \"active\" : true, \n      \"extra\" : { \n      }, \n      \"changePassword\" : false \n    } \n  ], \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", "parameters": [], "responses": { "200": { @@ -7005,12 +7097,12 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}": { "delete": { - "description": "\n\n\nRemoves an existing user, identified by *user*. You need access to the\n*_system* database.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --data-binary @- --dump - http://localhost:8529/_api/user/admin@ourapp <<EOF\n{ \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"code\" : 202 \n}\n
\n\n\n\n\n\n\n\n", + "description": "\n\n\nRemoves an existing user, identified by *user*. You need access to the\n*_system* database.\n\n\n\n\n#Example:\n \n\n
shell> curl -X DELETE --data-binary @- --dump - http://localhost:8529/_api/user/userToDelete@myapp <<EOF\n{ \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"code\" : 202 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user\n\n", @@ -7034,10 +7126,10 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" }, "get": { - "description": "\n\n\nFetches data about the specified user. You can fetch information about yourself\nor you need permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user/admin@theirapp\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"user\" : \"admin@theirapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", + "description": "\n\n\nFetches data about the specified user. You can fetch information about yourself\nor you need permission to the *_system* database in order to execute this\nREST 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\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { "description": "The name of the user\n\n", @@ -7061,18 +7153,27 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" }, "patch": { - "description": "\n\n\nPartially updates the data of an existing user. The name of an existing\nuser must be specified in *user*. You can only change the password of your\nself. You need access to the *_system* database to change the\n*active* flag.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/user/admin@yourapp <<EOF\n{ \n  \"password\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"user\" : \"admin@yourapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n\n\n", + "description": "**A json post document 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\n\nPartially updates the data of an existing user. The name of an existing\nuser must be specified in *user*. You can only change the password of your\nself. You need access to the *_system* database to change the\n*active* flag.\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\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n\n\n", "parameters": [ { - "description": "The name of the user\n\n-RESTBODYPARAM{passwd,string,required,string}\nThe user password as a string. Specifying a password is mandatory, but\nthe empty string is allowed for passwords\n\n-RESTBODYPARAM{active,boolean,optional,boolean}\nAn optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n-RESTBODYPARAM{extra,object,optional,}\nAn optional JSON object with arbitrary extra data about the user.\n\n", + "description": "The name of the user\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" + }, + { + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "$ref": "#/definitions/UserHandling_modify" + }, + "x-description-offset": 60 } ], "responses": { @@ -7091,18 +7192,27 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { - "description": "\n\n\nReplaces the data of an existing user. The name of an existing user\nmust be specified in user. You can only change the password of your\nself. You need access to the *_system* database to change the\n*active* flag.\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  \"password\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", + "description": "**A json post document 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\n\nReplaces the data of an existing user. The name of an existing user\nmust be specified in user. You can only change the password of your\nself. You need access to the *_system* database to change the\n*active* flag.\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\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"changePassword\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ { - "description": "The name of the user\n\n-RESTBODYPARAM{passwd,string,required,string}\nThe user password as a string. Specifying a password is mandatory, but\nthe empty string is allowed for passwords\n\n-RESTBODYPARAM{active,boolean,optional,boolean}\nAn optional flag that specifies whether the user is active. If not\nspecified, this will default to true\n\n-RESTBODYPARAM{extra,object,optional,}\nAn optional JSON object with arbitrary extra data about the user.\n\n", + "description": "The name of the user\n\n", "format": "string", "in": "path", "name": "user", "required": true, "type": "string" + }, + { + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "$ref": "#/definitions/UserHandling_replace" + }, + "x-description-offset": 60 } ], "responses": { @@ -7121,13 +7231,51 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" + } + }, + "/_api/user/{user}/database/": { + "get": { + "description": "\n\n\nFetch the list of databases available to the specified *user*. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user/anotherAdmin@secapp/database/\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", + "parameters": [ + { + "description": "The name of the user for which you want to query the databases.\n\n", + "format": "string", + "in": "path", + "name": "user", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Returned if the list of available databases can be returned.\n\n" + }, + "400": { + "description": "If the access privileges aren't right etc.\n\n" + } + }, + "summary": " List the databases available to a User", + "tags": [ + "User Management" + ], + "x-examples": [], + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{dbname}": { "put": { - "description": "\n\n\nGrants or revokes access to the database *dbname* for user *user*. You\nneed permission to the *_system* database in order to execute this\nREST call.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@secapp/database/_system <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"_system\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", + "description": "**A json post document with these Properties is required:**\n\n - **grant**: Use \"rw\" to grant access right and \"none\" to revoke.\n\n\n\n\n\nGrants or revokes access to the database *dbname* for user *user*. You\nneed permission to the *_system* database in order to execute this\nREST 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 <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"_system\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", "parameters": [ + { + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "$ref": "#/definitions/UserHandling_grantDatabase" + }, + "x-description-offset": 60 + }, { "description": "The name of the user.\n\n", "format": "string", @@ -7158,12 +7306,12 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/version": { "get": { - "description": "\n\nReturns the server name and version number. The response is a JSON object\nwith the following attributes:\n\n**A json document with these Properties is returned:**\n\n##HTTP 200\nis returned in all cases.\n\n - **version**: the server version string. The string has the format\n\"*major*.*minor*.*sub*\". *major* and *minor* will be numeric, and *sub*\nmay contain a number or a textual version.\n - **details**: an optional JSON object with additional details. This is\nreturned only if the *details* query parameter is set to *true* in the\nrequest.\n - **server**: will always contain *arango*\n\n\n\n\n#Example:\n Return the version information\n\n
shell> curl --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.x-devel\" \n}\n
\n\n\n\n\n#Example:\n Return the version information with details\n\n
shell> curl --dump - http://localhost:8529/_api/version?details=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.x-devel\", \n  \"details\" : { \n    \"architecture\" : \"64bit\", \n    \"asan\" : \"false\", \n    \"asm-crc32\" : \"true\", \n    \"assertions\" : \"false\", \n    \"boost-version\" : \"1.61.0b1\", \n    \"build-date\" : \"2016-06-17 12:54:54\", \n    \"compiler\" : \"gcc\", \n    \"cplusplus\" : \"201103\", \n    \"endianness\" : \"little\", \n    \"fd-client-event-handler\" : \"poll\", \n    \"fd-setsize\" : \"1024\", \n    \"icu-version\" : \"54.1\", \n    \"jemalloc\" : \"true\", \n    \"libev-version\" : \"4.22\", \n    \"maintainer-mode\" : \"false\", \n    \"openssl-version\" : \"OpenSSL 1.0.2 22 Jan 2015\", \n    \"rocksdb-version\" : \"4.8.0\", \n    \"server-version\" : \"3.0.x-devel\", \n    \"sizeof int\" : \"4\", \n    \"sizeof void*\" : \"8\", \n    \"sse42\" : \"true\", \n    \"tcmalloc\" : \"false\", \n    \"v8-version\" : \"5.0.71.39\", \n    \"vpack-version\" : \"0.1.30\", \n    \"zlib-version\" : \"1.2.8\", \n    \"mode\" : \"server\" \n  } \n}\n
\n\n\n\n\n", + "description": "\n\nReturns the server name and version number. The response is a JSON object\nwith the following attributes:\n\n**A json document with these Properties is returned:**\n\n##HTTP 200\nis returned in all cases.\n\n - **version**: the server version string. The string has the format\n\"*major*.*minor*.*sub*\". *major* and *minor* will be numeric, and *sub*\nmay contain a number or a textual version.\n - **details**: an optional JSON object with additional details. This is\nreturned only if the *details* query parameter is set to *true* in the\nrequest.\n - **server**: will always contain *arango*\n\n\n\n\n#Example:\n Return the version information\n\n
shell> curl --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.devel\" \n}\n
\n\n\n\n\n#Example:\n Return the version information with details\n\n
shell> curl --dump - http://localhost:8529/_api/version?details=true\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.0.devel\", \n  \"details\" : { \n    \"architecture\" : \"64bit\", \n    \"asan\" : \"false\", \n    \"asm-crc32\" : \"true\", \n    \"assertions\" : \"true\", \n    \"boost-version\" : \"1.61.0\", \n    \"build-date\" : \"2016-08-18 11:37:53\", \n    \"build-repository\" : \"heads/devel-0-g03b9d97\", \n    \"compiler\" : \"gcc\", \n    \"cplusplus\" : \"201103\", \n    \"endianness\" : \"little\", \n    \"fd-client-event-handler\" : \"poll\", \n    \"fd-setsize\" : \"1024\", \n    \"icu-version\" : \"54.1\", \n    \"jemalloc\" : \"true\", \n    \"libev-version\" : \"4.22\", \n    \"maintainer-mode\" : \"true\", \n    \"openssl-version\" : \"OpenSSL 1.0.2g-fips  1 Mar 2016\", \n    \"rocksdb-version\" : \"4.8.0\", \n    \"server-version\" : \"3.0.devel\", \n    \"sizeof int\" : \"4\", \n    \"sizeof void*\" : \"8\", \n    \"sse42\" : \"true\", \n    \"tcmalloc\" : \"false\", \n    \"v8-version\" : \"5.0.71.39\", \n    \"vpack-version\" : \"0.1.30\", \n    \"zlib-version\" : \"1.2.8\", \n    \"mode\" : \"server\" \n  } \n}\n
\n\n\n\n\n", "parameters": [ { "description": "If set to *true*, the response will contain a *details* attribute with\nadditional information about included components and their versions. The\nattribute names and internals of the *details* object may vary depending on\nplatform and ArangoDB version.\n\n", @@ -7190,7 +7338,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /local/home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md" + "x-filename": "Administration - /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/steemann/ArangoNoAsan/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md" } } },