diff --git a/Documentation/Books/Users/Aql/ArrayOperators.mdpp b/Documentation/Books/AQL/Advanced/ArrayOperators.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/ArrayOperators.mdpp rename to Documentation/Books/AQL/Advanced/ArrayOperators.mdpp diff --git a/Documentation/Books/Users/Aql/Advanced.mdpp b/Documentation/Books/AQL/Advanced/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Advanced.mdpp rename to Documentation/Books/AQL/Advanced/README.mdpp diff --git a/Documentation/Books/Users/Aql/DataModification.mdpp b/Documentation/Books/AQL/DataModification.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/DataModification.mdpp rename to Documentation/Books/AQL/DataModification.mdpp diff --git a/Documentation/Books/Users/AqlExamples/CombiningGraphTraversals.mdpp b/Documentation/Books/AQL/Examples/CombiningGraphTraversals.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/CombiningGraphTraversals.mdpp rename to Documentation/Books/AQL/Examples/CombiningGraphTraversals.mdpp diff --git a/Documentation/Books/Users/AqlExamples/CombiningQueries.mdpp b/Documentation/Books/AQL/Examples/CombiningQueries.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/CombiningQueries.mdpp rename to Documentation/Books/AQL/Examples/CombiningQueries.mdpp diff --git a/Documentation/Books/AQL/Examples/Counting.mdpp b/Documentation/Books/AQL/Examples/Counting.mdpp new file mode 100644 index 0000000000..fa6d730bcf --- /dev/null +++ b/Documentation/Books/AQL/Examples/Counting.mdpp @@ -0,0 +1,21 @@ +!CHAPTER Counting + +!SECTION Amount of documents in a collection + +To return the count of documents that currently exist in a collection, +you can call the [LENGTH() function](../Aql/ArrayFunctions.md#length): + +``` +RETURN LENGTH(collection) +``` + +This type of call is optimized since 2.8 (no unnecessary intermediate result +is built up in memory) and it is therefore the prefered way to determine the count. +In earlier versions with `COLLECT ... WITH COUNT INTO` available (since 2.4), +you may use the following code for better performance instead: + +``` +FOR doc IN collection +COLLECT WITH COUNT INTO length +RETURN length +``` diff --git a/Documentation/Books/Users/AqlExamples/DataModificationQueries.mdpp b/Documentation/Books/AQL/Examples/DataModificationQueries.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/DataModificationQueries.mdpp rename to Documentation/Books/AQL/Examples/DataModificationQueries.mdpp diff --git a/Documentation/Books/Users/AqlExamples/Grouping.mdpp b/Documentation/Books/AQL/Examples/Grouping.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/Grouping.mdpp rename to Documentation/Books/AQL/Examples/Grouping.mdpp diff --git a/Documentation/Books/Users/AqlExamples/Join.mdpp b/Documentation/Books/AQL/Examples/Join.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/Join.mdpp rename to Documentation/Books/AQL/Examples/Join.mdpp diff --git a/Documentation/Books/Users/AqlExamples/ProjectionsAndFilters.mdpp b/Documentation/Books/AQL/Examples/ProjectionsAndFilters.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/ProjectionsAndFilters.mdpp rename to Documentation/Books/AQL/Examples/ProjectionsAndFilters.mdpp diff --git a/Documentation/Books/Users/AqlExamples/QueriesNoCollections.mdpp b/Documentation/Books/AQL/Examples/QueriesNoCollections.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/QueriesNoCollections.mdpp rename to Documentation/Books/AQL/Examples/QueriesNoCollections.mdpp diff --git a/Documentation/Books/Users/AqlExamples/README.mdpp b/Documentation/Books/AQL/Examples/README.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExamples/README.mdpp rename to Documentation/Books/AQL/Examples/README.mdpp diff --git a/Documentation/Books/Users/Aql/ExplainingQueries.mdpp b/Documentation/Books/AQL/ExecutionAndPerformance/ExplainingQueries.mdpp similarity index 99% rename from Documentation/Books/Users/Aql/ExplainingQueries.mdpp rename to Documentation/Books/AQL/ExecutionAndPerformance/ExplainingQueries.mdpp index 215701a52d..7a4073ae16 100644 --- a/Documentation/Books/Users/Aql/ExplainingQueries.mdpp +++ b/Documentation/Books/AQL/ExecutionAndPerformance/ExplainingQueries.mdpp @@ -9,7 +9,7 @@ return the execution plan and some information about what optimizations could be the query. The query will not be executed. Explaining a query can be achieved by calling the [HTTP REST API](../HttpAqlQuery/README.md). -A query can also be explained from the ArangoShell using `ArangoStatement`s `explain` method. +A query can also be explained from the ArangoShell using `ArangoStatement`'s `explain` method. By default, the query optimizer will return what it considers to be the *optimal plan*. The optimal plan will be returned in the `plan` attribute of the result. If `explain` is diff --git a/Documentation/Books/Users/Aql/Optimizer.mdpp b/Documentation/Books/AQL/ExecutionAndPerformance/Optimizer.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Optimizer.mdpp rename to Documentation/Books/AQL/ExecutionAndPerformance/Optimizer.mdpp diff --git a/Documentation/Books/Users/Aql/ParsingQueries.mdpp b/Documentation/Books/AQL/ExecutionAndPerformance/ParsingQueries.mdpp similarity index 97% rename from Documentation/Books/Users/Aql/ParsingQueries.mdpp rename to Documentation/Books/AQL/ExecutionAndPerformance/ParsingQueries.mdpp index 8a28b02384..0425ccbbbc 100644 --- a/Documentation/Books/Users/Aql/ParsingQueries.mdpp +++ b/Documentation/Books/AQL/ExecutionAndPerformance/ParsingQueries.mdpp @@ -3,7 +3,7 @@ Clients can use ArangoDB to check if a given AQL query is syntactically valid. ArangoDB provides an [HTTP REST API](../HttpAqlQuery/README.md) for this. -A query can also be parsed from the ArangoShell using `ArangoStatement`s `parse` method. The +A query can also be parsed from the ArangoShell using `ArangoStatement`'s `parse` method. The `parse` method will throw an exception if the query is syntactically invalid. Otherwise, it will return the some information about the query. diff --git a/Documentation/Books/Users/Aql/QueryCache.mdpp b/Documentation/Books/AQL/ExecutionAndPerformance/QueryCache.mdpp similarity index 96% rename from Documentation/Books/Users/Aql/QueryCache.mdpp rename to Documentation/Books/AQL/ExecutionAndPerformance/QueryCache.mdpp index 457bc219be..5802206c77 100644 --- a/Documentation/Books/Users/Aql/QueryCache.mdpp +++ b/Documentation/Books/AQL/ExecutionAndPerformance/QueryCache.mdpp @@ -106,14 +106,14 @@ will require time proportional to the number of cached items that need to be inv There may be workloads in which enabling the query cache will lead to a performance degradation. It is not recommended to turn the query cache on in workloads that only -modify data, or that modify data more often than read it. Turning on the query cache +modify data, or that modify data more often than reading it. Turning on the query cache will also provide no benefit if queries are very diverse and do not repeat often. In read-only or read-mostly workloads, the query cache will be beneficial if the same queries are repeated lots of times. In general, the query cache will provide the biggest improvements for queries with -small result sets that take long to calculate. If a query's results are very big and -most of the query time is spent in copying the result from the cache to the client, +small result sets that take long to calculate. If query results are very big and +most of the query time is spent on copying the result from the cache to the client, then the cache will not provide much benefit. @@ -180,7 +180,7 @@ this attribute to check if a specific query was served from the cache or not. !SECTION Restrictions Query results that are returned from the query cache do not contain any execution statistics, -meaning their *extra.stats* attribute will not be present. Additionally query results returned +meaning their *extra.stats* attribute will not be present. Additionally, query results returned from the cache will not contain profile information even if the *profile* option was set to true when invoking the query. diff --git a/Documentation/Books/Users/Aql/QueryStatistics.mdpp b/Documentation/Books/AQL/ExecutionAndPerformance/QueryStatistics.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/QueryStatistics.mdpp rename to Documentation/Books/AQL/ExecutionAndPerformance/QueryStatistics.mdpp diff --git a/Documentation/Books/Users/Aql/ExecutionPerformance.mdpp b/Documentation/Books/AQL/ExecutionAndPerformance/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/ExecutionPerformance.mdpp rename to Documentation/Books/AQL/ExecutionAndPerformance/README.mdpp diff --git a/Documentation/Books/Users/AqlExtending/Conventions.mdpp b/Documentation/Books/AQL/Extending/Conventions.mdpp similarity index 81% rename from Documentation/Books/Users/AqlExtending/Conventions.mdpp rename to Documentation/Books/AQL/Extending/Conventions.mdpp index 8ee543b0d3..518da6c960 100644 --- a/Documentation/Books/Users/AqlExtending/Conventions.mdpp +++ b/Documentation/Books/AQL/Extending/Conventions.mdpp @@ -42,7 +42,7 @@ outer scopes. Not using the `var` keyword for own variables may cause side effects when executing the function. Here is an example that may modify outer scope variables `i` and `name`, -making the function **not** side effects-free: +making the function **not** side-effect free: ```js function (values) { @@ -93,9 +93,9 @@ to undefined behavior and should be avoided. !SECTION Enforcing strict mode -By default, any user function code will not be executed in *strict mode* or -*strong mode*. In order to make a user function being run in strict -mode, use `use strict` explicitly inside the user function, e.g.: +By default, any user function code will be executed in *sloppy mode*, not +*strict* or *strong mode*. In order to make a user function being run in strict +mode, use `"use strict"` explicitly inside the user function, e.g.: ```js function (values) { @@ -116,10 +116,13 @@ Any violation of the strict mode will trigger a runtime error. !SECTION Miscellaneous Internally, user functions are stored in a system collection named -*_aqlfunctions* of the selected database. -Documents in this collection should not be accessed directly, but -only via the dedicated interfaces. -Also system collection are excluded from dumps created with -[arangodump](../HttpBulkImports/Arangodump.md). To include AQL user -functions in a dump, the dump should be started with the +*_aqlfunctions* of the selected database. The functions will be exclusively +available for queries in that particular database. + +Documents in the *_aqlfunctions* collection (or any other system collection) +should not be accessed directly, but only via the dedicated interfaces. + +Keep in mind that system collections are excluded from dumps created with +[arangodump](../HttpBulkImports/Arangodump.md) by default. To include AQL user +functions in a dump, the dump needs to be started with the option *--include-system-collections true*. diff --git a/Documentation/Books/Users/AqlExtending/Functions.mdpp b/Documentation/Books/AQL/Extending/Functions.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExtending/Functions.mdpp rename to Documentation/Books/AQL/Extending/Functions.mdpp diff --git a/Documentation/Books/Users/AqlExtending/README.mdpp b/Documentation/Books/AQL/Extending/README.mdpp similarity index 100% rename from Documentation/Books/Users/AqlExtending/README.mdpp rename to Documentation/Books/AQL/Extending/README.mdpp diff --git a/Documentation/Books/Users/Aql/ArrayFunctions.mdpp b/Documentation/Books/AQL/Functions/Array.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/ArrayFunctions.mdpp rename to Documentation/Books/AQL/Functions/Array.mdpp diff --git a/Documentation/Books/Users/Aql/DateFunctions.mdpp b/Documentation/Books/AQL/Functions/Date.mdpp similarity index 98% rename from Documentation/Books/Users/Aql/DateFunctions.mdpp rename to Documentation/Books/AQL/Functions/Date.mdpp index 65f1d3c603..91efe9abc3 100644 --- a/Documentation/Books/Users/Aql/DateFunctions.mdpp +++ b/Documentation/Books/AQL/Functions/Date.mdpp @@ -184,7 +184,7 @@ DATE_ADD(DATE_ADD("2016-02", "month", 1), -1, "day") // last day of February (29 The string must be prefixed by a `P`. A separating `T` is only required if `H`, `M` and/or `S` are specified. You only need to specify the needed pairs - of amounts and time intervals. + of letters and numbers. Examples: @@ -345,8 +345,8 @@ FOR user IN users - %: ignored `%yyyy` does not enforce a length of 4 for years before 0 and past 9999. - The same format as for `%yyyyyy` will used instead. `%yy` preserves the - sign for negative years and thus returns 3 characters in total. + The same format as for `%yyyyyy` will be used instead. `%yy` preserves the + sign for negative years and may thus return 3 characters in total. Single `%` characters will be ignored. Use `%%` for a literal `%`. To resolve ambiguities like in `%mmonth` (unpadded month number + the string "month") @@ -411,5 +411,8 @@ special treatment of positive years too, if negative years are used (e.g. `+002015-05-15` and `-000753-01-01`). This is rarely used however, and AQL does not use the 7-character version for years between 0 and 9999 in ISO strings. Keep in mind that they can't be properly compared to dates outside that range. +Sorting of negative dates does not result in a meaningful order, with years longer +ago last, but months, days and the time components in otherwise correct order. + Leap seconds are ignored, just as they are in JavaScript as per [ECMAScript Language Specifications](http://www.ecma-international.org/ecma-262/5.1/#sec-15.9.1.1). diff --git a/Documentation/Books/Users/Aql/DocumentFunctions.mdpp b/Documentation/Books/AQL/Functions/Document.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/DocumentFunctions.mdpp rename to Documentation/Books/AQL/Functions/Document.mdpp diff --git a/Documentation/Books/Users/Aql/FulltextFunctions.mdpp b/Documentation/Books/AQL/Functions/Fulltext.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/FulltextFunctions.mdpp rename to Documentation/Books/AQL/Functions/Fulltext.mdpp diff --git a/Documentation/Books/Users/Aql/GeoFunctions.mdpp b/Documentation/Books/AQL/Functions/Geo.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/GeoFunctions.mdpp rename to Documentation/Books/AQL/Functions/Geo.mdpp diff --git a/Documentation/Books/Users/Aql/MiscellaneousFunctions.mdpp b/Documentation/Books/AQL/Functions/Miscellaneous.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/MiscellaneousFunctions.mdpp rename to Documentation/Books/AQL/Functions/Miscellaneous.mdpp diff --git a/Documentation/Books/Users/Aql/NumericFunctions.mdpp b/Documentation/Books/AQL/Functions/Numeric.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/NumericFunctions.mdpp rename to Documentation/Books/AQL/Functions/Numeric.mdpp diff --git a/Documentation/Books/Users/Aql/Functions.mdpp b/Documentation/Books/AQL/Functions/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Functions.mdpp rename to Documentation/Books/AQL/Functions/README.mdpp diff --git a/Documentation/Books/Users/Aql/StringFunctions.mdpp b/Documentation/Books/AQL/Functions/String.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/StringFunctions.mdpp rename to Documentation/Books/AQL/Functions/String.mdpp diff --git a/Documentation/Books/Users/Aql/TypeCastFunctions.mdpp b/Documentation/Books/AQL/Functions/TypeCast.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/TypeCastFunctions.mdpp rename to Documentation/Books/AQL/Functions/TypeCast.mdpp diff --git a/Documentation/Books/Users/Aql/BindParameters.mdpp b/Documentation/Books/AQL/Fundamentals/BindParameters.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/BindParameters.mdpp rename to Documentation/Books/AQL/Fundamentals/BindParameters.mdpp diff --git a/Documentation/Books/Users/Aql/DataTypes.mdpp b/Documentation/Books/AQL/Fundamentals/DataTypes.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/DataTypes.mdpp rename to Documentation/Books/AQL/Fundamentals/DataTypes.mdpp diff --git a/Documentation/Books/Users/Aql/DocumentData.mdpp b/Documentation/Books/AQL/Fundamentals/DocumentData.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/DocumentData.mdpp rename to Documentation/Books/AQL/Fundamentals/DocumentData.mdpp diff --git a/Documentation/Books/Users/Aql/QueryErrors.mdpp b/Documentation/Books/AQL/Fundamentals/QueryErrors.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/QueryErrors.mdpp rename to Documentation/Books/AQL/Fundamentals/QueryErrors.mdpp diff --git a/Documentation/Books/Users/Aql/QueryResults.mdpp b/Documentation/Books/AQL/Fundamentals/QueryResults.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/QueryResults.mdpp rename to Documentation/Books/AQL/Fundamentals/QueryResults.mdpp diff --git a/Documentation/Books/Users/Aql/Fundamentals.mdpp b/Documentation/Books/AQL/Fundamentals/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Fundamentals.mdpp rename to Documentation/Books/AQL/Fundamentals/README.mdpp diff --git a/Documentation/Books/Users/Aql/Syntax.mdpp b/Documentation/Books/AQL/Fundamentals/Syntax.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Syntax.mdpp rename to Documentation/Books/AQL/Fundamentals/Syntax.mdpp diff --git a/Documentation/Books/Users/Aql/TypeValueOrder.mdpp b/Documentation/Books/AQL/Fundamentals/TypeValueOrder.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/TypeValueOrder.mdpp rename to Documentation/Books/AQL/Fundamentals/TypeValueOrder.mdpp diff --git a/Documentation/Books/Users/Aql/GraphFunctions.mdpp b/Documentation/Books/AQL/Graphs/Functions.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/GraphFunctions.mdpp rename to Documentation/Books/AQL/Graphs/Functions.mdpp diff --git a/Documentation/Books/Users/Aql/GraphOperations.mdpp b/Documentation/Books/AQL/Graphs/Operations.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/GraphOperations.mdpp rename to Documentation/Books/AQL/Graphs/Operations.mdpp diff --git a/Documentation/Books/Users/Aql/Graphs.mdpp b/Documentation/Books/AQL/Graphs/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Graphs.mdpp rename to Documentation/Books/AQL/Graphs/README.mdpp diff --git a/Documentation/Books/Users/Aql/GraphTraversals.mdpp b/Documentation/Books/AQL/Graphs/Traversals.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/GraphTraversals.mdpp rename to Documentation/Books/AQL/Graphs/Traversals.mdpp diff --git a/Documentation/Books/AQL/HEADER.html b/Documentation/Books/AQL/HEADER.html new file mode 100644 index 0000000000..9a1ec7309f --- /dev/null +++ b/Documentation/Books/AQL/HEADER.html @@ -0,0 +1,42 @@ + \ No newline at end of file diff --git a/Documentation/Books/Users/Aql/Invoke.mdpp b/Documentation/Books/AQL/Invocation/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Invoke.mdpp rename to Documentation/Books/AQL/Invocation/README.mdpp diff --git a/Documentation/Books/Users/Aql/AqlWithArangosh.mdpp b/Documentation/Books/AQL/Invocation/WithArangosh.mdpp similarity index 96% rename from Documentation/Books/Users/Aql/AqlWithArangosh.mdpp rename to Documentation/Books/AQL/Invocation/WithArangosh.mdpp index 51299aabb0..f7ff46455b 100644 --- a/Documentation/Books/Users/Aql/AqlWithArangosh.mdpp +++ b/Documentation/Books/AQL/Invocation/WithArangosh.mdpp @@ -37,7 +37,19 @@ To pass bind parameters into a query, they can be specified as second argument t !SUBSUBSECTION ES6 template strings It is also possible to use ES6 template strings for generating AQL queries. There is -a template string generator function named *aqlQuery*: +a template string generator function named *aqlQuery*; we call it once to demonstrate +its result, and once putting it directly into the query: + + ```js + var key = 'testKey'; + aqlQuery`FOR c IN mycollection FILTER c._key == ${key} RETURN c._key`; + { + "query" : "FOR c IN mycollection FILTER c._key == @value0 RETURN c._key", + "bindVars" : { + "value0" : "testKey" + } + } + ``` @startDocuBlockInline 02_workWithAQL_aqlQuery @EXAMPLE_ARANGOSH_OUTPUT{02_workWithAQL_aqlQuery} diff --git a/Documentation/Books/Users/Aql/AqlWithWebInterface.mdpp b/Documentation/Books/AQL/Invocation/WithWebInterface.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/AqlWithWebInterface.mdpp rename to Documentation/Books/AQL/Invocation/WithWebInterface.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Collect.mdpp b/Documentation/Books/AQL/Operations/Collect.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Collect.mdpp rename to Documentation/Books/AQL/Operations/Collect.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Filter.mdpp b/Documentation/Books/AQL/Operations/Filter.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Filter.mdpp rename to Documentation/Books/AQL/Operations/Filter.mdpp diff --git a/Documentation/Books/Users/AqlOperations/For.mdpp b/Documentation/Books/AQL/Operations/For.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/For.mdpp rename to Documentation/Books/AQL/Operations/For.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Insert.mdpp b/Documentation/Books/AQL/Operations/Insert.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Insert.mdpp rename to Documentation/Books/AQL/Operations/Insert.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Let.mdpp b/Documentation/Books/AQL/Operations/Let.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Let.mdpp rename to Documentation/Books/AQL/Operations/Let.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Limit.mdpp b/Documentation/Books/AQL/Operations/Limit.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Limit.mdpp rename to Documentation/Books/AQL/Operations/Limit.mdpp diff --git a/Documentation/Books/Users/Aql/Operations.mdpp b/Documentation/Books/AQL/Operations/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Operations.mdpp rename to Documentation/Books/AQL/Operations/README.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Remove.mdpp b/Documentation/Books/AQL/Operations/Remove.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Remove.mdpp rename to Documentation/Books/AQL/Operations/Remove.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Replace.mdpp b/Documentation/Books/AQL/Operations/Replace.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Replace.mdpp rename to Documentation/Books/AQL/Operations/Replace.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Return.mdpp b/Documentation/Books/AQL/Operations/Return.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Return.mdpp rename to Documentation/Books/AQL/Operations/Return.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Sort.mdpp b/Documentation/Books/AQL/Operations/Sort.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Sort.mdpp rename to Documentation/Books/AQL/Operations/Sort.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Update.mdpp b/Documentation/Books/AQL/Operations/Update.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Update.mdpp rename to Documentation/Books/AQL/Operations/Update.mdpp diff --git a/Documentation/Books/Users/AqlOperations/Upsert.mdpp b/Documentation/Books/AQL/Operations/Upsert.mdpp similarity index 100% rename from Documentation/Books/Users/AqlOperations/Upsert.mdpp rename to Documentation/Books/AQL/Operations/Upsert.mdpp diff --git a/Documentation/Books/Users/Aql/Operators.mdpp b/Documentation/Books/AQL/Operators.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/Operators.mdpp rename to Documentation/Books/AQL/Operators.mdpp diff --git a/Documentation/Books/Users/Aql/README.mdpp b/Documentation/Books/AQL/README.mdpp similarity index 100% rename from Documentation/Books/Users/Aql/README.mdpp rename to Documentation/Books/AQL/README.mdpp diff --git a/Documentation/Books/AQL/SUMMARY.md b/Documentation/Books/AQL/SUMMARY.md new file mode 100644 index 0000000000..e0943b18e7 --- /dev/null +++ b/Documentation/Books/AQL/SUMMARY.md @@ -0,0 +1,63 @@ + +# Summary +* [How to invoke AQL](Invocation/README.md) + * [with Arangosh](Invocation/WithArangosh.md) + * [with the Web Interface](Invocation/WithWebInterface.md) +* [Data Modification Queries](DataModification.md) +* [AQL Fundamentals](Fundamentals/README.md) + * [AQL Syntax](Fundamentals/Syntax.md) + * [Data types](Fundamentals/DataTypes.md) + * [Bind Parameters](Fundamentals/BindParameters.md) + * [Type and value order](Fundamentals/TypeValueOrder.md) + * [Accessing data from collections](Fundamentals/DocumentData.md) + * [Query Results](Fundamentals/QueryResults.md) + * [Query Errors](Fundamentals/QueryErrors.md) +* [High level Operations](Operations/README.md) + * [FOR](Operations/For.md) + * [RETURN](Operations/Return.md) + * [FILTER](Operations/Filter.md) + * [SORT](Operations/Sort.md) + * [LIMIT](Operations/Limit.md) + * [LET](Operations/Let.md) + * [COLLECT](Operations/Collect.md) + * [REMOVE](Operations/Remove.md) + * [UPDATE](Operations/Update.md) + * [REPLACE](Operations/Replace.md) + * [INSERT](Operations/Insert.md) + * [UPSERT](Operations/Upsert.md) +* [Operators](Operators.md) +* [Functions](Functions/README.md) + * [Type cast](Functions/TypeCast.md) + * [String](Functions/String.md) + * [Numeric](Functions/Numeric.md) + * [Date](Functions/Date.md) + * [Array](Functions/Array.md) + * [Object / Document](Functions/Document.md) + * [Geo](Functions/Geo.md) + * [Fulltext](Functions/Fulltext.md) + * [Miscellaneous](Functions/Miscellaneous.md) +* [Graphs](Graphs/README.md) + * [Traversal](Graphs/Traversals.md) + * [Named Operations](Graphs/Operations.md) + * [Other](Graphs/Functions.md) +* [Advanced Features](Advanced/README.md) + * [Array Operators](Advanced/ArrayOperators.md) +* [Usual Query Patterns](Examples/README.md) + * [Counting](Examples/Counting.md) + * [Data-modification queries](Examples/DataModificationQueries.md) + * [Subqueries](Examples/CombiningQueries.md) + * [Projections and filters](Examples/ProjectionsAndFilters.md) + * [Joins](Examples/Join.md) + * [Grouping](Examples/Grouping.md) + * [Traversals](Examples/CombiningGraphTraversals.md) + * [Queries without collections](Examples/QueriesNoCollections.md) +* [User Functions](Extending/README.md) + * [Conventions](Extending/Conventions.md) + * [Registering Functions](Extending/Functions.md) +* [Execution and Performance](ExecutionAndPerformance/README.md) + * [Query statistics](ExecutionAndPerformance/QueryStatistics.md) + * [Parsing queries](ExecutionAndPerformance/ParsingQueries.md) + * [Explaining queries](ExecutionAndPerformance/ExplainingQueries.md) + * [Optimizing queries](ExecutionAndPerformance/Optimizer.md) + * [Caching query results](ExecutionAndPerformance/QueryCache.md) +* [Common Errors](CommonErrors.md) diff --git a/Documentation/Books/AQL/book.json b/Documentation/Books/AQL/book.json new file mode 100644 index 0000000000..ab5f7b5523 --- /dev/null +++ b/Documentation/Books/AQL/book.json @@ -0,0 +1,27 @@ +{ + "gitbook": ">=2.0.0", + "title": "ArangoDB VERSION_NUMBER AQL Documentation", + "author": "ArangoDB GmbH", + "description": "Official AQL manual for ArangoDB - the multi-model NoSQL database", + "language": "en", + "plugins":["-search", "-sharing", "toggle-chapters", "addcssjs", "heading-anchors", "add-header"], + "pdf": { + "fontSize": 12, + "toc": true, + "margin": { + "right": 60, + "left": 60, + "top": 35, + "bottom": 35 + } + }, + "styles": { + "website": "styles/website.css" + }, + "pluginsConfig": { + "addcssjs": { + "js": ["styles/header.js"], + "css": ["styles/header.css"] + } + } +} diff --git a/Documentation/Books/AQL/styles/header.css b/Documentation/Books/AQL/styles/header.css new file mode 100644 index 0000000000..14be63b299 --- /dev/null +++ b/Documentation/Books/AQL/styles/header.css @@ -0,0 +1,239 @@ +/* Design fix because of the header */ +@import url(https://fonts.googleapis.com/css?family=Roboto:400,500,300,700); + +body { + overflow: hidden; + font-family: Roboto, Helvetica, sans-serif; + background: #444444; +} + +.book .book-header h1 a, .book .book-header h1 a:hover { + display: none; +} + +/* GOOGLE START */ + +.google-search #gsc-iw-id1{ + border: none !important; +} + +.google-search .gsst_b { + position: relative; + top: 10px; + left: -25px; + width: 1px; +} + +.gsst_a .gscb_a { + color: #c01a07 !important; +} + +.google-search input { + background-color: #fff !important; + font-family: Roboto, Helvetica, sans-serif; + font-size: 10pt !important; + padding-left: 5px !important; + float: right; + position: relative; + top: 8px; + width: 100% !important; + height: 30px !important; +} + +.google-search input:active { +} + +.google-search { + margin-right: 114px !important; + margin-left: 10px !important; + float: right !important; +} + +.google-search td, +.google-search table, +.google-search tr, +.google-search th { + background-color: #444444 !important; +} + +.google-search .gsc-input-box, +.google-search .gsc-input-box input { + border-radius: 3px !important; + width: 200px; +} + +.gsc-branding-text, +.gsc-branding-img, +.gsc-user-defined-text { + display: none !important; +} + +.google-search .gsc-input-box input { + font-size: 16px !important; +} + +.google-search .gsc-search-button { + display: none !important; +} + +.google-search .gsc-control-cse { + padding: 10px !important; +} + +.google-search > div { + float: left !important; + width: 200px !important; +} + +/* GOOGLE END */ + +.book-summary, +.book-body { + margin-top: 48px; +} + +.book .book-summary ul.summary li.active > a, +.book .book-summary ul.summary li a:hover { + color: #fff !important; +} + +#logo { + display: block; + float: left; + color: #fff; + width: 12%; + line-height: 40px; +} + +#logo img { + width: 150px; + margin-top: 0px; + margin-left: 114px; +} + +.wrap { + display: block; + margin: 0 auto; + max-width: 1200px; + padding: 0 10px; +} + +#header { + position: fixed; + width: 100%; + height: 48px; + z-index: 1; +} + +#header .socialIcons-googlegroups a img { + position: relative; + top: 3px; +} + +/* +#header .wrap, +#header .wrap .clearfix { + max-height: 48px; +} +*/ + +.absolute{ + position: absolute; + z-index: 10; + right: 0; + left: 0; + top: 0; +} + +#navmenu { + display: block; + float: right; + margin: 0px; +} + +#navmenu li { + display: block; + float: left; +} + +#navmenu li a { + display: block; + float: left; + padding-left: 10px; + padding-right: 10px; + line-height: 48px; + font-size: 16px; + font-weight: 400; + color: #fff; + text-decoration: none; + font-family: Roboto, Helvetica, sans-serif; +} + +#navmenu li a:hover, #navmenu li.active-tab a { + background: #8aa051 !important; +} + +.arangodb_version { + float: left; + padding-left: 130px; + padding-top: 3px; + padding-right: 0px; + line-height: 40px; + font-weight: bold; + color: #fff; + text-decoration: none; +} + +/** simple responsive updates **/ + +@media screen and (max-width: 1100px) { + #logo { + position: absolute; + left: -100px; + } + + .google-search { + margin-right: -5px !important; + } + + .socialIcons { + display: none !important; + } +} + + +@media screen and (max-width: 770px) { + .google-search { + margin-right: -5px !important; + width: 200px !important; + } + #navmenu { + display: none; + } + #navmenu li a { font-size: 0.8em; padding: 0 15px; } + #navmenu li a img { width:11px; height:36px; padding-top: 4px; } + #logo { + width: 100px; + height: 50px; + position: absolute; + top: 4px; + left: -100px; + z-index: 9999; + } + #logo img { + width: 100px; + margin-top:4px; + position: absolute; + float: left; + left: -10px; + } + + .arangodb_version { display: none !important; } +} + +/** clearfix **/ +.clearfix:after { content: "."; display: block; clear: both; visibility: hidden; line-height: 0; height: 0; } +.clearfix { display: inline-block; } + +html[xmlns] .clearfix { display: block; } +* html .clearfix { height: 1%; } diff --git a/Documentation/Books/AQL/styles/header.js b/Documentation/Books/AQL/styles/header.js new file mode 100644 index 0000000000..78d4cfe65c --- /dev/null +++ b/Documentation/Books/AQL/styles/header.js @@ -0,0 +1,40 @@ +window.onload = function(){ +window.localStorage.removeItem(":keyword"); + +$(document).ready(function() { + +function appendHeader() { +/* + var div = document.createElement('div'); + div.innerHTML = ''; + + $('.book').before(div.innerHTML); +*/ + }; + + + function rerenderNavbar() { + $('#header').remove(); + appendHeader(); + renderGoogleSearch(); + }; + + function renderGoogleSearch() { + }; + //render header + //rerenderNavbar(); + function addGoogleSrc() { + var cx = '002866056653122356950:ju52xx-w-w8'; + var gcse = document.createElement('script'); + gcse.type = 'text/javascript'; + gcse.async = true; + gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + + '//cse.google.com/cse.js?cx=' + cx; + var s = document.getElementsByTagName('script')[0]; + s.parentNode.insertBefore(gcse, s); + }; + addGoogleSrc(); + +}); + +}; diff --git a/Documentation/Books/AQL/styles/website.css b/Documentation/Books/AQL/styles/website.css new file mode 100644 index 0000000000..760c605a94 --- /dev/null +++ b/Documentation/Books/AQL/styles/website.css @@ -0,0 +1,43 @@ +div.example_show_button { + border: medium solid lightgray; + text-align: center; + position: relative; + top: -10px; +} + +.book .book-body .navigation.navigation-next { + right: 10px !important; +} + +.book .book-summary ul.summary li.active>a,.book .book-summary ul.summary li a:hover { + color: #fff !important; + background: #80A54D !important; + text-decoration: none; +} + +.book .book-body .page-wrapper .page-inner section.normal .deprecated{ + background-color: rgba(240,240,0,0.4); +} + +.columns-3 { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + columns: 3; +} + +.gsib_a { +padding: 0px !important; +} + +.gsc-control-cse { +border: 0px !important; +background-color: transparent !important; +} + + +.gsc-input { +margin: 0px !important; +} diff --git a/Documentation/Books/Users/HttpAdministrationAndMonitoring/README.mdpp b/Documentation/Books/HTTP/AdministrationAndMonitoring/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAdministrationAndMonitoring/README.mdpp rename to Documentation/Books/HTTP/AdministrationAndMonitoring/README.mdpp diff --git a/Documentation/Books/Users/HttpApi/README.mdpp b/Documentation/Books/HTTP/Api/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpApi/README.mdpp rename to Documentation/Books/HTTP/Api/README.mdpp diff --git a/Documentation/Books/Users/HttpAqlQuery/README.mdpp b/Documentation/Books/HTTP/AqlQuery/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAqlQuery/README.mdpp rename to Documentation/Books/HTTP/AqlQuery/README.mdpp diff --git a/Documentation/Books/Users/HttpAqlQueryCache/README.mdpp b/Documentation/Books/HTTP/AqlQueryCache/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAqlQueryCache/README.mdpp rename to Documentation/Books/HTTP/AqlQueryCache/README.mdpp diff --git a/Documentation/Books/Users/HttpAqlQueryCursor/AccessingCursors.mdpp b/Documentation/Books/HTTP/AqlQueryCursor/AccessingCursors.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAqlQueryCursor/AccessingCursors.mdpp rename to Documentation/Books/HTTP/AqlQueryCursor/AccessingCursors.mdpp diff --git a/Documentation/Books/Users/HttpAqlQueryCursor/QueryResults.mdpp b/Documentation/Books/HTTP/AqlQueryCursor/QueryResults.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAqlQueryCursor/QueryResults.mdpp rename to Documentation/Books/HTTP/AqlQueryCursor/QueryResults.mdpp diff --git a/Documentation/Books/Users/HttpAqlQueryCursor/README.mdpp b/Documentation/Books/HTTP/AqlQueryCursor/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAqlQueryCursor/README.mdpp rename to Documentation/Books/HTTP/AqlQueryCursor/README.mdpp diff --git a/Documentation/Books/Users/HttpAqlUserFunctions/README.mdpp b/Documentation/Books/HTTP/AqlUserFunctions/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAqlUserFunctions/README.mdpp rename to Documentation/Books/HTTP/AqlUserFunctions/README.mdpp diff --git a/Documentation/Books/Users/HttpAsyncResultsManagement/README.mdpp b/Documentation/Books/HTTP/AsyncResultsManagement/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpAsyncResultsManagement/README.mdpp rename to Documentation/Books/HTTP/AsyncResultsManagement/README.mdpp diff --git a/Documentation/Books/Users/HttpBatchRequest/README.mdpp b/Documentation/Books/HTTP/BatchRequest/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBatchRequest/README.mdpp rename to Documentation/Books/HTTP/BatchRequest/README.mdpp diff --git a/Documentation/Books/Users/HttpBulkImports/ImportingHeadersAndValues.mdpp b/Documentation/Books/HTTP/BulkImports/ImportingHeadersAndValues.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBulkImports/ImportingHeadersAndValues.mdpp rename to Documentation/Books/HTTP/BulkImports/ImportingHeadersAndValues.mdpp diff --git a/Documentation/Books/Users/HttpBulkImports/ImportingSelfContained.mdpp b/Documentation/Books/HTTP/BulkImports/ImportingSelfContained.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBulkImports/ImportingSelfContained.mdpp rename to Documentation/Books/HTTP/BulkImports/ImportingSelfContained.mdpp diff --git a/Documentation/Books/Users/HttpBulkImports/README.mdpp b/Documentation/Books/HTTP/BulkImports/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBulkImports/README.mdpp rename to Documentation/Books/HTTP/BulkImports/README.mdpp diff --git a/Documentation/Books/Users/HttpCollection/Creating.mdpp b/Documentation/Books/HTTP/Collection/Creating.mdpp similarity index 100% rename from Documentation/Books/Users/HttpCollection/Creating.mdpp rename to Documentation/Books/HTTP/Collection/Creating.mdpp diff --git a/Documentation/Books/Users/HttpCollection/Getting.mdpp b/Documentation/Books/HTTP/Collection/Getting.mdpp similarity index 100% rename from Documentation/Books/Users/HttpCollection/Getting.mdpp rename to Documentation/Books/HTTP/Collection/Getting.mdpp diff --git a/Documentation/Books/Users/HttpCollection/Modifying.mdpp b/Documentation/Books/HTTP/Collection/Modifying.mdpp similarity index 100% rename from Documentation/Books/Users/HttpCollection/Modifying.mdpp rename to Documentation/Books/HTTP/Collection/Modifying.mdpp diff --git a/Documentation/Books/Users/HttpCollection/README.mdpp b/Documentation/Books/HTTP/Collection/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpCollection/README.mdpp rename to Documentation/Books/HTTP/Collection/README.mdpp diff --git a/Documentation/Books/Users/HttpDatabase/DatabaseEndpoint.mdpp b/Documentation/Books/HTTP/Database/DatabaseEndpoint.mdpp similarity index 100% rename from Documentation/Books/Users/HttpDatabase/DatabaseEndpoint.mdpp rename to Documentation/Books/HTTP/Database/DatabaseEndpoint.mdpp diff --git a/Documentation/Books/Users/HttpDatabase/DatabaseManagement.mdpp b/Documentation/Books/HTTP/Database/DatabaseManagement.mdpp similarity index 100% rename from Documentation/Books/Users/HttpDatabase/DatabaseManagement.mdpp rename to Documentation/Books/HTTP/Database/DatabaseManagement.mdpp diff --git a/Documentation/Books/Users/HttpDatabase/NotesOnDatabases.mdpp b/Documentation/Books/HTTP/Database/NotesOnDatabases.mdpp similarity index 100% rename from Documentation/Books/Users/HttpDatabase/NotesOnDatabases.mdpp rename to Documentation/Books/HTTP/Database/NotesOnDatabases.mdpp diff --git a/Documentation/Books/Users/HttpDatabase/README.mdpp b/Documentation/Books/HTTP/Database/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpDatabase/README.mdpp rename to Documentation/Books/HTTP/Database/README.mdpp diff --git a/Documentation/Books/HTTP/Document/AddressAndEtag.mdpp b/Documentation/Books/HTTP/Document/AddressAndEtag.mdpp new file mode 100644 index 0000000000..d51a55f10a --- /dev/null +++ b/Documentation/Books/HTTP/Document/AddressAndEtag.mdpp @@ -0,0 +1,177 @@ +!CHAPTER Basics and Terminology + +!SUBSECTION Documents, Keys, Handles and Revisions + +Documents in ArangoDB are JSON objects. These objects can be nested (to +any depth) and may contain lists. Each document has a unique +[primary key](../../Users/Appendix/Glossary.html#document-key) which +identifies it within its collection. Furthermore, each document is +uniquely identified +by its [document handle](../../Users/Appendix/Glossary.html#document-handle) +across all collections in the same database. Different revisions of +the same document (identified by its handle) can be distinguished by their +[document revision](../../Users/Appendix/Glossary.html#document-revision). +Any transaction only ever sees a single revision of a document. + +Here is an example document: + +```js +{ + "_id" : "myusers/3456789", + "_key" : "3456789", + "_rev" : "3456789", + "firstName" : "Hugo", + "lastName" : "Schlonz", + "address" : { + "street" : "Street of Happiness", + "city" : "Heretown" + }, + "hobbies" : [ + "swimming", + "biking", + "programming" + ] +} +``` + +All documents contain special attributes: the +[document handle](../../Users/Appendix/Glossary.html#document-handle) is stored +as a string in `_id`, the +[document's primary key](../../Users/Appendix/Glossary.html#document-key) in +`_key` and the +[document revision](../../Users/Appendix/Glossary.html#document-revision) in +`_rev`. The value of the `_key` attribute can be specified by the user when +creating a document. `_id` and `_key` values are immutable once the document +has been created. The `_rev` value is maintained by ArangoDB automatically. + + +!SUBSECTION Document Handle + +A document handle uniquely identifies a document in the database. It +is a string and consists of the collection's name and the document key +(`_key` attribute) separated by `/`. + + +!SUBSECTION Document Key + +A document key uniquely identifies a document in the collection it is +stored in. It can and should be used by clients when specific documents +are queried. The document key is stored in the `_key` attribute of +each document. The key values are automatically indexed by ArangoDB in +a collection's primary index. Thus looking up a document by its +key is a fast operation. The _key value of a document is +immutable once the document has been created. By default, ArangoDB will +auto-generate a document key if no _key attribute is specified, and use +the user-specified _key otherwise. + +This behavior can be changed on a per-collection level by creating +collections with the `keyOptions` attribute. + +Using `keyOptions` it is possible to disallow user-specified keys +completely, or to force a specific regime for auto-generating the `_key` +values. + + +!SUBSECTION Document Revision + +As ArangoDB supports MVCC (Multiple Version Concurrency Control), +documents can exist in more than one +revision. The document revision is the MVCC token used to specify +a particular revision of a document (identified by its `_id`). +It is a string value currently +containing an integer number and is unique within the list of document +revisions for a single document. Document revisions can be used to +conditionally query, update, replace or delete documents in the database. In +order to find a particular revision of a document, you need the document +handle or key, and the document revision. + +ArangoDB uses 64bit unsigned integer values to maintain +document revisions internally. When returning document revisions to +clients, ArangoDB will put them into a string to ensure the revision +is not clipped by clients that do not support big integers. Clients +should treat the revision returned by ArangoDB as an opaque string +when they store or use it locally. This will allow ArangoDB to change +the format of revisions later if this should be required. Clients can +use revisions to perform simple equality/non-equality comparisons +(e.g. to check whether a document has changed or not), but they should +not use revision ids to perform greater/less than comparisons with them +to check if a document revision is older than one another, even if this +might work for some cases. + + +!SUBSECTION Document Etag + +ArangoDB tries to adhere to the existing HTTP standard as far as +possible. To this end, results of single document queries have the HTTP +header `ETag` set to the document revision enclosed in double quotes. + +The basic operations (create, read, exists, replace, update, delete) +for documents are mapped to the standard HTTP methods (*POST*, *GET*, +*HEAD*, *PUT*, *PATCH* and *DELETE*). + +If you modify a document, you can use the *If-Match* field to detect conflicts. +The revision of a document can be checking using the HTTP method *HEAD*. + + +!SUBSECTION Multiple Documents in a single Request + +Beginning with ArangoDB 3.0 the basic document API has been extended +to handle not only single documents but multiple documents in a single +request. This is crucial for performance, in particular in the cluster +situation, in which a single request can involve multiple network hops +within the cluster. Another advantage is that it reduces the overhead of +the HTTP protocol and individual network round trips between the client +and the server. The general idea to perform multiple document operations +in a single request is to use a JSON array of objects in the place of a +single document. As a consequence, document keys, handles and revisions +for preconditions have to be supplied embedded in the individual documents +given. Multiple document operations are restricted to a single document +or edge collections. +See the [API descriptions](WorkingWithDocuments.md) for details. + +Note that the *GET*, *HEAD* and *DELETE* HTTP operations generally do +not allow to pass a message body. Thus, they cannot be used to perform +multiple document operations in one request. However, there are other +endpoints to request and delete multiple documents in one request. +FIXME: ADD SENSIBLE LINKS HERE. + + +!SUBSECTION URI of a Document + +Any document can be retrieved using its unique URI: + + http://server:port/_api/document/ + +For example, assuming that the document handle +is `demo/362549736`, then the URL of that document +is: + + http://localhost:8529/_api/document/demo/362549736 + +The above URL schema does not specify a +[database name](../../Users/Appendix/Glossary..html#database-name) +explicitly, so the +default database `_system` will be used. +To explicitly specify the database context, use +the following URL schema: + + http://server:port/_db//_api/document/ + +Example: + + http://localhost:8529/_db/mydb/_api/document/demo/362549736 + +**Note**: The following examples use the short URL format for brevity. + +The [document revision](../../Users/Appendix/Glossary.html#document-revision) +is returned in the "ETag" HTTP header when requesting a document. + +If you obtain a document using *GET* and you want to check whether a +newer revision +is available, then you can use the *If-None-Match* header. If the document is +unchanged, a *HTTP 412* (precondition failed) error is returned. + +If you want to query, replace, update or delete a document, then you +can use the *If-Match* header. If the document has changed, then the +operation is aborted and an *HTTP 412* error is returned. + diff --git a/Documentation/Books/HTTP/Document/README.mdpp b/Documentation/Books/HTTP/Document/README.mdpp new file mode 100644 index 0000000000..487cb8fd00 --- /dev/null +++ b/Documentation/Books/HTTP/Document/README.mdpp @@ -0,0 +1,13 @@ +!CHAPTER HTTP Interface for Documents + +In this chapter we describe the REST API of ArangoDB for documents. +We begin with a + + - [section on the basic approach](AddressAndEtag.md) + +before we proceed with + + - [the detailed API description](WorkingWithDocuments.md), + +which has all the gory details. + diff --git a/Documentation/Books/HTTP/Document/WorkingWithDocuments.mdpp b/Documentation/Books/HTTP/Document/WorkingWithDocuments.mdpp new file mode 100644 index 0000000000..27b396725e --- /dev/null +++ b/Documentation/Books/HTTP/Document/WorkingWithDocuments.mdpp @@ -0,0 +1,124 @@ +!CHAPTER Working with Documents using REST + + +@startDocuBlock REST_DOCUMENT_READ + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The *rev* query parameter has been withdrawn. The same effect can be +achieved with the *If-Match* HTTP header. + + +@startDocuBlock REST_DOCUMENT_READ_HEAD + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The *rev* query parameter has been withdrawn. The same effect can be +achieved with the *If-Match* HTTP header. + + +@startDocuBlock REST_DOCUMENT_READ_ALL + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The collection name should now be specified in the URL path. The old +way with the URL path */_api/document* and the required query parameter +*collection* still works. + + +@startDocuBlock REST_DOCUMENT_CREATE + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The collection name should now be specified in the URL path. The old +way with the URL path */_api/document* and the required query parameter +*collection* still works. The possibility to insert multiple documents +with one operation is new and the query parameter *returnNew* has been added. + + + +@startDocuBlock REST_DOCUMENT_REPLACE + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +There are quite some changes in this in comparison to Version 2.8, but +few break existing usage: + + - the *rev* query parameter is gone (was duplication of If-Match) + - the *policy* query parameter is gone (was non-sensical) + - the *ignoreRevs* query parameter is new, the default *true* gives + the traditional behaviour as in 2.8 + - the *returnNew* and *returnOld* query parameters are new + +There should be very few changes to behaviour happening in real-world +situations or drivers. Essentially, one has to replace usage of the +*rev* query parameter by usage of the *If-Match* header. The non-sensical +combination of *If-Match* given and *policy=last* no longer works, but can +easily be achieved by leaving out the *If-Match* header. + +The collection name should now be specified in the URL path. The old +way with the URL path */_api/document* and the required query parameter +*collection* still works. + + +@startDocuBlock REST_DOCUMENT_REPLACE_MULTI + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The multi document version is new in 3.0. + + +@startDocuBlock REST_DOCUMENT_UPDATE + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +There are quite some changes in this in comparison to Version 2.8, but +few break existing usage: + + - the *rev* query parameter is gone (was duplication of If-Match) + - the *policy* query parameter is gone (was non-sensical) + - the *ignoreRevs* query parameter is new, the default *true* gives + the traditional behaviour as in 2.8 + - the *returnNew* and *returnOld* query parameters are new + +There should be very few changes to behaviour happening in real-world +situations or drivers. Essentially, one has to replace usage of the +*rev* query parameter by usage of the *If-Match* header. The non-sensical +combination of *If-Match* given and *policy=last* no longer works, but can +easily be achieved by leaving out the *If-Match* header. + +The collection name should now be specified in the URL path. The old +way with the URL path */_api/document* and the required query parameter +*collection* still works. + + +@startDocuBlock REST_DOCUMENT_UPDATE_MULTI + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The multi document version is new in 3.0. + + +@startDocuBlock REST_DOCUMENT_DELETE + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +There are only very few changes in this in comparison to Version 2.8: + + - the *rev* query parameter is gone (was duplication of If-Match) + - the *policy* query parameter is gone (was non-sensical) + - the *returnOld* query parameter is new + +There should be very few changes to behaviour happening in real-world +situations or drivers. Essentially, one has to replace usage of the +*rev* query parameter by usage of the *If-Match* header. The non-sensical +combination of *If-Match* given and *policy=last* no longer works, but can +easily be achieved by leaving out the *If-Match* header. + + +@startDocuBlock REST_DOCUMENT_DELETE_MULTI + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +This variant is new in 3.0. Note that it requires a body in the DELETE +request. diff --git a/Documentation/Books/Users/HttpEdge/AddressAndEtag.mdpp b/Documentation/Books/HTTP/Edge/AddressAndEtag.mdpp similarity index 100% rename from Documentation/Books/Users/HttpEdge/AddressAndEtag.mdpp rename to Documentation/Books/HTTP/Edge/AddressAndEtag.mdpp diff --git a/Documentation/Books/Users/HttpEdge/README.mdpp b/Documentation/Books/HTTP/Edge/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpEdge/README.mdpp rename to Documentation/Books/HTTP/Edge/README.mdpp diff --git a/Documentation/Books/Users/HttpEdge/WorkingWithEdges.mdpp b/Documentation/Books/HTTP/Edge/WorkingWithEdges.mdpp similarity index 100% rename from Documentation/Books/Users/HttpEdge/WorkingWithEdges.mdpp rename to Documentation/Books/HTTP/Edge/WorkingWithEdges.mdpp diff --git a/Documentation/Books/Users/HttpEndpoints/README.mdpp b/Documentation/Books/HTTP/Endpoints/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpEndpoints/README.mdpp rename to Documentation/Books/HTTP/Endpoints/README.mdpp diff --git a/Documentation/Books/Users/HttpExport/README.mdpp b/Documentation/Books/HTTP/Export/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpExport/README.mdpp rename to Documentation/Books/HTTP/Export/README.mdpp diff --git a/Documentation/Books/Users/GeneralHttp/README.mdpp b/Documentation/Books/HTTP/General/README.mdpp similarity index 100% rename from Documentation/Books/Users/GeneralHttp/README.mdpp rename to Documentation/Books/HTTP/General/README.mdpp diff --git a/Documentation/Books/Users/HttpGharial/Edges.mdpp b/Documentation/Books/HTTP/Gharial/Edges.mdpp similarity index 100% rename from Documentation/Books/Users/HttpGharial/Edges.mdpp rename to Documentation/Books/HTTP/Gharial/Edges.mdpp diff --git a/Documentation/Books/Users/HttpGharial/Management.mdpp b/Documentation/Books/HTTP/Gharial/Management.mdpp similarity index 100% rename from Documentation/Books/Users/HttpGharial/Management.mdpp rename to Documentation/Books/HTTP/Gharial/Management.mdpp diff --git a/Documentation/Books/Users/HttpGharial/README.mdpp b/Documentation/Books/HTTP/Gharial/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpGharial/README.mdpp rename to Documentation/Books/HTTP/Gharial/README.mdpp diff --git a/Documentation/Books/Users/HttpGharial/Vertices.mdpp b/Documentation/Books/HTTP/Gharial/Vertices.mdpp similarity index 100% rename from Documentation/Books/Users/HttpGharial/Vertices.mdpp rename to Documentation/Books/HTTP/Gharial/Vertices.mdpp diff --git a/Documentation/Books/HTTP/HEADER.html b/Documentation/Books/HTTP/HEADER.html new file mode 100644 index 0000000000..9a1ec7309f --- /dev/null +++ b/Documentation/Books/HTTP/HEADER.html @@ -0,0 +1,42 @@ + \ No newline at end of file diff --git a/Documentation/Books/Users/HttpIndexes/Fulltext.mdpp b/Documentation/Books/HTTP/Indexes/Fulltext.mdpp similarity index 100% rename from Documentation/Books/Users/HttpIndexes/Fulltext.mdpp rename to Documentation/Books/HTTP/Indexes/Fulltext.mdpp diff --git a/Documentation/Books/Users/HttpIndexes/Geo.mdpp b/Documentation/Books/HTTP/Indexes/Geo.mdpp similarity index 100% rename from Documentation/Books/Users/HttpIndexes/Geo.mdpp rename to Documentation/Books/HTTP/Indexes/Geo.mdpp diff --git a/Documentation/Books/Users/HttpIndexes/Hash.mdpp b/Documentation/Books/HTTP/Indexes/Hash.mdpp similarity index 100% rename from Documentation/Books/Users/HttpIndexes/Hash.mdpp rename to Documentation/Books/HTTP/Indexes/Hash.mdpp diff --git a/Documentation/Books/Users/HttpIndexes/README.mdpp b/Documentation/Books/HTTP/Indexes/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpIndexes/README.mdpp rename to Documentation/Books/HTTP/Indexes/README.mdpp diff --git a/Documentation/Books/Users/HttpIndexes/Skiplist.mdpp b/Documentation/Books/HTTP/Indexes/Skiplist.mdpp similarity index 100% rename from Documentation/Books/Users/HttpIndexes/Skiplist.mdpp rename to Documentation/Books/HTTP/Indexes/Skiplist.mdpp diff --git a/Documentation/Books/Users/HttpIndexes/WorkingWith.mdpp b/Documentation/Books/HTTP/Indexes/WorkingWith.mdpp similarity index 100% rename from Documentation/Books/Users/HttpIndexes/WorkingWith.mdpp rename to Documentation/Books/HTTP/Indexes/WorkingWith.mdpp diff --git a/Documentation/Books/Users/HttpMiscellaneousFunctions/README.mdpp b/Documentation/Books/HTTP/MiscellaneousFunctions/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpMiscellaneousFunctions/README.mdpp rename to Documentation/Books/HTTP/MiscellaneousFunctions/README.mdpp diff --git a/Documentation/Books/HTTP/README.mdpp b/Documentation/Books/HTTP/README.mdpp new file mode 100644 index 0000000000..6d2a08940f --- /dev/null +++ b/Documentation/Books/HTTP/README.mdpp @@ -0,0 +1,4 @@ +!BOOK ArangoDB VERSION_NUMBER HTTP API Documentation + +Welcome to the ArangoDB HTTP API documentation! + diff --git a/Documentation/Books/Users/HttpReplications/OtherReplication.mdpp b/Documentation/Books/HTTP/Replications/OtherReplication.mdpp similarity index 100% rename from Documentation/Books/Users/HttpReplications/OtherReplication.mdpp rename to Documentation/Books/HTTP/Replications/OtherReplication.mdpp diff --git a/Documentation/Books/Users/HttpReplications/README.mdpp b/Documentation/Books/HTTP/Replications/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpReplications/README.mdpp rename to Documentation/Books/HTTP/Replications/README.mdpp diff --git a/Documentation/Books/Users/HttpReplications/ReplicationApplier.mdpp b/Documentation/Books/HTTP/Replications/ReplicationApplier.mdpp similarity index 100% rename from Documentation/Books/Users/HttpReplications/ReplicationApplier.mdpp rename to Documentation/Books/HTTP/Replications/ReplicationApplier.mdpp diff --git a/Documentation/Books/Users/HttpReplications/ReplicationDump.mdpp b/Documentation/Books/HTTP/Replications/ReplicationDump.mdpp similarity index 100% rename from Documentation/Books/Users/HttpReplications/ReplicationDump.mdpp rename to Documentation/Books/HTTP/Replications/ReplicationDump.mdpp diff --git a/Documentation/Books/Users/HttpReplications/ReplicationLogger.mdpp b/Documentation/Books/HTTP/Replications/ReplicationLogger.mdpp similarity index 100% rename from Documentation/Books/Users/HttpReplications/ReplicationLogger.mdpp rename to Documentation/Books/HTTP/Replications/ReplicationLogger.mdpp diff --git a/Documentation/Books/HTTP/SUMMARY.md b/Documentation/Books/HTTP/SUMMARY.md new file mode 100644 index 0000000000..b7868a6b41 --- /dev/null +++ b/Documentation/Books/HTTP/SUMMARY.md @@ -0,0 +1,55 @@ + +# Summary +* [General HTTP Handling](General/README.md) +* [HTTP Interface](Api/README.md) +* [Databases](Database/README.md) + * [To-Endpoint](Database/DatabaseEndpoint.md) + * [Management](Database/DatabaseManagement.md) + * [Notes on Databases](Database/NotesOnDatabases.md) +* [Documents](Document/README.md) + * [Basics and Terminology](Document/AddressAndEtag.md) + * [Working with Documents](Document/WorkingWithDocuments.md) +* [Edges](Edge/README.md) + * [Address and ETag](Edge/AddressAndEtag.md) + * [Working with Edges](Edge/WorkingWithEdges.md) +* [Exporting data](Export/README.md) +* [AQL Query Cursors](AqlQueryCursor/README.md) + * [Query Results](AqlQueryCursor/QueryResults.md) + * [Accessing Cursors](AqlQueryCursor/AccessingCursors.md) +* [AQL Queries](AqlQuery/README.md) +* [AQL Query Cache](AqlQueryCache/README.md) +* [AQL User Functions Management](AqlUserFunctions/README.md) +* [Simple Queries](SimpleQuery/README.md) +* [Collections](Collection/README.md) + * [Creating](Collection/Creating.md) + * [Getting Information](Collection/Getting.md) + * [Modifying](Collection/Modifying.md) +* [Indexes](Indexes/README.md) + * [Working with Indexes](Indexes/WorkingWith.md) + * [Cap Constraints](Indexes/Cap.md) + * [Hash](Indexes/Hash.md) + * [Skiplist](Indexes/Skiplist.md) + * [Geo](Indexes/Geo.md) + * [Fulltext](Indexes/Fulltext.md) +* [Transactions](Transaction/README.md) +* [General Graph](Gharial/README.md) + * [Management](Gharial/Management.md) + * [Vertices](Gharial/Vertices.md) + * [Edges](Gharial/Edges.md) +* [Traversals](Traversal/README.md) +* [Replication](Replications/README.md) + * [Replication Dump](Replications/ReplicationDump.md) + * [Replication Logger](Replications/ReplicationLogger.md) + * [Replication Applier](Replications/ReplicationApplier.md) + * [Other Replication Commands](Replications/OtherReplication.md) +* [Tasks](Tasks/README.md) +* [Monitoring](AdministrationAndMonitoring/README.md) +* [User Management](UserManagement/README.md) +* [Async Result Handling](AsyncResultsManagement/README.md) +* [Endpoints](Endpoints/README.md) +* [Sharding](ShardingInterface/README.md) +* [Miscellaneous functions](MiscellaneousFunctions/README.md) +* [Bulk Import / Export](BulkImports/README.md) + * [JSON Documents](BulkImports/ImportingSelfContained.md) + * [Headers & Values](BulkImports/ImportingHeadersAndValues.md) + * [Batch Requests](BatchRequest/README.md) diff --git a/Documentation/Books/Users/HttpShardingInterface/README.mdpp b/Documentation/Books/HTTP/ShardingInterface/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpShardingInterface/README.mdpp rename to Documentation/Books/HTTP/ShardingInterface/README.mdpp diff --git a/Documentation/Books/Users/HttpSimpleQuery/README.mdpp b/Documentation/Books/HTTP/SimpleQuery/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpSimpleQuery/README.mdpp rename to Documentation/Books/HTTP/SimpleQuery/README.mdpp diff --git a/Documentation/Books/Users/HttpTasks/README.mdpp b/Documentation/Books/HTTP/Tasks/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpTasks/README.mdpp rename to Documentation/Books/HTTP/Tasks/README.mdpp diff --git a/Documentation/Books/Users/HttpTransaction/README.mdpp b/Documentation/Books/HTTP/Transaction/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpTransaction/README.mdpp rename to Documentation/Books/HTTP/Transaction/README.mdpp diff --git a/Documentation/Books/Users/HttpTraversal/README.mdpp b/Documentation/Books/HTTP/Traversal/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpTraversal/README.mdpp rename to Documentation/Books/HTTP/Traversal/README.mdpp diff --git a/Documentation/Books/Users/HttpUserManagement/README.mdpp b/Documentation/Books/HTTP/UserManagement/README.mdpp similarity index 100% rename from Documentation/Books/Users/HttpUserManagement/README.mdpp rename to Documentation/Books/HTTP/UserManagement/README.mdpp diff --git a/Documentation/Books/HTTP/book.json b/Documentation/Books/HTTP/book.json new file mode 100644 index 0000000000..c52200a9d0 --- /dev/null +++ b/Documentation/Books/HTTP/book.json @@ -0,0 +1,27 @@ +{ + "gitbook": ">=2.0.0", + "title": "ArangoDB VERSION_NUMBER HTTP API Documentation", + "author": "ArangoDB GmbH", + "description": "Official HTTP API manual for ArangoDB - the multi-model NoSQL database", + "language": "en", + "plugins":["-search", "-sharing", "toggle-chapters", "addcssjs", "heading-anchors", "add-header"], + "pdf": { + "fontSize": 12, + "toc": true, + "margin": { + "right": 60, + "left": 60, + "top": 35, + "bottom": 35 + } + }, + "styles": { + "website": "styles/website.css" + }, + "pluginsConfig": { + "addcssjs": { + "js": ["styles/header.js"], + "css": ["styles/header.css"] + } + } +} diff --git a/Documentation/Books/HTTP/styles/header.css b/Documentation/Books/HTTP/styles/header.css new file mode 100644 index 0000000000..14be63b299 --- /dev/null +++ b/Documentation/Books/HTTP/styles/header.css @@ -0,0 +1,239 @@ +/* Design fix because of the header */ +@import url(https://fonts.googleapis.com/css?family=Roboto:400,500,300,700); + +body { + overflow: hidden; + font-family: Roboto, Helvetica, sans-serif; + background: #444444; +} + +.book .book-header h1 a, .book .book-header h1 a:hover { + display: none; +} + +/* GOOGLE START */ + +.google-search #gsc-iw-id1{ + border: none !important; +} + +.google-search .gsst_b { + position: relative; + top: 10px; + left: -25px; + width: 1px; +} + +.gsst_a .gscb_a { + color: #c01a07 !important; +} + +.google-search input { + background-color: #fff !important; + font-family: Roboto, Helvetica, sans-serif; + font-size: 10pt !important; + padding-left: 5px !important; + float: right; + position: relative; + top: 8px; + width: 100% !important; + height: 30px !important; +} + +.google-search input:active { +} + +.google-search { + margin-right: 114px !important; + margin-left: 10px !important; + float: right !important; +} + +.google-search td, +.google-search table, +.google-search tr, +.google-search th { + background-color: #444444 !important; +} + +.google-search .gsc-input-box, +.google-search .gsc-input-box input { + border-radius: 3px !important; + width: 200px; +} + +.gsc-branding-text, +.gsc-branding-img, +.gsc-user-defined-text { + display: none !important; +} + +.google-search .gsc-input-box input { + font-size: 16px !important; +} + +.google-search .gsc-search-button { + display: none !important; +} + +.google-search .gsc-control-cse { + padding: 10px !important; +} + +.google-search > div { + float: left !important; + width: 200px !important; +} + +/* GOOGLE END */ + +.book-summary, +.book-body { + margin-top: 48px; +} + +.book .book-summary ul.summary li.active > a, +.book .book-summary ul.summary li a:hover { + color: #fff !important; +} + +#logo { + display: block; + float: left; + color: #fff; + width: 12%; + line-height: 40px; +} + +#logo img { + width: 150px; + margin-top: 0px; + margin-left: 114px; +} + +.wrap { + display: block; + margin: 0 auto; + max-width: 1200px; + padding: 0 10px; +} + +#header { + position: fixed; + width: 100%; + height: 48px; + z-index: 1; +} + +#header .socialIcons-googlegroups a img { + position: relative; + top: 3px; +} + +/* +#header .wrap, +#header .wrap .clearfix { + max-height: 48px; +} +*/ + +.absolute{ + position: absolute; + z-index: 10; + right: 0; + left: 0; + top: 0; +} + +#navmenu { + display: block; + float: right; + margin: 0px; +} + +#navmenu li { + display: block; + float: left; +} + +#navmenu li a { + display: block; + float: left; + padding-left: 10px; + padding-right: 10px; + line-height: 48px; + font-size: 16px; + font-weight: 400; + color: #fff; + text-decoration: none; + font-family: Roboto, Helvetica, sans-serif; +} + +#navmenu li a:hover, #navmenu li.active-tab a { + background: #8aa051 !important; +} + +.arangodb_version { + float: left; + padding-left: 130px; + padding-top: 3px; + padding-right: 0px; + line-height: 40px; + font-weight: bold; + color: #fff; + text-decoration: none; +} + +/** simple responsive updates **/ + +@media screen and (max-width: 1100px) { + #logo { + position: absolute; + left: -100px; + } + + .google-search { + margin-right: -5px !important; + } + + .socialIcons { + display: none !important; + } +} + + +@media screen and (max-width: 770px) { + .google-search { + margin-right: -5px !important; + width: 200px !important; + } + #navmenu { + display: none; + } + #navmenu li a { font-size: 0.8em; padding: 0 15px; } + #navmenu li a img { width:11px; height:36px; padding-top: 4px; } + #logo { + width: 100px; + height: 50px; + position: absolute; + top: 4px; + left: -100px; + z-index: 9999; + } + #logo img { + width: 100px; + margin-top:4px; + position: absolute; + float: left; + left: -10px; + } + + .arangodb_version { display: none !important; } +} + +/** clearfix **/ +.clearfix:after { content: "."; display: block; clear: both; visibility: hidden; line-height: 0; height: 0; } +.clearfix { display: inline-block; } + +html[xmlns] .clearfix { display: block; } +* html .clearfix { height: 1%; } diff --git a/Documentation/Books/HTTP/styles/header.js b/Documentation/Books/HTTP/styles/header.js new file mode 100644 index 0000000000..78d4cfe65c --- /dev/null +++ b/Documentation/Books/HTTP/styles/header.js @@ -0,0 +1,40 @@ +window.onload = function(){ +window.localStorage.removeItem(":keyword"); + +$(document).ready(function() { + +function appendHeader() { +/* + var div = document.createElement('div'); + div.innerHTML = ''; + + $('.book').before(div.innerHTML); +*/ + }; + + + function rerenderNavbar() { + $('#header').remove(); + appendHeader(); + renderGoogleSearch(); + }; + + function renderGoogleSearch() { + }; + //render header + //rerenderNavbar(); + function addGoogleSrc() { + var cx = '002866056653122356950:ju52xx-w-w8'; + var gcse = document.createElement('script'); + gcse.type = 'text/javascript'; + gcse.async = true; + gcse.src = (document.location.protocol == 'https:' ? 'https:' : 'http:') + + '//cse.google.com/cse.js?cx=' + cx; + var s = document.getElementsByTagName('script')[0]; + s.parentNode.insertBefore(gcse, s); + }; + addGoogleSrc(); + +}); + +}; diff --git a/Documentation/Books/HTTP/styles/website.css b/Documentation/Books/HTTP/styles/website.css new file mode 100644 index 0000000000..760c605a94 --- /dev/null +++ b/Documentation/Books/HTTP/styles/website.css @@ -0,0 +1,43 @@ +div.example_show_button { + border: medium solid lightgray; + text-align: center; + position: relative; + top: -10px; +} + +.book .book-body .navigation.navigation-next { + right: 10px !important; +} + +.book .book-summary ul.summary li.active>a,.book .book-summary ul.summary li a:hover { + color: #fff !important; + background: #80A54D !important; + text-decoration: none; +} + +.book .book-body .page-wrapper .page-inner section.normal .deprecated{ + background-color: rgba(240,240,0,0.4); +} + +.columns-3 { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + columns: 3; +} + +.gsib_a { +padding: 0px !important; +} + +.gsc-control-cse { +border: 0px !important; +background-color: transparent !important; +} + + +.gsc-input { +margin: 0px !important; +} diff --git a/Documentation/Books/Makefile b/Documentation/Books/Makefile index de5f978738..5d4004981c 100644 --- a/Documentation/Books/Makefile +++ b/Documentation/Books/Makefile @@ -128,6 +128,7 @@ build-book: done; \ fi cd ppbooks/$(NAME); if ! test -L SUMMARY.md; then ln -s ../../$(NAME)/SUMMARY.md . ; fi + cd ppbooks/$(NAME); if ! test -f HEADER.html ; then cp ../../$(NAME)/HEADER.html . ; fi cd ppbooks/$(NAME); if ! test -f book.json ; then cp ../../$(NAME)/book.json . ; fi cd ppbooks/$(NAME); cp -a ../../$(NAME)/styles/* styles/ WD=`pwd`; \ @@ -140,23 +141,24 @@ build-book: python ../Scripts/generateMdFiles.py $(NAME) ppbooks/ ../../js/apps/system/_admin/aardvark/APP/api-docs.json $(FILTER) cd ppbooks/$(NAME) && sed -i -e 's/VERSION_NUMBER/v$(newVersionNumber)/g' styles/header.js + cd ppbooks/$(NAME) && sed -i -e 's/VERSION_NUMBER/v$(newVersionNumber)/g' HEADER.html cd ppbooks/$(NAME) && sed -i -e 's/VERSION_NUMBER/v$(newVersionNumber)/g' README.md cd ppbooks/$(NAME) && sed -i -e 's/VERSION_NUMBER/v$(newVersionNumber)/g' book.json test -d books/$(NAME) || mkdir -p books/$(NAME) - make check-summary - make book-check-leftover-docublocks - make book-check-restheader-leftovers - make book-check-mdpp-leftovers - make ppbook-check-html-link - make ppbook-check-directory-link + #make check-summary + #make book-check-leftover-docublocks + #make book-check-restheader-leftovers + #make book-check-mdpp-leftovers + #make ppbook-check-html-link + #make ppbook-check-directory-link cd ppbooks/$(NAME) && gitbook install cd ppbooks/$(NAME) && gitbook build ./ ./../../books/$(NAME) python ../Scripts/deprecated.py - make book-check-markdown-leftovers + #make book-check-markdown-leftovers clean-book: @rm -rvf books/$(NAME) @@ -231,7 +233,7 @@ check-docublocks: fi clean-intermediate: - make clean-book-intermediate NAME=Users FILTER=$(FILTER) + make clean-book-intermediate NAME=$(NAME) FILTER=$(FILTER) clean: clean-intermediate @@ -243,6 +245,13 @@ clean: clean-intermediate build-books-keep-md: @test -d books || mkdir books python ../Scripts/codeBlockReader.py - make build-book NAME=Users + make build-book NAME=$(NAME) -build-books: clean-intermediate build-books-keep-md check-docublocks +build-books: + make clean-intermediate NAME=Users + make clean-intermediate NAME=AQL + make clean-intermediate NAME=HTTP + make build-books-keep-md NAME=Users + make build-books-keep-md NAME=AQL + make build-books-keep-md NAME=HTTP + make check-docublocks \ No newline at end of file diff --git a/Documentation/Books/Users/HttpBulkImports/Arangodump.mdpp b/Documentation/Books/Users/Administration/Arangodump.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBulkImports/Arangodump.mdpp rename to Documentation/Books/Users/Administration/Arangodump.mdpp diff --git a/Documentation/Books/Users/HttpBulkImports/Arangoimp.mdpp b/Documentation/Books/Users/Administration/Arangoimp.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBulkImports/Arangoimp.mdpp rename to Documentation/Books/Users/Administration/Arangoimp.mdpp diff --git a/Documentation/Books/Users/HttpBulkImports/Arangorestore.mdpp b/Documentation/Books/Users/Administration/Arangorestore.mdpp similarity index 100% rename from Documentation/Books/Users/HttpBulkImports/Arangorestore.mdpp rename to Documentation/Books/Users/Administration/Arangorestore.mdpp diff --git a/Documentation/Books/Users/Arangosh/Configuration.mdpp b/Documentation/Books/Users/Administration/Arangosh/Configuration.mdpp similarity index 100% rename from Documentation/Books/Users/Arangosh/Configuration.mdpp rename to Documentation/Books/Users/Administration/Arangosh/Configuration.mdpp diff --git a/Documentation/Books/Users/Arangosh/Output.mdpp b/Documentation/Books/Users/Administration/Arangosh/Output.mdpp similarity index 100% rename from Documentation/Books/Users/Arangosh/Output.mdpp rename to Documentation/Books/Users/Administration/Arangosh/Output.mdpp diff --git a/Documentation/Books/Users/Arangosh/README.mdpp b/Documentation/Books/Users/Administration/Arangosh/README.mdpp similarity index 100% rename from Documentation/Books/Users/Arangosh/README.mdpp rename to Documentation/Books/Users/Administration/Arangosh/README.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/Arangod.mdpp b/Documentation/Books/Users/Administration/Configuration/Arangod.mdpp similarity index 98% rename from Documentation/Books/Users/ConfigureArango/Arangod.mdpp rename to Documentation/Books/Users/Administration/Configuration/Arangod.mdpp index 9b29b8d313..e1c35c7551 100644 --- a/Documentation/Books/Users/ConfigureArango/Arangod.mdpp +++ b/Documentation/Books/Users/Administration/Configuration/Arangod.mdpp @@ -245,8 +245,11 @@ The following variants are available: - 2: SSLv23 - 3: SSLv3 - 4: TLSv1 +- 5: TLSv1.2 (recommended) -The default *value* is 4 (i.e. TLSv1). +The default *value* is 4 (i.e. TLSv1). If available, set it to 5 +(i.e. TLSv1.2), because lower protocol versions are known to be vulnerable +to POODLE attack variants. **Note**: this option is only relevant if at least one SSL endpoint is used. diff --git a/Documentation/Books/Users/ConfigureArango/Authentication.mdpp b/Documentation/Books/Users/Administration/Configuration/Authentication.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/Authentication.mdpp rename to Documentation/Books/Users/Administration/Configuration/Authentication.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/Cluster.mdpp b/Documentation/Books/Users/Administration/Configuration/Cluster.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/Cluster.mdpp rename to Documentation/Books/Users/Administration/Configuration/Cluster.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/Communication.mdpp b/Documentation/Books/Users/Administration/Configuration/Communication.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/Communication.mdpp rename to Documentation/Books/Users/Administration/Configuration/Communication.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/Endpoint.mdpp b/Documentation/Books/Users/Administration/Configuration/Endpoint.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/Endpoint.mdpp rename to Documentation/Books/Users/Administration/Configuration/Endpoint.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/Logging.mdpp b/Documentation/Books/Users/Administration/Configuration/Logging.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/Logging.mdpp rename to Documentation/Books/Users/Administration/Configuration/Logging.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/README.mdpp b/Documentation/Books/Users/Administration/Configuration/README.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/README.mdpp rename to Documentation/Books/Users/Administration/Configuration/README.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/Wal.mdpp b/Documentation/Books/Users/Administration/Configuration/Wal.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/Wal.mdpp rename to Documentation/Books/Users/Administration/Configuration/Wal.mdpp diff --git a/Documentation/Books/Users/AdministratingArango/README.mdpp b/Documentation/Books/Users/Administration/README.mdpp similarity index 61% rename from Documentation/Books/Users/AdministratingArango/README.mdpp rename to Documentation/Books/Users/Administration/README.mdpp index 103720de1f..9107435d1a 100644 --- a/Documentation/Books/Users/AdministratingArango/README.mdpp +++ b/Documentation/Books/Users/Administration/README.mdpp @@ -1,31 +1,8 @@ -!CHAPTER Administrating ArangoDB +!CHAPTER Administration -!SECTION AppendOnly/MVCC +!SECTION Durability Configuration -Instead of overwriting existing documents, ArangoDB will create a new version of -modified documents. This is even the case when a document gets deleted. The -two benefits are: - -* Objects can be stored coherently and compactly in the main memory. -* Objects are preserved, isolated writing and reading transactions allow - accessing these objects for parallel operations. - -The system collects obsolete versions as garbage, recognizing them as -forsaken. Garbage collection is asynchronous and runs parallel to other -processes. - -!SECTION Mostly Memory/Durability - -Database documents are stored in memory-mapped files. Per default, these -memory-mapped files are synced regularly but not instantly. This is often a good -tradeoff between storage performance and durability. If this level of durability -is too low for an application, the server can also sync all modifications to -disk instantly. This will give full durability but will come with a performance -penalty as each data modification will trigger a sync I/O operation. - -!SUBSECTION Durability Configuration - -!SUBSUBSECTION Global Configuration +!SUBSECTION Global Configuration There are global configuration values for durability, which can be adjusted by specifying the following configuration options: @@ -39,7 +16,7 @@ specifying the following configuration options: @startDocuBlock WalLogfileSyncInterval -!SUBSUBSECTION Per-collection configuration +!SUBSECTION Per-collection configuration You can also configure the durability behavior on a per-collection basis. Use the ArangoDB shell to change these properties. @@ -48,7 +25,7 @@ Use the ArangoDB shell to change these properties. @startDocuBlock collectionProperties -!SUBSUBSECTION Per-operation configuration +!SUBSECTION Per-operation configuration Many data-modification operations and also ArangoDB's transactions allow to specify a *waitForSync* attribute, which when set ensures the operation data has been diff --git a/Documentation/Books/Users/Replication/Components.mdpp b/Documentation/Books/Users/Administration/Replication/Components.mdpp similarity index 100% rename from Documentation/Books/Users/Replication/Components.mdpp rename to Documentation/Books/Users/Administration/Replication/Components.mdpp diff --git a/Documentation/Books/Users/Replication/ExampleSetup.mdpp b/Documentation/Books/Users/Administration/Replication/ExampleSetup.mdpp similarity index 100% rename from Documentation/Books/Users/Replication/ExampleSetup.mdpp rename to Documentation/Books/Users/Administration/Replication/ExampleSetup.mdpp diff --git a/Documentation/Books/Users/Replication/Limitations.mdpp b/Documentation/Books/Users/Administration/Replication/Limitations.mdpp similarity index 100% rename from Documentation/Books/Users/Replication/Limitations.mdpp rename to Documentation/Books/Users/Administration/Replication/Limitations.mdpp diff --git a/Documentation/Books/Users/Replication/Overhead.mdpp b/Documentation/Books/Users/Administration/Replication/Overhead.mdpp similarity index 100% rename from Documentation/Books/Users/Replication/Overhead.mdpp rename to Documentation/Books/Users/Administration/Replication/Overhead.mdpp diff --git a/Documentation/Books/Users/Replication/README.mdpp b/Documentation/Books/Users/Administration/Replication/README.mdpp similarity index 100% rename from Documentation/Books/Users/Replication/README.mdpp rename to Documentation/Books/Users/Administration/Replication/README.mdpp diff --git a/Documentation/Books/Users/Replication/SyncingCollections.mdpp b/Documentation/Books/Users/Administration/Replication/SyncingCollections.mdpp similarity index 100% rename from Documentation/Books/Users/Replication/SyncingCollections.mdpp rename to Documentation/Books/Users/Administration/Replication/SyncingCollections.mdpp diff --git a/Documentation/Books/Users/Sharding/Authentication.mdpp b/Documentation/Books/Users/Administration/Sharding/Authentication.mdpp similarity index 100% rename from Documentation/Books/Users/Sharding/Authentication.mdpp rename to Documentation/Books/Users/Administration/Sharding/Authentication.mdpp diff --git a/Documentation/Books/Users/Sharding/FirewallSetup.mdpp b/Documentation/Books/Users/Administration/Sharding/FirewallSetup.mdpp similarity index 100% rename from Documentation/Books/Users/Sharding/FirewallSetup.mdpp rename to Documentation/Books/Users/Administration/Sharding/FirewallSetup.mdpp diff --git a/Documentation/Books/Users/Sharding/HowTo.mdpp b/Documentation/Books/Users/Administration/Sharding/HowTo.mdpp similarity index 100% rename from Documentation/Books/Users/Sharding/HowTo.mdpp rename to Documentation/Books/Users/Administration/Sharding/HowTo.mdpp diff --git a/Documentation/Books/Users/Sharding/README.mdpp b/Documentation/Books/Users/Administration/Sharding/README.mdpp similarity index 100% rename from Documentation/Books/Users/Sharding/README.mdpp rename to Documentation/Books/Users/Administration/Sharding/README.mdpp diff --git a/Documentation/Books/Users/Sharding/StatusOfImplementation.mdpp b/Documentation/Books/Users/Administration/Sharding/StatusOfImplementation.mdpp similarity index 100% rename from Documentation/Books/Users/Sharding/StatusOfImplementation.mdpp rename to Documentation/Books/Users/Administration/Sharding/StatusOfImplementation.mdpp diff --git a/Documentation/Books/Users/Installing/Upgrading.mdpp b/Documentation/Books/Users/Administration/Upgrading/README.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/Upgrading.mdpp rename to Documentation/Books/Users/Administration/Upgrading/README.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading22.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading22.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading22.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading22.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading23.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading23.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading23.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading23.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading24.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading24.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading24.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading24.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading25.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading25.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading25.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading25.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading26.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading26.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading26.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading26.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading28.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading28.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading28.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading28.mdpp diff --git a/Documentation/Books/Users/Upgrading/Upgrading30.mdpp b/Documentation/Books/Users/Administration/Upgrading/Upgrading30.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/Upgrading30.mdpp rename to Documentation/Books/Users/Administration/Upgrading/Upgrading30.mdpp diff --git a/Documentation/Books/Users/Advanced/README.mdpp b/Documentation/Books/Users/Advanced/README.mdpp deleted file mode 100644 index d9809d9f6c..0000000000 --- a/Documentation/Books/Users/Advanced/README.mdpp +++ /dev/null @@ -1,4 +0,0 @@ -!SECTION More advanced ArangoDB topics - -This chapter covers technical details of the database system and how it can -be benchmarked. \ No newline at end of file diff --git a/Documentation/Books/Users/ArangoActions/HtmlExample.mdpp b/Documentation/Books/Users/Appendix/Deprecated/Actions/HtmlExample.mdpp similarity index 100% rename from Documentation/Books/Users/ArangoActions/HtmlExample.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/Actions/HtmlExample.mdpp diff --git a/Documentation/Books/Users/ArangoActions/JsonExample.mdpp b/Documentation/Books/Users/Appendix/Deprecated/Actions/JsonExample.mdpp similarity index 100% rename from Documentation/Books/Users/ArangoActions/JsonExample.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/Actions/JsonExample.mdpp diff --git a/Documentation/Books/Users/ArangoActions/Modifying.mdpp b/Documentation/Books/Users/Appendix/Deprecated/Actions/Modifying.mdpp similarity index 100% rename from Documentation/Books/Users/ArangoActions/Modifying.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/Actions/Modifying.mdpp diff --git a/Documentation/Books/Users/ArangoActions/README.mdpp b/Documentation/Books/Users/Appendix/Deprecated/Actions/README.mdpp similarity index 100% rename from Documentation/Books/Users/ArangoActions/README.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/Actions/README.mdpp diff --git a/Documentation/Books/Users/SimpleQueries/Access.mdpp b/Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/Access.mdpp similarity index 100% rename from Documentation/Books/Users/SimpleQueries/Access.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/Access.mdpp diff --git a/Documentation/Books/Users/SimpleQueries/FulltextQueries.mdpp b/Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/FulltextQueries.mdpp similarity index 100% rename from Documentation/Books/Users/SimpleQueries/FulltextQueries.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/FulltextQueries.mdpp diff --git a/Documentation/Books/Users/SimpleQueries/GeoQueries.mdpp b/Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/GeoQueries.mdpp similarity index 100% rename from Documentation/Books/Users/SimpleQueries/GeoQueries.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/GeoQueries.mdpp diff --git a/Documentation/Books/Users/SimpleQueries/ModificationQueries.mdpp b/Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/ModificationQueries.mdpp similarity index 100% rename from Documentation/Books/Users/SimpleQueries/ModificationQueries.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/ModificationQueries.mdpp diff --git a/Documentation/Books/Users/SimpleQueries/Pagination.mdpp b/Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/Pagination.mdpp similarity index 100% rename from Documentation/Books/Users/SimpleQueries/Pagination.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/Pagination.mdpp diff --git a/Documentation/Books/Users/SimpleQueries/README.mdpp b/Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/README.mdpp similarity index 100% rename from Documentation/Books/Users/SimpleQueries/README.mdpp rename to Documentation/Books/Users/Appendix/Deprecated/SimpleQueries/README.mdpp diff --git a/Documentation/Books/Users/ErrorCodes/README.mdpp b/Documentation/Books/Users/Appendix/ErrorCodes.mdpp similarity index 100% rename from Documentation/Books/Users/ErrorCodes/README.mdpp rename to Documentation/Books/Users/Appendix/ErrorCodes.mdpp diff --git a/Documentation/Books/Users/Glossary/README.mdpp b/Documentation/Books/Users/Appendix/Glossary.mdpp similarity index 95% rename from Documentation/Books/Users/Glossary/README.mdpp rename to Documentation/Books/Users/Appendix/Glossary.mdpp index af54ccfd30..894387b2e5 100644 --- a/Documentation/Books/Users/Glossary/README.mdpp +++ b/Documentation/Books/Users/Appendix/Glossary.mdpp @@ -83,15 +83,26 @@ A document handle uniquely identifies a document in the database. It is a string !SUBSECTION Document Key -A document key is a string that uniquely identifies a document in a given collection. It can and should be used by clients when specific documents are searched. Document keys are stored in the `_key` attribute of documents. The key values are automatically indexed by ArangoDB in a collection's primary index. Thus looking up a document by its key is regularly a fast operation. The `_key` value of a document is immutable once the document has been created. +A document key is a string that uniquely identifies a document in a +given collection. It can and should be used by clients when specific +documents are searched. Document keys are stored in the `_key` attribute +of documents. The key values are automatically indexed by ArangoDB in +a collection's primary index. Thus looking up a document by its key is +regularly a fast operation. The `_key` value of a document is immutable +once the document has been created. -By default, ArangoDB will auto-generate a document key if no `_key` attribute is specified, and use the user-specified `_key` value otherwise. +By default, ArangoDB will auto-generate a document key if no `_key` +attribute is specified, and use the user-specified `_key` value +otherwise. -This behavior can be changed on a per-collection level by creating collections with the `keyOptions` attribute. +This behavior can be changed on a per-collection level by creating +collections with the `keyOptions` attribute. Using `keyOptions` it is possible to disallow user-specified keys completely, or to force a specific regime for auto-generating the `_key` values. -There are some restrictions for user-defined keys (see [NamingConventions for document keys](../NamingConventions/DocumentKeys.md). +There are some restrictions for user-defined +keys (see +[NamingConventions for document keys](../NamingConventions/DocumentKeys.md)). !SUBSECTION Document Revision diff --git a/Documentation/Books/Users/ModuleActions/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/Actions.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleActions/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/Actions.mdpp diff --git a/Documentation/Books/Users/ModuleConsole/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/Console.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleConsole/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/Console.mdpp diff --git a/Documentation/Books/Users/ModuleFs/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/FS.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleFs/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/FS.mdpp diff --git a/Documentation/Books/Users/ModuleProcess/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/Process.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleProcess/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/Process.mdpp diff --git a/Documentation/Books/Users/ModuleQueries/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/Queries.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleQueries/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/Queries.mdpp diff --git a/Documentation/Books/Users/ModuleJavaScript/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/README.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleJavaScript/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/README.mdpp diff --git a/Documentation/Books/Users/ModuleRequest/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/Request.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleRequest/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/Request.mdpp diff --git a/Documentation/Books/Users/ModuleTasks/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/Tasks.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleTasks/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/Tasks.mdpp diff --git a/Documentation/Books/Users/ModuleWal/README.mdpp b/Documentation/Books/Users/Appendix/JavaScriptModules/WAL.mdpp similarity index 100% rename from Documentation/Books/Users/ModuleWal/README.mdpp rename to Documentation/Books/Users/Appendix/JavaScriptModules/WAL.mdpp diff --git a/Documentation/Books/Users/Appendix/README.mdpp b/Documentation/Books/Users/Appendix/README.mdpp new file mode 100644 index 0000000000..2e02250dae --- /dev/null +++ b/Documentation/Books/Users/Appendix/README.mdpp @@ -0,0 +1 @@ +!CHAPTER Appendix \ No newline at end of file diff --git a/Documentation/Books/Users/Architecture/README.mdpp b/Documentation/Books/Users/Architecture/README.mdpp new file mode 100644 index 0000000000..e99a0e2391 --- /dev/null +++ b/Documentation/Books/Users/Architecture/README.mdpp @@ -0,0 +1,24 @@ +!CHAPTER Architecture + +!SECTION AppendOnly/MVCC + +Instead of overwriting existing documents, ArangoDB will create a new version of +modified documents. This is even the case when a document gets deleted. The +two benefits are: + +* Objects can be stored coherently and compactly in the main memory. +* Objects are preserved, isolated writing and reading transactions allow + accessing these objects for parallel operations. + +The system collects obsolete versions as garbage, recognizing them as +forsaken. Garbage collection is asynchronous and runs parallel to other +processes. + +!SECTION Mostly Memory/Durability + +Database documents are stored in memory-mapped files. Per default, these +memory-mapped files are synced regularly but not instantly. This is often a good +tradeoff between storage performance and durability. If this level of durability +is too low for an application, the server can also sync all modifications to +disk instantly. This will give full durability but will come with a performance +penalty as each data modification will trigger a sync I/O operation. diff --git a/Documentation/Books/Users/Advanced/ServerInternals.mdpp b/Documentation/Books/Users/Architecture/ServerInternals.mdpp similarity index 100% rename from Documentation/Books/Users/Advanced/ServerInternals.mdpp rename to Documentation/Books/Users/Architecture/ServerInternals.mdpp diff --git a/Documentation/Books/Users/Advanced/WriteAheadLog.mdpp b/Documentation/Books/Users/Architecture/WriteAheadLog.mdpp similarity index 100% rename from Documentation/Books/Users/Advanced/WriteAheadLog.mdpp rename to Documentation/Books/Users/Architecture/WriteAheadLog.mdpp diff --git a/Documentation/Books/Users/Collections/CollectionMethods.mdpp b/Documentation/Books/Users/DataModeling/Collections/CollectionMethods.mdpp similarity index 100% rename from Documentation/Books/Users/Collections/CollectionMethods.mdpp rename to Documentation/Books/Users/DataModeling/Collections/CollectionMethods.mdpp diff --git a/Documentation/Books/Users/Collections/DatabaseMethods.mdpp b/Documentation/Books/Users/DataModeling/Collections/DatabaseMethods.mdpp similarity index 99% rename from Documentation/Books/Users/Collections/DatabaseMethods.mdpp rename to Documentation/Books/Users/DataModeling/Collections/DatabaseMethods.mdpp index 9c2adb2f32..f7cdf02016 100644 --- a/Documentation/Books/Users/Collections/DatabaseMethods.mdpp +++ b/Documentation/Books/Users/DataModeling/Collections/DatabaseMethods.mdpp @@ -74,7 +74,7 @@ to the [naming conventions](../NamingConventions/README.md). only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do. -* *isVolatile* (optional, default is *false*): If *true then the +* *isVolatile* (optional, default is *false*): If *true* then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the diff --git a/Documentation/Books/Users/Collections/README.mdpp b/Documentation/Books/Users/DataModeling/Collections/README.mdpp similarity index 100% rename from Documentation/Books/Users/Collections/README.mdpp rename to Documentation/Books/Users/DataModeling/Collections/README.mdpp diff --git a/Documentation/Books/Users/DataModeling/Concepts.mdpp b/Documentation/Books/Users/DataModeling/Concepts.mdpp new file mode 100644 index 0000000000..e69de29bb2 diff --git a/Documentation/Books/Users/Databases/Notes.mdpp b/Documentation/Books/Users/DataModeling/Databases/Notes.mdpp similarity index 100% rename from Documentation/Books/Users/Databases/Notes.mdpp rename to Documentation/Books/Users/DataModeling/Databases/Notes.mdpp diff --git a/Documentation/Books/Users/Databases/README.mdpp b/Documentation/Books/Users/DataModeling/Databases/README.mdpp similarity index 100% rename from Documentation/Books/Users/Databases/README.mdpp rename to Documentation/Books/Users/DataModeling/Databases/README.mdpp diff --git a/Documentation/Books/Users/Databases/WorkingWith.mdpp b/Documentation/Books/Users/DataModeling/Databases/WorkingWith.mdpp similarity index 100% rename from Documentation/Books/Users/Databases/WorkingWith.mdpp rename to Documentation/Books/Users/DataModeling/Databases/WorkingWith.mdpp diff --git a/Documentation/Books/Users/DataModeling/Documents/DatabaseMethods.mdpp b/Documentation/Books/Users/DataModeling/Documents/DatabaseMethods.mdpp new file mode 100644 index 0000000000..61f0790c58 --- /dev/null +++ b/Documentation/Books/Users/DataModeling/Documents/DatabaseMethods.mdpp @@ -0,0 +1,334 @@ +!CHAPTER Database Methods + +!SUBSECTION Document + + + +`db._document(object)` + +The *_document* method finds a document given an object *object* +containing the *_id* attribute. The method returns +the document if it can be found. + +An error is thrown if *_rev* is specified but the document found has a +different revision already. An error is also thrown if no document exists +with the given *_id*. + +Please note that if the method is executed on the arangod server (e.g. from +inside a Foxx application), an immutable document object will be returned +for performance reasons. It is not possible to change attributes of this +immutable object. To update or patch the returned document, it needs to be +cloned/copied into a regular JavaScript object first. This is not necessary +if the *_document* method is called from out of arangosh or from any other +client. + +`db._document(document-handle)` + +As before. Instead of *object* a *document-handle* can be passed as +first argument. No revision can be specified in this case. + + +**Examples** + + +Returns the document: + + @startDocuBlockInline documentsDocumentName + @EXAMPLE_ARANGOSH_OUTPUT{documentsDocumentName} + ~ db._create("example"); + ~ var myid = db.example.insert({_key: "12345"}); + db._document("example/12345"); + ~ db._drop("example"); + @END_EXAMPLE_ARANGOSH_OUTPUT + @endDocuBlock documentsDocumentName + + + +!SUBSECTION Exists + + + +`db._exists(object)` + +The *_exists* method determines whether a document exists given an object +`object` containing the *_id* attribute. + +An error is thrown if *_rev* is specified but the document found has a +different revision already. + +Instead of returning the found document or an error, this method will +only return an object with the attributes *_id*, *_key* and *_rev*, or +*false* if no document with the given *_id* or *_key* exists. It can +thus be used for easy existence checks. + +This method will throw an error if used improperly, e.g. when called +with a non-document handle, a non-document, or when a cross-collection +request is performed. + +`db._exists(document-handle)` + +As before. Instead of *object* a *document-handle* can be passed as +first argument. + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +In the case of a revision mismatch *_exists* now throws an error instead +of simply returning *false*. This is to make it possible to tell the +difference between a revision mismatch and a non-existing document. + + +!SUBSECTION Replace + + + +`db._replace(selector, data)` + +Replaces an existing document described by the *selector*, which must +be an object containing the *_id* attribute. There must be +a document with that *_id* in the current database. This +document is then replaced with the *data* given as second argument. +Any attribute *_id*, *_key* or *_rev* in *data* is ignored. + +The method returns a document with the attributes *_id*, *_key*, *_rev* +and *_oldRev*. The attribute *_id* contains the document handle of the +updated document, the attribute *_rev* contains the document revision of +the updated document, the attribute *_oldRev* contains the revision of +the old (now replaced) document. + +If the selector contains a *_rev* attribute, the method first checks +that the specified revision is the current revision of that document. +If not, there is a conflict, and an error is thrown. + +`collection.replace(selector, data, options)` + +As before, but *options* must be an object that can contain the following +boolean attributes: + + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *overwrite*: If this flag is set to *true*, a *_rev* attribute in + the selector is ignored. + - *returnNew*: If this flag is set to *true*, the complete new document + is returned in the output under the attribute *new*. + - *returnOld*: If this flag is set to *true*, the complete previous + revision of the document is returned in the output under the + attribute *old*. + - *silent*: If this flag is set to *true*, no output is returned. + +`db._replace(document-handle, data)` + +`db._replace(document-handle, data, options)` + +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision precondition is tested. + + +**Examples** + + +Create and replace a document: + + @startDocuBlockInline documentsDocumentReplace + @EXAMPLE_ARANGOSH_OUTPUT{documentsDocumentReplace} + ~ db._create("example"); + a1 = db.example.insert({ a : 1 }); + a2 = db._replace(a1, { a : 2 }); + a3 = db._replace(a1, { a : 3 }); // xpError(ERROR_ARANGO_CONFLICT); + ~ db._drop("example"); + @END_EXAMPLE_ARANGOSH_OUTPUT + @endDocuBlock documentsDocumentReplace + + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The options *silent*, *returnNew* and *returnOld* are new. + + +!SUBSECTION Update + + +`db._update(selector, data)` + +Updates an existing document described by the *selector*, which must +be an object containing the *_id* attribute. There must be +a document with that *_id* in the current database. This +document is then patched with the *data* given as second argument. +Any attribute *_id*, *_key* or *_rev* in *data* is ignored. + +The method returns a document with the attributes *_id*, *_key*, *_rev* +and *_oldRev*. The attribute *_id* contains the document handle of the +updated document, the attribute *_rev* contains the document revision of +the updated document, the attribute *_oldRev* contains the revision of +the old (now updated) document. + +If the selector contains a *_rev* attribute, the method first checks +that the specified revision is the current revision of that document. +If not, there is a conflict, and an error is thrown. + +`db._update(selector, data, options)` + +As before, but *options* must be an object that can contain the following +boolean attributes: + + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *overwrite*: If this flag is set to *true*, a *_rev* attribute in + the selector is ignored. + - *returnNew*: If this flag is set to *true*, the complete new document + is returned in the output under the attribute *new*. + - *returnOld*: If this flag is set to *true*, the complete previous + revision of the document is returned in the output under the + attribute *old*. + - *silent*: If this flag is set to *true*, no output is returned. + - *keepNull*: The optional *keepNull* parameter can be used to modify + the behavior when handling *null* values. Normally, *null* values + are stored in the database. By setting the *keepNull* parameter to + *false*, this behavior can be changed so that all attributes in + *data* with *null* values will be removed from the target document. + - *mergeObjects*: Controls whether objects (not arrays) will be + merged if present in both the existing and the patch document. If + set to *false*, the value in the patch document will overwrite the + existing document's value. If set to *true*, objects will be merged. + The default is *true*. + + +`db._update(document-handle, data)` + +`db._update(document-handle, data, options)` + +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision precondition is tested. + + +**Examples** + + +Create and update a document: + + @startDocuBlockInline documentDocumentUpdate + @EXAMPLE_ARANGOSH_OUTPUT{documentDocumentUpdate} + ~ db._create("example"); + a1 = db.example.insert({ a : 1 }); + a2 = db._update(a1, { b : 2 }); + a3 = db._update(a1, { c : 3 }); // xpError(ERROR_ARANGO_CONFLICT); + ~ db._drop("example"); + @END_EXAMPLE_ARANGOSH_OUTPUT + @endDocuBlock documentDocumentUpdate + + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The options *silent*, *returnNew* and *returnOld* are new. + + +!SUBSECTION Remove + + + +`db._remove(selector)` + +Removes a document described by the *selector*, which must be an object +containing the *_id* attribute. There must be a document with +that *_id* in the current database. This document is then +removed. + +The method returns a document with the attributes *_id*, *_key* and *_rev*. +The attribute *_id* contains the document handle of the +removed document, the attribute *_rev* contains the document revision of +the removed eocument. + +If the selector contains a *_rev* attribute, the method first checks +that the specified revision is the current revision of that document. +If not, there is a conflict, and an error is thrown. + +`db._remove(selector, options)` + +As before, but *options* must be an object that can contain the following +boolean attributes: + + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *overwrite*: If this flag is set to *true*, a *_rev* attribute in + the selector is ignored. + - *returnOld*: If this flag is set to *true*, the complete previous + revision of the document is returned in the output under the + attribute *old*. + - *silent*: If this flag is set to *true*, no output is returned. + +`db._remove(document-handle)` + +`db._remove(document-handle, options)` + +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision check is performed. + +**Examples** + + +Remove a document: + + @startDocuBlockInline documentsCollectionRemoveSuccess + @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionRemoveSuccess} + ~ db._create("example"); + a1 = db.example.insert({ a : 1 }); + db._remove(a1); + db._remove(a1); // xpError(ERROR_ARANGO_DOCUMENT_NOT_FOUND); + db._remove(a1, true); + ~ db._drop("example"); + @END_EXAMPLE_ARANGOSH_OUTPUT + @endDocuBlock documentsCollectionRemoveSuccess + +Remove a document with a conflict: + + @startDocuBlockInline documentsCollectionRemoveConflict + @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionRemoveConflict} + ~ db._create("example"); + a1 = db.example.insert({ a : 1 }); + a2 = db._replace(a1, { a : 2 }); + db._remove(a1); // xpError(ERROR_ARANGO_CONFLICT) + db._remove(a1, true); + db._document(a1); // xpError(ERROR_ARANGO_DOCUMENT_NOT_FOUND) + ~ db._drop("example"); + @END_EXAMPLE_ARANGOSH_OUTPUT + @endDocuBlock documentsCollectionRemoveConflict + +Remove a document using new signature: + + @startDocuBlockInline documentsCollectionRemoveSignature + @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionRemoveSignature} + ~ db._create("example"); + db.example.insert({ a: 1 } ); + | db.example.remove("example/11265325374", + { overwrite: true, waitForSync: false}) + ~ db._drop("example"); + @END_EXAMPLE_ARANGOSH_OUTPUT + @endDocuBlock documentsCollectionRemoveSignature + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The method now returns not only *true* but information about the removed +document(s). The options *silent* and *returnOld* are new. diff --git a/Documentation/Books/Users/DataModeling/Documents/DocumentAddress.mdpp b/Documentation/Books/Users/DataModeling/Documents/DocumentAddress.mdpp new file mode 100644 index 0000000000..0541c0ca10 --- /dev/null +++ b/Documentation/Books/Users/DataModeling/Documents/DocumentAddress.mdpp @@ -0,0 +1,116 @@ +!CHAPTER Basics and Terminology + +Documents in ArangoDB are JSON objects. These objects can be nested (to +any depth) and may contain lists. Each document has a unique +[primary key](../../Appendix/Glossary.md#document-key) which +identifies it within its collection. Furthermore, each document is +uniquely identified +by its [document handle](../../Appendix/Glossary.md#document-handle) +across all collections in the same database. Different revisions of +the same document (identified by its handle) can be distinguished by their +[document revision](../../Appendix/Glossary.md#document-revision). +Any transaction only ever sees a single revision of a document. +For example: + +```js +{ + "firstName" : "Hugo", + "lastName" : "Schlonz", + "address" : { + "city" : "Hier", + "street" : "Strasse 1" + }, + "hobbies" : [ + "swimming", + "biking", + "programming" + ], + "_id" : "demo/schlonz", + "_rev" : "13728680", + "_key" : "schlonz" +} +``` + +All documents contain special attributes: the +[document handle](../../Users/Appendix/Glossary.html#document-handle) is stored +as a string in `_id`, the +[document's primary key](../../Users/Appendix/Glossary.html#document-key) in +`_key` and the +[document revision](../../Users/Appendix/Glossary.html#document-revision) in +`_rev`. The value of the `_key` attribute can be specified by the user when +creating a document. `_id` and `_key` values are immutable once the document +has been created. The `_rev` value is maintained by ArangoDB automatically. + + +!SUBSECTION Document Handle + +A document handle uniquely identifies a document in the database. It +is a string and consists of the collection's name and the document key +(`_key` attribute) separated by `/`. + + +!SUBSECTION Document Key + +A document key uniquely identifies a document in the collection it is +stored in. It can and should be used by clients when specific documents +are queried. The document key is stored in the `_key` attribute of +each document. The key values are automatically indexed by ArangoDB in +a collection's primary index. Thus looking up a document by its +key is a fast operation. The _key value of a document is +immutable once the document has been created. By default, ArangoDB will +auto-generate a document key if no _key attribute is specified, and use +the user-specified _key otherwise. + +This behavior can be changed on a per-collection level by creating +collections with the `keyOptions` attribute. + +Using `keyOptions` it is possible to disallow user-specified keys +completely, or to force a specific regime for auto-generating the `_key` +values. + + +!SUBSECTION Document Revision + +As ArangoDB supports MVCC (Multiple Version Concurrency Control), +documents can exist in more than one +revision. The document revision is the MVCC token used to specify +a particular revision of a document (identified by its `_id`). +It is a string value currently +containing an integer number and is unique within the list of document +revisions for a single document. Document revisions can be used to +conditionally query, update, replace or delete documents in the database. In +order to find a particular revision of a document, you need the document +handle or key, and the document revision. + +ArangoDB uses 64bit unsigned integer values to maintain +document revisions internally. When returning document revisions to +clients, ArangoDB will put them into a string to ensure the revision +is not clipped by clients that do not support big integers. Clients +should treat the revision returned by ArangoDB as an opaque string +when they store or use it locally. This will allow ArangoDB to change +the format of revisions later if this should be required. Clients can +use revisions to perform simple equality/non-equality comparisons +(e.g. to check whether a document has changed or not), but they should +not use revision ids to perform greater/less than comparisons with them +to check if a document revision is older than one another, even if this +might work for some cases. + + +!SUBSECTION Multiple Documents in a single Command + +Beginning with ArangoDB 3.0 the basic document API has been extended +to handle not only single documents but multiple documents in a single +command. This is crucial for performance, in particular in the cluster +situation, in which a single request can involve multiple network hops +within the cluster. Another advantage is that it reduces the overhead of +individual network round trips between the client +and the server. The general idea to perform multiple document operations +in a single command is to use JSON arrays of objects in the place of a +single document. As a consequence, document keys, handles and revisions +for preconditions have to be supplied embedded in the individual documents +given. Multiple document operations are restricted to a single document +or edge collection. +See the [API descriptions for collection objects](DocumentMethods.md) +for details. Note that the [API for database objects](DatabaseMethods.md) +do not offer these operations. + diff --git a/Documentation/Books/Users/Documents/DocumentMethods.mdpp b/Documentation/Books/Users/DataModeling/Documents/DocumentMethods.mdpp similarity index 61% rename from Documentation/Books/Users/Documents/DocumentMethods.mdpp rename to Documentation/Books/Users/DataModeling/Documents/DocumentMethods.mdpp index 6b1c04d161..21266373ba 100644 --- a/Documentation/Books/Users/Documents/DocumentMethods.mdpp +++ b/Documentation/Books/Users/DataModeling/Documents/DocumentMethods.mdpp @@ -4,7 +4,6 @@ -constructs an all query for a collection `collection.all()` Fetches all documents from a collection and returns a cursor. You can use @@ -51,7 +50,6 @@ Use *limit* to restrict the documents: -constructs a query-by-example for a collection `collection.byExample(example)` Fetches all documents from a collection that match the specified @@ -147,10 +145,9 @@ Use *next* to loop over all documents: -constructs a query-by-example for a collection `collection.firstExample(example)` -Returns the first document of a collection that matches the specified +Returns some document of a collection that matches the specified example. If no such document exists, *null* will be returned. The example has to be specified as paths and values. See *byExample* for details. @@ -180,7 +177,6 @@ As alternative you can supply an array of paths and values. -constructs a range query for a collection `collection.range(attribute, left, right)` Returns all documents from a collection such that the *attribute* is @@ -231,7 +227,6 @@ Use *toArray* to get all documents at once: -constructs a closed range query for a collection `collection.closedRange(attribute, left, right)` Returns all documents of a collection such that the *attribute* is @@ -277,7 +272,6 @@ Use *toArray* to get all documents at once: -returns any document from a collection `collection.any()` Returns a random document from the collection or *null* if none exists. @@ -287,7 +281,6 @@ Returns a random document from the collection or *null* if none exists. -counts the number of documents in a result set `collection.count()` Returns the number of living documents in the collection. @@ -310,7 +303,6 @@ Returns the number of living documents in the collection. -converts collection into an array `collection.toArray()` Converts the collection into an array of documents. Never use this call @@ -321,12 +313,13 @@ in a production environment. -looks up a document -`collection.document(document)` +`collection.document(object)` -The *document* method finds a document given its identifier or a document -object containing the *_id* or *_key* attribute. The method returns -the document if it can be found. +The *document* method finds a document given an object *object* +containing the *_id* or *_key* attribute. The method returns +the document if it can be found. If both attributes are given, +the *_id* takes precedence, it is an error, if the collection part +of the *_id* does not match the *collection*. An error is thrown if *_rev* is specified but the document found has a different revision already. An error is also thrown if no document exists @@ -342,9 +335,22 @@ client. `collection.document(document-handle)` -As before. Instead of document a *document-handle* can be passed as +As before. Instead of *object* a *document-handle* can be passed as +first argument. No revision can be specified in this case. + +`collection.document(document-key)` + +As before. Instead of *object* a *document-key* can be passed as first argument. +`collection.document(array)` + +This variant allows to perform the operation on a whole array of arguments. +The behaviour is exactly as if *document* would have been called on all +members of the array and all results are returned in an array. If an error +occurs with any of the documents, the operation stops immediately returning +only an error object. + *Examples* Returns the document for a document-handle: @@ -358,6 +364,40 @@ Returns the document for a document-handle: @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock documentsCollectionNameValid +Returns the document for a document-key: + + @ startDocuBlockInline documentsCollectionNameValidByKey + @ EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionNameValidByKey} + ~ db._create("example"); + ~ var myid = db.example.insert({_key: "2873916"}); + db.example.document("2873916"); + ~ db._drop("example"); + @ END_EXAMPLE_ARANGOSH_OUTPUT + @ endDocuBlock documentsCollectionNameValidByKey + +Returns the document for an object: + + @ startDocuBlockInline documentsCollectionNameValidByObject + @ EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionNameValidByObject} + ~ db._create("example"); + ~ var myid = db.example.insert({_key: "2873916"}); + db.example.document({_id: "example/2873916"}); + ~ db._drop("example"); + @ END_EXAMPLE_ARANGOSH_OUTPUT + @ endDocuBlock documentsCollectionNameValidByObject + +Returns the document for an array of two keys: + + @ startDocuBlockInline documentsCollectionNameValidMulti + @ EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionNameValidMulti} + ~ db._create("example"); + ~ var myid = db.example.insert({_key: "2873916"}); + ~ var myid = db.example.insert({_key: "2873917"}); + db.example.document(["2873916","2873917"]); + ~ db._drop("example"); + @ END_EXAMPLE_ARANGOSH_OUTPUT + @ endDocuBlock documentsCollectionNameValidMulti + An error is raised if the document is unknown: @startDocuBlockInline documentsCollectionNameUnknown @@ -379,6 +419,9 @@ An error is raised if the handle is invalid: @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock documentsCollectionNameHandle +!SUBSUBSECTION Changes in 3.0 from 2.8: + +*document* can now query multiple documents with one call. !SUBSECTION Exists @@ -386,44 +429,65 @@ An error is raised if the handle is invalid: checks whether a document exists -`collection.exists(document)` +`collection.exists(object)` -The *exists* method determines whether a document exists given its -identifier. Instead of returning the found document or an error, this -method will return either *true* or *false*. It can thus be used -for easy existence checks. +The *exists* method determines whether a document exists given an object +`object` containing the *_id* or *_key* attribute. If both attributes +are given, the *_id* takes precedence, it is an error, if the collection +part of the *_id* does not match the *collection*. -The *document* method finds a document given its identifier. It returns -the document. Note that the returned document contains two -pseudo-attributes, namely *_id* and *_rev*. *_id* contains the -document-handle and *_rev* the revision of the document. +An error is thrown if *_rev* is specified but the document found has a +different revision already. -No error will be thrown if the sought document or collection does not -exist. -Still this method will throw an error if used improperly, e.g. when called +Instead of returning the found document or an error, this method will +only return an object with the attributes *_id*, *_key* and *_rev*, or +*false* if no document with the given *_id* or *_key* exists. It can +thus be used for easy existence checks. + +This method will throw an error if used improperly, e.g. when called with a non-document handle, a non-document, or when a cross-collection request is performed. `collection.exists(document-handle)` -As before. Instead of document a *document-handle* can be passed as +As before. Instead of *object* a *document-handle* can be passed as first argument. +`collection.exists(document-key)` + +As before. Instead of *object* a *document-key* can be passed as +first argument. + +`collection.exists(array)` + +This variant allows to perform the operation on a whole array of arguments. +The behaviour is exactly as if *exists* would have been called on all +members of the array and all results are returned in an array. If an error +occurs with any of the documents, the operation stops immediately returning +only an error object. + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +In the case of a revision mismatch *exists* now throws an error instead +of simply returning *false*. This is to make it possible to tell the +difference between a revision mismatch and a non-existing document. + +*exists* can now query multiple documents with one call. !SUBSECTION Lookup By Keys -fetches multiple documents by their keys `collection.documents(keys)` -Looks up the documents in the specified collection using the array of keys -provided. All documents for which a matching key was specified in the *keys* -array and that exist in the collection will be returned. -Keys for which no document can be found in the underlying collection are ignored, -and no exception will be thrown for them. +Looks up the documents in the specified collection using the array of +keys provided. All documents for which a matching key was specified in +the *keys* array and that exist in the collection will be returned. Keys +for which no document can be found in the underlying collection are +ignored, and no exception will be thrown for them. +This method is deprecated in favour of the array variant of *document*. **Examples** @@ -447,32 +511,58 @@ and no exception will be thrown for them. -insert a new document `collection.insert(data)` Creates a new document in the *collection* from the given *data*. The -*data* must be an object. +*data* must be an object. The attributes *_id* and *_rev* are ignored +and are automatically generated. A unique value for the attribute *_key* +will be automatically generated if not specified. If specified, there +must not be a document with the given *_key* in the collection. -The method returns a document with the attributes *_id* and *_rev*. -The attribute *_id* contains the document handle of the newly created -document, the attribute *_rev* contains the document revision. +The method returns a document with the attributes *_id*, *_key* and +*_rev*. The attribute *_id* contains the document handle of the newly +created document, the attribute *_key* the document key and the +attribute *_rev* contains the document revision. -`collection.insert(data, waitForSync)` +`collection.insert(data, options)` Creates a new document in the *collection* from the given *data* as -above. The optional *waitForSync* parameter can be used to force -synchronization of the document creation operation to disk even in case -that the *waitForSync* flag had been disabled for the entire collection. -Thus, the *waitForSync* parameter can be used to force synchronization -of just specific operations. To use this, set the *waitForSync* parameter -to *true*. If the *waitForSync* parameter is not specified or set to -*false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. +above. The optional *options* parameter must be an object and can be +used to specify the following options: + + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *silent*: If this flag is set to *true*, the method does not return + any output. + - *returnNew*: If this flag is set to *true*, the complete new document + is returned in the output under the attribute *new*. Note: since ArangoDB 2.2, *insert* is an alias for *save*. +`collection.insert(array)` + +`collection.insert(array, options)` + +These two variants allow to perform the operation on a whole array of +arguments. The behaviour is exactly as if *insert* would have been +called on all members of the array and all results are returned in an +array. If an error occurs with any of the documents, the operation stops +immediately returning only an error object. The options behave exactly +as before. + +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The options *silent* and *returnNew* are new. The method can now insert +multiple documents with one call. + **Examples** @@ -481,57 +571,93 @@ Note: since ArangoDB 2.2, *insert* is an alias for *save*. @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionInsert} ~ db._create("example"); db.example.insert({ Hello : "World" }); - db.example.insert({ Hello : "World" }, true); + db.example.insert({ Hello : "World" }, {waitForSync: true}); ~ db._drop("example"); @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock documentsCollectionInsert + @ startDocuBlockInline documentsCollectionInsertMulti + @ EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionInsertMulti} + ~ db._create("example"); + db.example.insert([{ Hello : "World" }, {Hello: "there"']); + db.example.insert([{ Hello : "World" }, {}], {waitForSync: true}); + ~ db._drop("example"); + @ END_EXAMPLE_ARANGOSH_OUTPUT + @ endDocuBlock documentsCollectionInsertMulti + !SUBSECTION Replace -replaces a document -`collection.replace(document, data)` +`collection.replace(selector, data)` -Replaces an existing *document*. The *document* must be a document in -the current collection. This document is then replaced with the -*data* given as second argument. +Replaces an existing document described by the *selector*, which must +be an object containing the *_id* or *_key* attribute. There must be +a document with that *_id* or *_key* in the current collection. This +document is then replaced with the *data* given as second argument. +Any attribute *_id*, *_key* or *_rev* in *data* is ignored. -The method returns a document with the attributes *_id*, *_rev* and -*{_oldRev*. The attribute *_id* contains the document handle of the +The method returns a document with the attributes *_id*, *_key*, *_rev* +and *_oldRev*. The attribute *_id* contains the document handle of the updated document, the attribute *_rev* contains the document revision of the updated document, the attribute *_oldRev* contains the revision of the old (now replaced) document. -If there is a conflict, i. e. if the revision of the *document* does not -match the revision in the collection, then an error is thrown. +If the selector contains a *_rev* attribute, the method first checks +that the specified revision is the current revision of that document. +If not, there is a conflict, and an error is thrown. -`collection.replace(document, data, true)` or -`collection.replace(document, data, overwrite: true)` +`collection.replace(selector, data, options)` -As before, but in case of a conflict, the conflict is ignored and the old -document is overwritten. +As before, but *options* must be an object that can contain the following +boolean attributes: -`collection.replace(document, data, true, waitForSync)` or -`collection.replace(document, data, overwrite: true, waitForSync: true or false)` - -The optional *waitForSync* parameter can be used to force -synchronization of the document replacement operation to disk even in case -that the *waitForSync* flag had been disabled for the entire collection. -Thus, the *waitForSync* parameter can be used to force synchronization -of just specific operations. To use this, set the *waitForSync* parameter -to *true*. If the *waitForSync* parameter is not specified or set to -*false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *overwrite*: If this flag is set to *true*, a *_rev* attribute in + the selector is ignored. + - *returnNew*: If this flag is set to *true*, the complete new document + is returned in the output under the attribute *new*. + - *returnOld*: If this flag is set to *true*, the complete previous + revision of the document is returned in the output under the + attribute *old*. + - *silent*: If this flag is set to *true*, no output is returned. `collection.replace(document-handle, data)` -As before. Instead of document a *document-handle* can be passed as -first argument. +`collection.replace(document-handle, data, options)` + +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision precondition is tested. + +`collection.replace(document-key, data)` + +`collection.replace(document-key, data, options)` + +As before. Instead of *selector* a *document-key* can be passed as +first argument. No revision precondition is tested. + +`collection.replace(selectorarray, dataarray)` + +`collection.replace(selectorarray, dataarray, options)` + +These two variants allow to perform the operation on a whole array +of selector/data pairs. The two arrays given as *selectorarray* and +*dataarray* must have the same length. The behaviour is exactly as if +*replace* would have been called on all respective members of the two +arrays and all results are returned in an array. If an error occurs with +any of the documents, the operation stops immediately returning only an +error object. The options behave exactly as before. **Examples** @@ -561,56 +687,93 @@ Use a document handle: @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock documentsCollectionReplaceHandle +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The options *silent*, *returnNew* and *returnOld* are new. The method +can now replace multiple documents with one call. !SUBSECTION Update +`collection.update(selector, data)` -updates a document -`collection.update(document, data, overwrite, keepNull, waitForSync)` or -`collection.update(document, data, -overwrite: true or false, keepNull: true or false, waitForSync: true or false)` +Updates an existing document described by the *selector*, which must +be an object containing the *_id* or *_key* attribute. There must be +a document with that *_id* or *_key* in the current collection. This +document is then patched with the *data* given as second argument. +Any attribute *_id*, *_key* or *_rev* in *data* is ignored. -Updates an existing *document*. The *document* must be a document in -the current collection. This document is then patched with the -*data* given as second argument. The optional *overwrite* parameter can -be used to control the behavior in case of version conflicts (see below). -The optional *keepNull* parameter can be used to modify the behavior when -handling *null* values. Normally, *null* values are stored in the -database. By setting the *keepNull* parameter to *false*, this behavior -can be changed so that all attributes in *data* with *null* values will -be removed from the target document. - -The optional *waitForSync* parameter can be used to force -synchronization of the document update operation to disk even in case -that the *waitForSync* flag had been disabled for the entire collection. -Thus, the *waitForSync* parameter can be used to force synchronization -of just specific operations. To use this, set the *waitForSync* parameter -to *true*. If the *waitForSync* parameter is not specified or set to -*false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. - -The method returns a document with the attributes *_id*, *_rev* and -*_oldRev*. The attribute *_id* contains the document handle of the +The method returns a document with the attributes *_id*, *_key*, *_rev* +and *_oldRev*. The attribute *_id* contains the document handle of the updated document, the attribute *_rev* contains the document revision of the updated document, the attribute *_oldRev* contains the revision of -the old (now replaced) document. +the old (now updated) document. -If there is a conflict, i. e. if the revision of the *document* does not -match the revision in the collection, then an error is thrown. +If the selector contains a *_rev* attribute, the method first checks +that the specified revision is the current revision of that document. +If not, there is a conflict, and an error is thrown. -`collection.update(document, data, true)` +`collection.update(selector, data, options)` -As before, but in case of a conflict, the conflict is ignored and the old -document is overwritten. +As before, but *options* must be an object that can contain the following +boolean attributes: -collection.update(document-handle, data)` + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *overwrite*: If this flag is set to *true*, a *_rev* attribute in + the selector is ignored. + - *returnNew*: If this flag is set to *true*, the complete new document + is returned in the output under the attribute *new*. + - *returnOld*: If this flag is set to *true*, the complete previous + revision of the document is returned in the output under the + attribute *old*. + - *silent*: If this flag is set to *true*, no output is returned. + - *keepNull*: The optional *keepNull* parameter can be used to modify + the behavior when handling *null* values. Normally, *null* values + are stored in the database. By setting the *keepNull* parameter to + *false*, this behavior can be changed so that all attributes in + *data* with *null* values will be removed from the target document. + - *mergeObjects*: Controls whether objects (not arrays) will be + merged if present in both the existing and the patch document. If + set to *false*, the value in the patch document will overwrite the + existing document's value. If set to *true*, objects will be merged. + The default is *true*. -As before. Instead of document a document-handle can be passed as -first argument. + +`collection.update(document-handle, data)` + +`collection.update(document-handle, data, options)` + +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision precondition is tested. + +`collection.update(document-key, data)` + +`collection.update(document-key, data, options)` + +As before. Instead of *selector* a *document-key* can be passed as +first argument. No revision precondition is tested. + +`collection.update(selectorarray, dataarray)` + +`collection.update(selectorarray, dataarray, options)` + +These two variants allow to perform the operation on a whole array +of selector/data pairs. The two arrays given as *selectorarray* and +*dataarray* must have the same length. The behaviour is exactly as if +*update* would have been called on all respective members of the two +arrays and all results are returned in an array. If an error occurs with +any of the documents, the operation stops immediately returning only an +error object. The options behave exactly as before. *Examples* @@ -681,41 +844,77 @@ Patching array values: @endDocuBlock documentsCollection_UpdateHandleArray +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The options *silent*, *returnNew* and *returnOld* are new. The method +can now update multiple documents with one call. + !SUBSECTION Remove +`collection.remove(selector)` -removes a document -`collection.remove(document)` +Removes a document described by the *selector*, which must be an object +containing the *_id* or *_key* attribute. There must be a document with +that *_id* or *_key* in the current collection. This document is then +removed. -Removes a document. If there is revision mismatch, then an error is thrown. +The method returns a document with the attributes *_id*, *_key* and *_rev*. +The attribute *_id* contains the document handle of the +removed document, the attribute *_rev* contains the document revision of +the removed document. -`collection.remove(document, true)` +If the selector contains a *_rev* attribute, the method first checks +that the specified revision is the current revision of that document. +If not, there is a conflict, and an error is thrown. -Removes a document. If there is revision mismatch, then mismatch is ignored -and document is deleted. The function returns *true* if the document -existed and was deleted. It returns *false*, if the document was already -deleted. +`collection.remove(selector, options)` -`collection.remove(document, true, waitForSync)` +As before, but *options* must be an object that can contain the following +boolean attributes: -The optional *waitForSync* parameter can be used to force synchronization -of the document deletion operation to disk even in case that the -*waitForSync* flag had been disabled for the entire collection. Thus, -the *waitForSync* parameter can be used to force synchronization of just -specific operations. To use this, set the *waitForSync* parameter to -*true*. If the *waitForSync* parameter is not specified or set to -*false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. + - *waitForSync*: One can force + synchronization of the document creation operation to disk even in + case that the *waitForSync* flag is been disabled for the entire + collection. Thus, the *waitForSync* option can be used to force + synchronization of just specific operations. To use this, set the + *waitForSync* parameter to *true*. If the *waitForSync* parameter + is not specified or set to *false*, then the collection's default + *waitForSync* behavior is applied. The *waitForSync* parameter + cannot be used to disable synchronization for collections that have + a default *waitForSync* value of *true*. + - *overwrite*: If this flag is set to *true*, a *_rev* attribute in + the selector is ignored. + - *returnOld*: If this flag is set to *true*, the complete previous + revision of the document is returned in the output under the + attribute *old*. + - *silent*: If this flag is set to *true*, no output is returned. -`collection.remove(document-handle, data)` +`collection.remove(document-handle)` -As before. Instead of document a *document-handle* can be passed as -first argument. +`collection.remove(document-handle, options)` +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision check is performed. + +`collection.remove(document-key)` + +`collection.remove(document-handle, options)` + +As before. Instead of *selector* a *document-handle* can be passed as +first argument. No revision check is performed. + +`collection.remove(selectorarray)` + +`collection.remove(selectorarray,options)` + +These two variants allow to perform the operation on a whole array of +selectors. The behaviour is exactly as if *remove* would have been +called on all members of the array and all results are returned in an +array. If an error occurs with any of the documents, the operation stops +immediately returning only an error object. The options behave exactly +as before. **Examples** @@ -747,15 +946,21 @@ Remove a document with a conflict: @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock documentDocumentRemoveConflict +!SUBSUBSECTION Changes in 3.0 from 2.8: + +The method now returns not only *true* but information about the removed +document(s). The options *silent* and *returnOld* are new. The method +can now remove multiple documents with one call. + !SUBSECTION Remove By Keys -removes multiple documents by their keys `collection.removeByKeys(keys)` + Looks up the documents in the specified collection using the array of keys provided, and removes all documents from the collection whose keys are contained in the *keys* array. Keys for which no document can be found in @@ -766,6 +971,7 @@ The method will return an object containing the number of removed documents in the *removed* sub-attribute, and the number of not-removed/ignored documents in the *ignored* sub-attribute. +This method is deprecated in favour of the array variant of *remove*. **Examples** @@ -789,7 +995,6 @@ documents in the *ignored* sub-attribute. -removes documents matching an example `collection.removeByExample(example)` Removes all documents matching an example. @@ -832,7 +1037,6 @@ removed. -replaces documents matching an example `collection.replaceByExample(example, newValue)` Replaces all documents matching an example with a new document body. @@ -878,7 +1082,6 @@ replaced. -partially updates documents matching an example `collection.updateByExample(example, newValue)` Partially updates all documents matching an example with a new document body. @@ -919,10 +1122,11 @@ updated. Using this variant, the options for the operation can be passed using an object with the following sub-attributes: -- *keepNull* -- *waitForSync* -- *limit* -- *mergeObjects* + + - *keepNull* + - *waitForSync* + - *limit* + - *mergeObjects* **Examples** @@ -939,107 +1143,9 @@ an object with the following sub-attributes: @endDocuBlock 012_documentsCollectionUpdateByExample -!SUBSECTION First - - - -selects the n first documents in the collection -`collection.first(count)` - -The *first* method returns the n first documents from the collection, in -order of document insertion/update time. - -If called with the *count* argument, the result is a list of up to -*count* documents. If *count* is bigger than the number of documents -in the collection, then the result will contain as many documents as there -are in the collection. -The result list is ordered, with the "oldest" documents being positioned at -the beginning of the result list. - -When called without an argument, the result is the first document from the -collection. If the collection does not contain any documents, the result -returned is *null*. - -**Note**: this method is not supported in sharded collections with more than -one shard. - - -**Examples** - - - @startDocuBlockInline documentsCollectionFirstSuccess - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionFirstSuccess} - ~ db._create("example"); - ~ db.example.save({ Hello : "world" }); - ~ db.example.save({ Foo : "bar" }); - db.example.first(1); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionFirstSuccess - - @startDocuBlockInline documentsCollectionFirstNull - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionFirstNull} - ~ db._create("example"); - ~ db.example.save({ Hello : "world" }); - db.example.first(); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionFirstNull - - -!SUBSECTION Last - - - -selects the n last documents in the collection -`collection.last(count)` - -The *last* method returns the n last documents from the collection, in -order of document insertion/update time. - -If called with the *count* argument, the result is a list of up to -*count* documents. If *count* is bigger than the number of documents -in the collection, then the result will contain as many documents as there -are in the collection. -The result list is ordered, with the "latest" documents being positioned at -the beginning of the result list. - -When called without an argument, the result is the last document from the -collection. If the collection does not contain any documents, the result -returned is *null*. - -**Note**: this method is not supported in sharded collections with more than -one shard. - - -**Examples** - - - @startDocuBlockInline documentsCollectionLastFound - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionLastFound} - ~ db._create("example"); - ~ db.example.save({ Hello : "world" }); - ~ db.example.save({ Foo : "bar" }); - db.example.last(2); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionLastFound - - @startDocuBlockInline documentsCollectionLastNull - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionLastNull} - ~ db._create("example"); - ~ db.example.save({ Hello : "world" }); - db.example.last(1); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionLastNull - - - !SUBSECTION Collection type -returns the type of a collection `collection.type()` Returns the type of a collection. Possible values are: @@ -1050,7 +1156,6 @@ Returns the type of a collection. Possible values are: !SUBSECTION Get the Version of ArangoDB -return the server version string `db._version()` Returns the server version string. Note that this is not the version of the @@ -1070,28 +1175,24 @@ database. !SUBSECTION Misc -returns all edges connected to a vertex `collection.edges(vertex-id)` Returns all edges connected to the vertex specified by *vertex-id*. -returns inbound edges connected to a vertex `collection.inEdges(vertex-id)` Returns inbound edges connected to the vertex specified by *vertex-id*. -returns outbound edges connected to a vertex `collection.outEdges(vertex-id)` Returns outbound edges connected to the vertex specified by *vertex-id*. -iterates over some elements of a collection `collection.iterate(iterator, options)` Iterates over some elements of the collection and apply the function @@ -1101,10 +1202,10 @@ as second argument. *options* must be an object with the following attributes: -- *limit* (optional, default none): use at most *limit* documents. + - *limit* (optional, default none): use at most *limit* documents. -- *probability* (optional, default all): a number between *0* and - *1*. Documents are chosen with this probability. + - *probability* (optional, default all): a number between *0* and + *1*. Documents are chosen with this probability. **Examples** diff --git a/Documentation/Books/Users/DataModeling/Documents/README.mdpp b/Documentation/Books/Users/DataModeling/Documents/README.mdpp new file mode 100644 index 0000000000..12eecbd808 --- /dev/null +++ b/Documentation/Books/Users/DataModeling/Documents/README.mdpp @@ -0,0 +1,19 @@ +!CHAPTER Documents + +This is an introduction to ArangoDB's interface for working with +documents from the JavaScript shell *arangosh* or in JavaScript code in +the server. For other languages see the corresponding language API. + +We begin with a + + - [section on the basic approach](DocumentAddress.md) + +before we proceed with + + - [the detailed API description for collection objects](DocumentMethods.md) + +and then + + - [the detailed API description for database objects](DatabaseMethods.md) + + diff --git a/Documentation/Books/Users/DataModeling/GraphsVerticesEdges.mdpp b/Documentation/Books/Users/DataModeling/GraphsVerticesEdges.mdpp new file mode 100644 index 0000000000..4ea1f6b21b --- /dev/null +++ b/Documentation/Books/Users/DataModeling/GraphsVerticesEdges.mdpp @@ -0,0 +1 @@ +!CHAPTER Graphs, Vertices and Edges diff --git a/Documentation/Books/Users/DataModeling/ModelingRelationships.mdpp b/Documentation/Books/Users/DataModeling/ModelingRelationships.mdpp new file mode 100644 index 0000000000..1e7616ee1d --- /dev/null +++ b/Documentation/Books/Users/DataModeling/ModelingRelationships.mdpp @@ -0,0 +1 @@ +!CHAPTER Modeling Relationships diff --git a/Documentation/Books/Users/NamingConventions/AttributeNames.mdpp b/Documentation/Books/Users/DataModeling/NamingConventions/AttributeNames.mdpp similarity index 100% rename from Documentation/Books/Users/NamingConventions/AttributeNames.mdpp rename to Documentation/Books/Users/DataModeling/NamingConventions/AttributeNames.mdpp diff --git a/Documentation/Books/Users/NamingConventions/CollectionNames.mdpp b/Documentation/Books/Users/DataModeling/NamingConventions/CollectionNames.mdpp similarity index 100% rename from Documentation/Books/Users/NamingConventions/CollectionNames.mdpp rename to Documentation/Books/Users/DataModeling/NamingConventions/CollectionNames.mdpp diff --git a/Documentation/Books/Users/NamingConventions/DatabaseNames.mdpp b/Documentation/Books/Users/DataModeling/NamingConventions/DatabaseNames.mdpp similarity index 100% rename from Documentation/Books/Users/NamingConventions/DatabaseNames.mdpp rename to Documentation/Books/Users/DataModeling/NamingConventions/DatabaseNames.mdpp diff --git a/Documentation/Books/Users/NamingConventions/DocumentKeys.mdpp b/Documentation/Books/Users/DataModeling/NamingConventions/DocumentKeys.mdpp similarity index 100% rename from Documentation/Books/Users/NamingConventions/DocumentKeys.mdpp rename to Documentation/Books/Users/DataModeling/NamingConventions/DocumentKeys.mdpp diff --git a/Documentation/Books/Users/NamingConventions/README.mdpp b/Documentation/Books/Users/DataModeling/NamingConventions/README.mdpp similarity index 100% rename from Documentation/Books/Users/NamingConventions/README.mdpp rename to Documentation/Books/Users/DataModeling/NamingConventions/README.mdpp diff --git a/Documentation/Books/Users/DataModeling/README.mdpp b/Documentation/Books/Users/DataModeling/README.mdpp new file mode 100644 index 0000000000..843b4fb5f2 --- /dev/null +++ b/Documentation/Books/Users/DataModeling/README.mdpp @@ -0,0 +1 @@ +!CHAPTER Data model & modeling diff --git a/Documentation/Books/Users/Deployment/README.mdpp b/Documentation/Books/Users/Deployment/README.mdpp new file mode 100644 index 0000000000..2f83a77309 --- /dev/null +++ b/Documentation/Books/Users/Deployment/README.mdpp @@ -0,0 +1 @@ +!CHAPTER Deployment diff --git a/Documentation/Books/Users/Documents/DatabaseMethods.mdpp b/Documentation/Books/Users/Documents/DatabaseMethods.mdpp deleted file mode 100644 index a5a8c7e44e..0000000000 --- a/Documentation/Books/Users/Documents/DatabaseMethods.mdpp +++ /dev/null @@ -1,267 +0,0 @@ -!CHAPTER Database Methods - -!SUBSECTION Document - - - -looks up a document and returns it -`db._document(document)` - -This method finds a document given its identifier. It returns the document -if the document exists. An error is thrown if no document with the given -identifier exists, or if the specified *_rev* value does not match the -current revision of the document. - -**Note**: If the method is executed on the arangod server (e.g. from -inside a Foxx application), an immutable document object will be returned -for performance reasons. It is not possible to change attributes of this -immutable object. To update or patch the returned document, it needs to be -cloned/copied into a regular JavaScript object first. This is not necessary -if the *_document* method is called from out of arangosh or from any -other client. - -`db._document(document-handle)` - -As before. Instead of document a *document-handle* can be passed as -first argument. - - -**Examples** - - -Returns the document: - - @startDocuBlockInline documentsDocumentName - @EXAMPLE_ARANGOSH_OUTPUT{documentsDocumentName} - ~ db._create("example"); - ~ var myid = db.example.insert({_key: "12345"}); - db._document("example/12345"); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsDocumentName - - - -!SUBSECTION Exists - - - -checks whether a document exists -`db._exists(document)` - -This method determines whether a document exists given its identifier. -Instead of returning the found document or an error, this method will -return either *true* or *false*. It can thus be used -for easy existence checks. - -No error will be thrown if the sought document or collection does not -exist. -Still this method will throw an error if used improperly, e.g. when called -with a non-document handle. - -`db._exists(document-handle)` - -As before, but instead of a document a document-handle can be passed. - - -!SUBSECTION Replace - - - -replaces a document -`db._replace(document, data)` - -The method returns a document with the attributes *_id*, *_rev* and -*_oldRev*. The attribute *_id* contains the document handle of the -updated document, the attribute *_rev* contains the document revision of -the updated document, the attribute *_oldRev* contains the revision of -the old (now replaced) document. - -If there is a conflict, i. e. if the revision of the *document* does not -match the revision in the collection, then an error is thrown. - -`db._replace(document, data, true)` - -As before, but in case of a conflict, the conflict is ignored and the old -document is overwritten. - -`db._replace(document, data, true, waitForSync)` - -The optional *waitForSync* parameter can be used to force -synchronization of the document replacement operation to disk even in case -that the *waitForSync* flag had been disabled for the entire collection. -Thus, the *waitForSync* parameter can be used to force synchronization -of just specific operations. To use this, set the *waitForSync* parameter -to *true*. If the *waitForSync* parameter is not specified or set to -*false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. - -`db._replace(document-handle, data)` - -As before. Instead of document a *document-handle* can be passed as -first argument. - - -**Examples** - - -Create and replace a document: - - @startDocuBlockInline documentsDocumentReplace - @EXAMPLE_ARANGOSH_OUTPUT{documentsDocumentReplace} - ~ db._create("example"); - a1 = db.example.insert({ a : 1 }); - a2 = db._replace(a1, { a : 2 }); - a3 = db._replace(a1, { a : 3 }); // xpError(ERROR_ARANGO_CONFLICT); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsDocumentReplace - - - -!SUBSECTION Update - - - -update a document -`db._update(document, data, overwrite, keepNull, waitForSync)` - -Updates an existing *document*. The *document* must be a document in -the current collection. This document is then patched with the -*data* given as second argument. The optional *overwrite* parameter can -be used to control the behavior in case of version conflicts (see below). -The optional *keepNull* parameter can be used to modify the behavior when -handling *null* values. Normally, *null* values are stored in the -database. By setting the *keepNull* parameter to *false*, this behavior -can be changed so that all attributes in *data* with *null* values will -be removed from the target document. - -The optional *waitForSync* parameter can be used to force -synchronization of the document update operation to disk even in case -that the *waitForSync* flag had been disabled for the entire collection. -Thus, the *waitForSync* parameter can be used to force synchronization -of just specific operations. To use this, set the *waitForSync* parameter -to *true*. If the *waitForSync* parameter is not specified or set to -false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. - -The method returns a document with the attributes *_id*, *_rev* and -*_oldRev*. The attribute *_id* contains the document handle of the -updated document, the attribute *_rev* contains the document revision of -the updated document, the attribute *_oldRev* contains the revision of -the old (now replaced) document. - -If there is a conflict, i. e. if the revision of the *document* does not -match the revision in the collection, then an error is thrown. - -`db._update(document, data, true)` - -As before, but in case of a conflict, the conflict is ignored and the old -document is overwritten. - -`db._update(document-handle, data)` - -As before. Instead of document a *document-handle* can be passed as -first argument. - - -**Examples** - - -Create and update a document: - - @startDocuBlockInline documentDocumentUpdate - @EXAMPLE_ARANGOSH_OUTPUT{documentDocumentUpdate} - ~ db._create("example"); - a1 = db.example.insert({ a : 1 }); - a2 = db._update(a1, { b : 2 }); - a3 = db._update(a1, { c : 3 }); // xpError(ERROR_ARANGO_CONFLICT); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentDocumentUpdate - - - -!SUBSECTION Remove - - - -removes a document -`db._remove(document)` - -Removes a document. If there is revision mismatch, then an error is thrown. - -`db._remove(document, true)` - -Removes a document. If there is revision mismatch, then mismatch is ignored -and document is deleted. The function returns *true* if the document -existed and was deleted. It returns *false*, if the document was already -deleted. - -`db._remove(document, true, waitForSync)` or -`db._remove(document, {overwrite: true or false, waitForSync: true or false})` - -The optional *waitForSync* parameter can be used to force synchronization -of the document deletion operation to disk even in case that the -*waitForSync* flag had been disabled for the entire collection. Thus, -the *waitForSync* parameter can be used to force synchronization of just -specific operations. To use this, set the *waitForSync* parameter to -*true*. If the *waitForSync* parameter is not specified or set to -*false*, then the collection's default *waitForSync* behavior is -applied. The *waitForSync* parameter cannot be used to disable -synchronization for collections that have a default *waitForSync* value -of *true*. - -`db._remove(document-handle, data)` - -As before. Instead of document a *document-handle* can be passed as first -argument. - - -**Examples** - - -Remove a document: - - @startDocuBlockInline documentsCollectionRemoveSuccess - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionRemoveSuccess} - ~ db._create("example"); - a1 = db.example.insert({ a : 1 }); - db._remove(a1); - db._remove(a1); // xpError(ERROR_ARANGO_DOCUMENT_NOT_FOUND); - db._remove(a1, true); - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionRemoveSuccess - -Remove a document with a conflict: - - @startDocuBlockInline documentsCollectionRemoveConflict - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionRemoveConflict} - ~ db._create("example"); - a1 = db.example.insert({ a : 1 }); - a2 = db._replace(a1, { a : 2 }); - db._remove(a1); // xpError(ERROR_ARANGO_CONFLICT) - db._remove(a1, true); - db._document(a1); // xpError(ERROR_ARANGO_DOCUMENT_NOT_FOUND) - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionRemoveConflict - -Remove a document using new signature: - - @startDocuBlockInline documentsCollectionRemoveSignature - @EXAMPLE_ARANGOSH_OUTPUT{documentsCollectionRemoveSignature} - ~ db._create("example"); - db.example.insert({ a: 1 } ); - | db.example.remove("example/11265325374", - { overwrite: true, waitForSync: false}) - ~ db._drop("example"); - @END_EXAMPLE_ARANGOSH_OUTPUT - @endDocuBlock documentsCollectionRemoveSignature - - diff --git a/Documentation/Books/Users/Documents/DocumentAddress.mdpp b/Documentation/Books/Users/Documents/DocumentAddress.mdpp deleted file mode 100644 index 150cd9ac2d..0000000000 --- a/Documentation/Books/Users/Documents/DocumentAddress.mdpp +++ /dev/null @@ -1,22 +0,0 @@ -!CHAPTER Address and ETag of a Document - -All documents in ArangoDB have a [document handle](../Glossary/README.md#document-handle). This handle uniquely defines a -document and is managed by ArangoDB. The interface allows you to access the -documents of a collection as: - - db.collection.document("document-handle") - -For example: Assume that the document handle, which is stored in the *_id* field -of the document, is *demo/362549* and the document lives in a collection -named *demo*, then that document can be accessed as: - - db.demo.document("demo/362549736") - -Because the document handle is unique within the database, you -can leave out the *collection* and use the shortcut: - - db._document("demo/362549736") - -Each document also has a [document revision](../Glossary/README.md#document-revision) or ETag which is returned in the -*_rev* field when requesting a document. The document's key is returned in the -*_key* attribute. diff --git a/Documentation/Books/Users/Documents/README.mdpp b/Documentation/Books/Users/Documents/README.mdpp deleted file mode 100644 index d173ac65cf..0000000000 --- a/Documentation/Books/Users/Documents/README.mdpp +++ /dev/null @@ -1,62 +0,0 @@ -!CHAPTER Documents, Identifiers, Handles - - -This is an introduction to ArangoDB's interface for documents to and how handle -documents from the JavaScript shell *arangosh*. For other languages see the -corresponding language API. - -Documents in ArangoDB are JSON objects. These objects can be nested (to any depth) -and may contain lists. Each document is uniquely identified by its [document handle](../Glossary/README.md#document-handle). - -For example: - -```js -{ - "firstName" : "Hugo", - "lastName" : "Schlonz", - "address" : { - "city" : "Hier", - "street" : "Strasse 1" - }, - "hobbies" : [ - "swimming", - "biking", - "programming" - ], - "_id" : "demo/schlonz", - "_rev" : "13728680", - "_key" : "schlonz" -} -``` -All documents contain special attributes: the document handle in *_id*, the -document's unique key in *_key* and and the ETag aka [document revision](../Glossary/README.md#document-revision) in -*_rev*. The value of the *_key* attribute can be specified by the user when -creating a document. *_id* and *_key* values are immutable once the document -has been created. The *_rev* value is maintained by ArangoDB autonomously. - -A document handle uniquely identifies a document in the database. It is a string and -consists of the collection's name and the [document key](../Glossary/README.md#document-key) (_key attribute) separated by /. - -As ArangoDB supports MVCC, documents can exist in more than -one revision. The document revision is the MVCC token used to identify a particular -revision of a document. It is a string value currently containing an integer number -and is unique within the list of document revisions for a single document. Document -revisions can be used to conditionally update, replace or delete documents in the -database. In order to find a particular revision of a document, you need the document -handle and the document revision. - -ArangoDB currently uses 64bit unsigned integer values to maintain document revisions -internally. When returning document revisions to clients, ArangoDB will put them -into a string to ensure the revision id is not clipped by clients that do not support -big integers. Clients should treat the revision id returned by ArangoDB as an opaque -string when they store or use it locally. This will allow ArangoDB to change the format -of revision ids later if this should be required. Clients can use revisions ids to -perform simple equality/non-equality comparisons (e.g. to check whether a document has -changed or not), but they should not use revision ids to perform greater/less than -comparisons with them to check if a document revision is older than one another, -even if this might work for some cases. - -**Note**: Revision ids have been returned as integers up to including ArangoDB 1.1 - -*Document Etag*: The document revision enclosed in double quotes. The revision is -returned by several HTTP API methods in the Etag HTTP header. diff --git a/Documentation/Books/Users/Foxx/Develop/Queries.mdpp b/Documentation/Books/Users/Foxx/Develop/Queries.mdpp index 752d0a47a8..341370ec91 100644 --- a/Documentation/Books/Users/Foxx/Develop/Queries.mdpp +++ b/Documentation/Books/Users/Foxx/Develop/Queries.mdpp @@ -18,6 +18,7 @@ console.log(result); !SECTION AQL Template Strings ArangoDB supports ES2015-style template strings for queries using the `aqlQuery` template helper. +First, lets have a look at how it works, then use it for a query: **Examples** @@ -28,6 +29,15 @@ var console = require('console'); var isAdmin = true; var userCollection = applicationContext.collection('users'); +var key = 'testKey'; +aqlQuery`FOR c IN mycollection FILTER c._key == ${key} RETURN c._key`; +var results_in = { + "query" : "FOR c IN mycollection FILTER c._key == @value0 RETURN c._key", + "bindVars" : { + "value0" : "testKey" + } +} + var usernames = db._query(aqlQuery` FOR user IN ${userCollection} FILTER user.isAdmin == ${isAdmin} diff --git a/Documentation/Books/Users/FirstSteps/Arangod.mdpp b/Documentation/Books/Users/GettingStarted/Arangod.mdpp similarity index 100% rename from Documentation/Books/Users/FirstSteps/Arangod.mdpp rename to Documentation/Books/Users/GettingStarted/Arangod.mdpp diff --git a/Documentation/Books/Users/FirstSteps/Arangosh.mdpp b/Documentation/Books/Users/GettingStarted/Arangosh.mdpp similarity index 100% rename from Documentation/Books/Users/FirstSteps/Arangosh.mdpp rename to Documentation/Books/Users/GettingStarted/Arangosh.mdpp diff --git a/Documentation/Books/Users/FirstSteps/CollectionsAndDocuments.mdpp b/Documentation/Books/Users/GettingStarted/CollectionsAndDocuments.mdpp similarity index 100% rename from Documentation/Books/Users/FirstSteps/CollectionsAndDocuments.mdpp rename to Documentation/Books/Users/GettingStarted/CollectionsAndDocuments.mdpp diff --git a/Documentation/Books/Users/FirstSteps/GettingFamiliar.mdpp b/Documentation/Books/Users/GettingStarted/GettingFamiliar.mdpp similarity index 100% rename from Documentation/Books/Users/FirstSteps/GettingFamiliar.mdpp rename to Documentation/Books/Users/GettingStarted/GettingFamiliar.mdpp diff --git a/Documentation/Books/Users/Installing/ARM.mdpp b/Documentation/Books/Users/GettingStarted/Installing/ARM.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/ARM.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/ARM.mdpp diff --git a/Documentation/Books/Users/Installing/Cluster.mdpp b/Documentation/Books/Users/GettingStarted/Installing/Cluster.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/Cluster.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/Cluster.mdpp diff --git a/Documentation/Books/Users/Installing/Compiling.mdpp b/Documentation/Books/Users/GettingStarted/Installing/Compiling.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/Compiling.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/Compiling.mdpp diff --git a/Documentation/Books/Users/Installing/Linux.mdpp b/Documentation/Books/Users/GettingStarted/Installing/Linux.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/Linux.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/Linux.mdpp diff --git a/Documentation/Books/Users/Installing/MacOSX.mdpp b/Documentation/Books/Users/GettingStarted/Installing/MacOSX.mdpp similarity index 91% rename from Documentation/Books/Users/Installing/MacOSX.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/MacOSX.mdpp index f154494695..0f646cf1fb 100644 --- a/Documentation/Books/Users/Installing/MacOSX.mdpp +++ b/Documentation/Books/Users/GettingStarted/Installing/MacOSX.mdpp @@ -43,7 +43,11 @@ Then remove the LaunchAgent: **Note**: If the latest ArangoDB Version is not shown in homebrew, you also need to update homebrew: - brew update + brew update + +!SubSection Known issues +- Performance - the LLVM delivered as of Mac OS X El Capitan builds slow binaries. Use GCC instead +- the Commandline argument parsing doesn't accept blanks in filenames; the CLI version below does. !SECTION Apple's App Store diff --git a/Documentation/Books/Users/Installing/README.mdpp b/Documentation/Books/Users/GettingStarted/Installing/README.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/README.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/README.mdpp diff --git a/Documentation/Books/Users/Installing/Windows.mdpp b/Documentation/Books/Users/GettingStarted/Installing/Windows.mdpp similarity index 100% rename from Documentation/Books/Users/Installing/Windows.mdpp rename to Documentation/Books/Users/GettingStarted/Installing/Windows.mdpp diff --git a/Documentation/Books/Users/Installing/cluster-create-dialog.png b/Documentation/Books/Users/GettingStarted/Installing/cluster-create-dialog.png similarity index 100% rename from Documentation/Books/Users/Installing/cluster-create-dialog.png rename to Documentation/Books/Users/GettingStarted/Installing/cluster-create-dialog.png diff --git a/Documentation/Books/Users/Installing/cluster-single-server-dialog.png b/Documentation/Books/Users/GettingStarted/Installing/cluster-single-server-dialog.png similarity index 100% rename from Documentation/Books/Users/Installing/cluster-single-server-dialog.png rename to Documentation/Books/Users/GettingStarted/Installing/cluster-single-server-dialog.png diff --git a/Documentation/Books/Users/FirstSteps/README.mdpp b/Documentation/Books/Users/GettingStarted/README.mdpp similarity index 100% rename from Documentation/Books/Users/FirstSteps/README.mdpp rename to Documentation/Books/Users/GettingStarted/README.mdpp diff --git a/Documentation/Books/Users/WebInterface/README.mdpp b/Documentation/Books/Users/GettingStarted/WebInterface.mdpp similarity index 100% rename from Documentation/Books/Users/WebInterface/README.mdpp rename to Documentation/Books/Users/GettingStarted/WebInterface.mdpp diff --git a/Documentation/Books/Users/Edges/README.mdpp b/Documentation/Books/Users/Graphs/Edges/README.mdpp similarity index 100% rename from Documentation/Books/Users/Edges/README.mdpp rename to Documentation/Books/Users/Graphs/Edges/README.mdpp diff --git a/Documentation/Books/Users/GeneralGraphs/FluentAQLInterface.mdpp b/Documentation/Books/Users/Graphs/GeneralGraphs/FluentAQLInterface.mdpp similarity index 100% rename from Documentation/Books/Users/GeneralGraphs/FluentAQLInterface.mdpp rename to Documentation/Books/Users/Graphs/GeneralGraphs/FluentAQLInterface.mdpp diff --git a/Documentation/Books/Users/GeneralGraphs/Functions.mdpp b/Documentation/Books/Users/Graphs/GeneralGraphs/Functions.mdpp similarity index 100% rename from Documentation/Books/Users/GeneralGraphs/Functions.mdpp rename to Documentation/Books/Users/Graphs/GeneralGraphs/Functions.mdpp diff --git a/Documentation/Books/Users/GeneralGraphs/Management.mdpp b/Documentation/Books/Users/Graphs/GeneralGraphs/Management.mdpp similarity index 99% rename from Documentation/Books/Users/GeneralGraphs/Management.mdpp rename to Documentation/Books/Users/Graphs/GeneralGraphs/Management.mdpp index 4815a08b5a..7715cabd64 100644 --- a/Documentation/Books/Users/GeneralGraphs/Management.mdpp +++ b/Documentation/Books/Users/Graphs/GeneralGraphs/Management.mdpp @@ -900,7 +900,7 @@ Updates the data of an edge in collection edgeCollectionName var examples = require("@arangodb/graph-examples/example-graph.js"); var graph = examples.loadGraph("social"); graph.relation.save("female/alice", "female/diana", {type: "knows", _key: "aliceAndDiana"}); - graph.relation.update("relation/aliceAndDiana", {type: "quarrelled", _key: "aliceAndDiana"}); + graph.relation.update("relation/aliceAndDiana", {type: "quarreled", _key: "aliceAndDiana"}); ~ examples.dropGraph("social"); @END_EXAMPLE_ARANGOSH_OUTPUT @endDocuBlock generalGraphEdgeCollectionUpdate diff --git a/Documentation/Books/Users/GeneralGraphs/README.mdpp b/Documentation/Books/Users/Graphs/GeneralGraphs/README.mdpp similarity index 100% rename from Documentation/Books/Users/GeneralGraphs/README.mdpp rename to Documentation/Books/Users/Graphs/GeneralGraphs/README.mdpp diff --git a/Documentation/Books/Users/Traversals/ExampleData.mdpp b/Documentation/Books/Users/Graphs/Traversals/ExampleData.mdpp similarity index 100% rename from Documentation/Books/Users/Traversals/ExampleData.mdpp rename to Documentation/Books/Users/Graphs/Traversals/ExampleData.mdpp diff --git a/Documentation/Books/Users/Traversals/README.mdpp b/Documentation/Books/Users/Graphs/Traversals/README.mdpp similarity index 100% rename from Documentation/Books/Users/Traversals/README.mdpp rename to Documentation/Books/Users/Graphs/Traversals/README.mdpp diff --git a/Documentation/Books/Users/Traversals/UsingTraversalObjects.mdpp b/Documentation/Books/Users/Graphs/Traversals/UsingTraversalObjects.mdpp similarity index 100% rename from Documentation/Books/Users/Traversals/UsingTraversalObjects.mdpp rename to Documentation/Books/Users/Graphs/Traversals/UsingTraversalObjects.mdpp diff --git a/Documentation/Books/Users/HEADER.html b/Documentation/Books/Users/HEADER.html new file mode 100644 index 0000000000..9a1ec7309f --- /dev/null +++ b/Documentation/Books/Users/HEADER.html @@ -0,0 +1,42 @@ + \ No newline at end of file diff --git a/Documentation/Books/Users/HttpDocument/AddressAndEtag.mdpp b/Documentation/Books/Users/HttpDocument/AddressAndEtag.mdpp deleted file mode 100644 index 2831d1265f..0000000000 --- a/Documentation/Books/Users/HttpDocument/AddressAndEtag.mdpp +++ /dev/null @@ -1,36 +0,0 @@ -!CHAPTER Address and ETag of a Document - -All documents in ArangoDB have a [document handle](../Glossary/README.md#document-handle). This handle uniquely identifies -a document. Any document can be retrieved using its unique URI: - - http://server:port/_api/document/ - -For example, assumed that the document handle, which is stored in the *_id* -attribute of the document, is *demo/362549736*, then the URL of that document -is: - - http://localhost:8529/_api/document/demo/362549736 - -The above URL scheme does not specify a [database name](../Glossary/README.md#database-name) explicitly, so the -default database will be used. To explicitly specify the database context, use -the following URL schema: - - http://server:port/_db//_api/document/ - -Example: - - http://localhost:8529/_db/mydb/_api/document/demo/362549736 - -**Note**: The following examples use the short URL format for brevity. - -Each document also has a [document revision](../Glossary/README.md#document-revision) or Etag with is returned in the -"ETag" HTTP header when requesting a document. - -If you obtain a document using *GET* and you want to check if a newer revision -is available, then you can use the *If-None-Match* header. If the document is -unchanged, a *HTTP 412* (precondition failed) error is returned. - -If you want to update or delete a document, then you can use the *If-Match* -header. If the document has changed, then the operation is aborted and a *HTTP -412* error is returned. - diff --git a/Documentation/Books/Users/HttpDocument/README.mdpp b/Documentation/Books/Users/HttpDocument/README.mdpp deleted file mode 100644 index 935a1c747f..0000000000 --- a/Documentation/Books/Users/HttpDocument/README.mdpp +++ /dev/null @@ -1,67 +0,0 @@ -!CHAPTER HTTP Interface for Documents - -!SUBSECTION Documents, Identifiers, Handles - -This is an introduction to ArangoDB's REST interface for documents. - -Documents in ArangoDB are JSON objects. These objects can be nested (to any depth) and may contain lists. Each document is uniquely identified by its [document handle](../Glossary/README.md#document-handle). - -An example document: - -```js -{ - "_id" : "myusers/3456789", - "_key" : "3456789", - "_rev" : "3456789", - "firstName" : "Hugo", - "lastName" : "Schlonz", - "address" : { - "street" : "Street of Happiness", - "city" : "Heretown" - }, - "hobbies" : [ - "swimming", - "biking", - "programming" - ] -} -``` - -All documents contain special attributes: the document handle in `_id`, the -document's unique key in `_key` and and the Etag aka [document revision](../Glossary/README.md#document-revision) in -`_rev`. The value of the `_key` attribute can be specified by the user when -creating a document. `_id` and `_key` values are immutable once the document -has been created. The `_rev` value is maintained by ArangoDB autonomously. - -!SUBSECTION Document Handle - -A document handle uniquely identifies a document in the database. It is a string and consists of the collection's name and the document key (`_key` attribute) separated by `/`. - -!SUBSECTION Document Key - -A document key uniquely identifies a document in the collection it it stored in. It can and should be used by clients when specific documents are searched. Document keys are stored in the `_key` attribute of documents. The key values are automatically indexed by ArangoDB in a collection's primary index. Thus looking up a document by its key is regularly a fast operation. The _key value of a document is immutable once the document has been created. -By default, ArangoDB will auto-generate a document key if no _key attribute is specified, and use the user-specified _key otherwise. - -This behavior can be changed on a per-collection level by creating collections with the keyOptions attribute. - -Using keyOptions it is possible to disallow user-specified keys completely, or to force a specific regime for auto-generating the _key values. - -!SUBSECTION Document Revision - -As ArangoDB supports MVCC, documents can exist in more than one revision. The document revision is the MVCC token used to identify a particular revision of a document. It is a string value currently containing an integer number and is unique within the list of document revisions for a single document. Document revisions can be used to conditionally update, replace or delete documents in the database. In order to find a particular revision of a document, you need the document handle and the document revision. -ArangoDB currently uses 64bit unsigned integer values to maintain document revisions internally. When returning document revisions to clients, ArangoDB will put them into a string to ensure the revision id is not clipped by clients that do not support big integers. Clients should treat the revision id returned by ArangoDB as an opaque string when they store or use it locally. This will allow ArangoDB to change the format of revision ids later if this should be required. Clients can use revisions ids to perform simple equality/non-equality comparisons (e.g. to check whether a document has changed or not), but they should not use revision ids to perform greater/less than comparisons with them to check if a document revision is older than one another, even if this might work for some cases. - -**Note**: Revision ids have been returned as integers up to including ArangoDB 1.1 - -!SUBSECTION Document Etag - -The document revision enclosed in double quotes. The revision is returned by several HTTP API methods in the Etag HTTP header. - -The basic operations (create, read, update, delete) for documents are mapped to -the standard HTTP methods (*POST*, *GET*, *PUT*, *DELETE*). There is also a -partial update method, which is mapped to the HTTP *PATCH* method. - -An identifier for the document revision is returned in the *ETag* HTTP header. -If you modify a document, you can use the *If-Match* field to detect conflicts. -The revision of a document can be checking using the HTTP method *HEAD*. - diff --git a/Documentation/Books/Users/HttpDocument/WorkingWithDocuments.mdpp b/Documentation/Books/Users/HttpDocument/WorkingWithDocuments.mdpp deleted file mode 100644 index 7794428d88..0000000000 --- a/Documentation/Books/Users/HttpDocument/WorkingWithDocuments.mdpp +++ /dev/null @@ -1,22 +0,0 @@ -!CHAPTER Working with Documents using REST - - -@startDocuBlock REST_DOCUMENT_READ - - -@startDocuBlock REST_DOCUMENT_CREATE - - -@startDocuBlock REST_DOCUMENT_REPLACE - - -@startDocuBlock REST_DOCUMENT_UPDATE - - -@startDocuBlock REST_DOCUMENT_DELETE - - -@startDocuBlock REST_DOCUMENT_READ_HEAD - - -@startDocuBlock REST_DOCUMENT_READ_ALL \ No newline at end of file diff --git a/Documentation/Books/Users/IndexHandling/Cap.mdpp b/Documentation/Books/Users/Indexing/Cap.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/Cap.mdpp rename to Documentation/Books/Users/Indexing/Cap.mdpp diff --git a/Documentation/Books/Users/IndexHandling/Fulltext.mdpp b/Documentation/Books/Users/Indexing/Fulltext.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/Fulltext.mdpp rename to Documentation/Books/Users/Indexing/Fulltext.mdpp diff --git a/Documentation/Books/Users/IndexHandling/Geo.mdpp b/Documentation/Books/Users/Indexing/Geo.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/Geo.mdpp rename to Documentation/Books/Users/Indexing/Geo.mdpp diff --git a/Documentation/Books/Users/IndexHandling/Hash.mdpp b/Documentation/Books/Users/Indexing/Hash.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/Hash.mdpp rename to Documentation/Books/Users/Indexing/Hash.mdpp diff --git a/Documentation/Books/Users/IndexHandling/IndexBasics.mdpp b/Documentation/Books/Users/Indexing/IndexBasics.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/IndexBasics.mdpp rename to Documentation/Books/Users/Indexing/IndexBasics.mdpp diff --git a/Documentation/Books/Users/IndexHandling/README.mdpp b/Documentation/Books/Users/Indexing/README.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/README.mdpp rename to Documentation/Books/Users/Indexing/README.mdpp diff --git a/Documentation/Books/Users/IndexHandling/Skiplist.mdpp b/Documentation/Books/Users/Indexing/Skiplist.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/Skiplist.mdpp rename to Documentation/Books/Users/Indexing/Skiplist.mdpp diff --git a/Documentation/Books/Users/IndexHandling/HowArangoDBUsesIndexes.mdpp b/Documentation/Books/Users/Indexing/Utilization.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/HowArangoDBUsesIndexes.mdpp rename to Documentation/Books/Users/Indexing/Utilization.mdpp diff --git a/Documentation/Books/Users/IndexHandling/WhichIndex.mdpp b/Documentation/Books/Users/Indexing/WhichIndex.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/WhichIndex.mdpp rename to Documentation/Books/Users/Indexing/WhichIndex.mdpp diff --git a/Documentation/Books/Users/IndexHandling/WorkingWithIndexes.mdpp b/Documentation/Books/Users/Indexing/WorkingWithIndexes.mdpp similarity index 100% rename from Documentation/Books/Users/IndexHandling/WorkingWithIndexes.mdpp rename to Documentation/Books/Users/Indexing/WorkingWithIndexes.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures21.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures21.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures21.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures21.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures22.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures22.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures22.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures22.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures23.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures23.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures23.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures23.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures24.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures24.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures24.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures24.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures25.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures25.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures25.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures25.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures26.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures26.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures26.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures26.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures27.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures27.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures27.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures27.mdpp diff --git a/Documentation/Books/Users/NewFeatures/NewFeatures28.mdpp b/Documentation/Books/Users/ReleaseNotes/NewFeatures28.mdpp similarity index 100% rename from Documentation/Books/Users/NewFeatures/NewFeatures28.mdpp rename to Documentation/Books/Users/ReleaseNotes/NewFeatures28.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges23.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges23.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges23.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges23.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges24.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges24.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges24.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges24.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges25.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges25.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges25.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges25.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges26.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges26.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges26.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges26.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges27.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges27.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges27.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges27.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges28.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges28.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges28.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges28.mdpp diff --git a/Documentation/Books/Users/Upgrading/UpgradingChanges30.mdpp b/Documentation/Books/Users/ReleaseNotes/UpgradingChanges30.mdpp similarity index 100% rename from Documentation/Books/Users/Upgrading/UpgradingChanges30.mdpp rename to Documentation/Books/Users/ReleaseNotes/UpgradingChanges30.mdpp diff --git a/Documentation/Books/Users/SUMMARY.md b/Documentation/Books/Users/SUMMARY.md index 459f09e59e..998ff672e4 100644 --- a/Documentation/Books/Users/SUMMARY.md +++ b/Documentation/Books/Users/SUMMARY.md @@ -1,146 +1,77 @@ - +# # Summary -* [Installing](Installing/README.md) - * [Linux](Installing/Linux.md) - * [Mac OS X](Installing/MacOSX.md) - * [Windows](Installing/Windows.md) - * [ARM](Installing/ARM.md) - * [Compiling](Installing/Compiling.md) - * [Upgrading](Installing/Upgrading.md) - * [Incompatible changes in 3.0](Upgrading/UpgradingChanges30.md) - * [Upgrading to 3.0](Upgrading/Upgrading30.md) - * [Incompatible changes in 2.8](Upgrading/UpgradingChanges28.md) - * [Upgrading to 2.8](Upgrading/Upgrading28.md) - * [Incompatible changes in 2.7](Upgrading/UpgradingChanges27.md) - * [Incompatible changes in 2.6](Upgrading/UpgradingChanges26.md) - * [Upgrading to 2.6](Upgrading/Upgrading26.md) - * [Incompatible changes in 2.5](Upgrading/UpgradingChanges25.md) - * [Upgrading to 2.5](Upgrading/Upgrading25.md) - * [Incompatible changes in 2.4](Upgrading/UpgradingChanges24.md) - * [Upgrading to 2.4](Upgrading/Upgrading24.md) - * [Incompatible changes in 2.3](Upgrading/UpgradingChanges23.md) - * [Upgrading to 2.3](Upgrading/Upgrading23.md) - * [Upgrading to 2.2](Upgrading/Upgrading22.md) - * [Cluster setup](Installing/Cluster.md) -* [Whats New](NewFeatures/NewFeatures28.md) - * [Whats New in 2.7](NewFeatures/NewFeatures27.md) - * [Whats New in 2.6](NewFeatures/NewFeatures26.md) - * [Whats New in 2.5](NewFeatures/NewFeatures25.md) - * [Whats New in 2.4](NewFeatures/NewFeatures24.md) - * [Whats New in 2.3](NewFeatures/NewFeatures23.md) - * [Whats New in 2.2](NewFeatures/NewFeatures22.md) - * [Whats New in 2.1](NewFeatures/NewFeatures21.md) -* [First Steps](FirstSteps/README.md) - * [Getting Familiar](FirstSteps/GettingFamiliar.md) - * [The ArangoDB Server](FirstSteps/Arangod.md) - * [The ArangoDB Shell](Arangosh/README.md) - * [Shell Output](Arangosh/Output.md) - * [Configuration](Arangosh/Configuration.md) - * [Details](FirstSteps/Arangosh.md) - * [Collections](FirstSteps/CollectionsAndDocuments.md) -* [ArangoDB Web Interface](WebInterface/README.md) -* [Creating and Dropping Databases](Databases/README.md) - * [Working with Databases](Databases/WorkingWith.md) - * [Notes about Databases](Databases/Notes.md) -* [Creating and Dropping Collections](Collections/README.md) - * [Collection Methods](Collections/CollectionMethods.md) - * [Database Methods](Collections/DatabaseMethods.md) -* [Working with Documents](Documents/README.md) - * [Address and ETag](Documents/DocumentAddress.md) - * [Collection Methods](Documents/DocumentMethods.md) - * [Database Methods](Documents/DatabaseMethods.md) -* [Indexing](IndexHandling/README.md) - * [Index Basics](IndexHandling/IndexBasics.md) - * [Which Index to use when](IndexHandling/WhichIndex.md) - * [How ArangoDB uses indexes](IndexHandling/HowArangoDBUsesIndexes.md) - * [Working with Indexes](IndexHandling/WorkingWithIndexes.md) - * [Hash Indexes](IndexHandling/Hash.md) - * [Skiplists](IndexHandling/Skiplist.md) - * [Fulltext Indexes](IndexHandling/Fulltext.md) - * [Geo Indexes](IndexHandling/Geo.md) - * [Cap Constraint](IndexHandling/Cap.md) -* [Simple Queries](SimpleQueries/README.md) - * [Sequential Access](SimpleQueries/Access.md) - * [Pagination](SimpleQueries/Pagination.md) - * [Modification Queries](SimpleQueries/ModificationQueries.md) - * [Geo Queries](SimpleQueries/GeoQueries.md) - * [Fulltext Queries](SimpleQueries/FulltextQueries.md) -* [Transactions](Transactions/README.md) - * [Transaction invocation](Transactions/TransactionInvocation.md) - * [Passing parameters](Transactions/Passing.md) - * [Locking and isolation](Transactions/LockingAndIsolation.md) - * [Durability](Transactions/Durability.md) - * [Limitations](Transactions/Limitations.md) -* [AQL](Aql/README.md) - * [How to invoke AQL](Aql/Invoke.md) - * [with Arangosh](Aql/AqlWithArangosh.md) - * [with the Web Interface](Aql/AqlWithWebInterface.md) - * [Data modification queries](Aql/DataModification.md) - * [AQL Fundamentals](Aql/Fundamentals.md) - * [AQL Syntax](Aql/Syntax.md) - * [Data types](Aql/DataTypes.md) - * [Bind Parameters](Aql/BindParameters.md) - * [Type and value order](Aql/TypeValueOrder.md) - * [Accessing data from collections](Aql/DocumentData.md) - * [Query Results](Aql/QueryResults.md) - * [Query Errors](Aql/QueryErrors.md) - * [High level Operations](Aql/Operations.md) - * [For](AqlOperations/For.md) - * [Return](AqlOperations/Return.md) - * [Filter](AqlOperations/Filter.md) - * [Sort](AqlOperations/Sort.md) - * [Limit](AqlOperations/Limit.md) - * [Let](AqlOperations/Let.md) - * [Collect](AqlOperations/Collect.md) - * [Remove](AqlOperations/Remove.md) - * [Update](AqlOperations/Update.md) - * [Replace](AqlOperations/Replace.md) - * [Insert](AqlOperations/Insert.md) - * [Upsert](AqlOperations/Upsert.md) - * [Operators](Aql/Operators.md) - * [Functions](Aql/Functions.md) - * [Type cast](Aql/TypeCastFunctions.md) - * [String](Aql/StringFunctions.md) - * [Numeric](Aql/NumericFunctions.md) - * [Date](Aql/DateFunctions.md) - * [Array](Aql/ArrayFunctions.md) - * [Object / Document](Aql/DocumentFunctions.md) - * [Geo](Aql/GeoFunctions.md) - * [Fulltext](Aql/FulltextFunctions.md) - * [Miscellaneous](Aql/MiscellaneousFunctions.md) - * [Graphs](Aql/Graphs.md) - * [Traversal](Aql/GraphTraversals.md) - * [Named Operations](Aql/GraphOperations.md) - * [Other](Aql/GraphFunctions.md) - * [Advanced Features](Aql/Advanced.md) - * [Array Operators](Aql/ArrayOperators.md) - * [Usual Query Patterns](AqlExamples/README.md) - * [Data-modification queries](AqlExamples/DataModificationQueries.md) - * [Subqueries](AqlExamples/CombiningQueries.md) - * [Projections and filters](AqlExamples/ProjectionsAndFilters.md) - * [Joins](AqlExamples/Join.md) - * [Grouping](AqlExamples/Grouping.md) - * [Traversals](AqlExamples/CombiningGraphTraversals.md) - * [Queries without collections](AqlExamples/QueriesNoCollections.md) - * [User Functions](AqlExtending/README.md) - * [Conventions](AqlExtending/Conventions.md) - * [Registering Functions](AqlExtending/Functions.md) - * [Execution and Performance](Aql/ExecutionPerformance.md) - * [Query statistics](Aql/QueryStatistics.md) - * [Parsing queries](Aql/ParsingQueries.md) - * [Explaining queries](Aql/ExplainingQueries.md) - * [Optimizing queries](Aql/Optimizer.md) - * [Caching query results](Aql/QueryCache.md) +# +#* [First Steps](FirstSteps/README.md) +# * [Getting Familiar](FirstSteps/GettingFamiliar.md) +* [Getting Started](GettingStarted/README.md) + # move to administration (command line options)? + #* [Install and run the server](FirstSteps/Arangod.md) + * [Installing](GettingStarted/Installing/README.md) + * [Linux](GettingStarted/Installing/Linux.md) + * [Mac OS X](GettingStarted/Installing/MacOSX.md) + * [Windows](GettingStarted/Installing/Windows.md) + * [ARM](GettingStarted/Installing/ARM.md) + * [Compiling](GettingStarted/Installing/Compiling.md) + * [Cluster setup](GettingStarted/Installing/Cluster.md) + * [Using the Web Interface](GettingStarted/WebInterface.md) + * [Your first queries](GettingStarted/AqlQueries.md) + * [Coming from SQL](GettingStarted/ComingFromSql.md) + * [Coming from MongoDB](GettingStarted/ComingFromMongoDb.md) +# +* [Scalability](Scalability/README.md) + * [Joins](Scalability/Joins.md) +# +* [Data model & modeling](DataModeling/README.md) +#* [Collections](FirstSteps/CollectionsAndDocuments.md) + * [Concepts](DataModeling/Concepts.md) + * [Databases](DataModeling/Databases/README.md) + * [Working with Databases](DataModeling/Databases/WorkingWith.md) + * [Notes about Databases](DataModeling/Databases/Notes.md) + * [Collections](DataModeling/Collections/README.md) + * [Collection Methods](DataModeling/Collections/CollectionMethods.md) + * [Database Methods](DataModeling/Collections/DatabaseMethods.md) + * [Documents](DataModeling/Documents/README.md) + * [Basics and Terminology](DataModeling/Documents/DocumentAddress.md) + * [Collection Methods](DataModeling/Documents/DocumentMethods.md) + * [Database Methods](DataModeling/Documents/DatabaseMethods.md) + * [Graphs, Vertices & Edges](DataModeling/GraphsVerticesEdges.md) + * [Naming Conventions](DataModeling/NamingConventions/README.md) + * [Database Names](DataModeling/NamingConventions/DatabaseNames.md) + * [Collection Names](DataModeling/NamingConventions/CollectionNames.md) + * [Document Keys](DataModeling/NamingConventions/DocumentKeys.md) + * [Attribute Names](DataModeling/NamingConventions/AttributeNames.md) + * [Modeling Relationships](DataModeling/ModelingRelationships.md) + # Best practice? (Date handling, Versioning / Revisions + # Add a fake chapter for AQL to go to the AQL docs? + #* [AQL query language](Aql/README.md) + # * [10-minutes guide](Aql/TenMinutesGuide.md) + # * [Using Joins in AQL](Aql/UsingJoins.md) + # * [Dynamic attribute names](Aql/DynamicAttributes.md) + # ... +# +* [Indexing](Indexing/README.md) + * [Index Basics](Indexing/IndexBasics.md) + * [Which Index to use when](Indexing/WhichIndex.md) + * [How ArangoDB uses indexes](Indexing/HowArangoDBUsesIndexes.md) + * [Working with Indexes](Indexing/WorkingWithIndexes.md) + * [Hash Indexes](Indexing/Hash.md) + * [Skiplists](Indexing/Skiplist.md) + * [Fulltext Indexes](Indexing/Fulltext.md) + * [Geo Indexes](Indexing/Geo.md) + * [Cap Constraint](Indexing/Cap.md) +# * [Graphs](Graphs/README.md) - * [General Graphs](GeneralGraphs/README.md) - * [Graph Management](GeneralGraphs/Management.md) - * [Graph Functions](GeneralGraphs/Functions.md) - * [Fluent Query Interface](GeneralGraphs/FluentAQLInterface.md) - * [Traversals](Traversals/README.md) - * [Using Traversal Objects](Traversals/UsingTraversalObjects.md) - * [Example Data](Traversals/ExampleData.md) - * [Working with Edges](Edges/README.md) -* [Foxx](Foxx/README.md) + * [General Graphs](Graphs/GeneralGraphs/README.md) + * [Graph Management](Graphs/GeneralGraphs/Management.md) + * [Graph Functions](Graphs/GeneralGraphs/Functions.md) + * [Fluent Query Interface](Graphs/GeneralGraphs/FluentAQLInterface.md) + * [Traversals](Graphs/Traversals/README.md) + * [Using Traversal Objects](Graphs/Traversals/UsingTraversalObjects.md) + * [Example Data](Graphs/Traversals/ExampleData.md) + * [Working with Edges](Graphs/Edges/README.md) +# +# Will be replaced by new FOTF docs +* [Foxx microservices](Foxx/README.md) * [In a nutshell](Foxx/Nutshell/README.md) * [Install](Foxx/Install/README.md) * [Github](Foxx/Install/Github.md) @@ -170,107 +101,101 @@ * [Cluster](Foxx/Cluster/README.md) * [Install](Foxx/Cluster/Install.md) * [Setup & Teardown](Foxx/Cluster/Scripts.md) -* [ArangoDB's Actions](ArangoActions/README.md) - * [Delivering HTML Pages](ArangoActions/HtmlExample.md) - * [Json Objects](ArangoActions/JsonExample.md) - * [Modifying](ArangoActions/Modifying.md) -* [Replication](Replication/README.md) - * [Components](Replication/Components.md) - * [Example Setup](Replication/ExampleSetup.md) - * [Syncing Collections](Replication/SyncingCollections.md) - * [Replication Limitations](Replication/Limitations.md) - * [Replication Overhead](Replication/Overhead.md) -* [Sharding](Sharding/README.md) - * [How to try it out](Sharding/HowTo.md) - * [Implementation](Sharding/StatusOfImplementation.md) - * [Authentication](Sharding/Authentication.md) - * [Firewall setup](Sharding/FirewallSetup.md) -* [Server Configuration](ConfigureArango/README.md) - * [Arangod options](ConfigureArango/Arangod.md) - * [Write-ahead log options](ConfigureArango/Wal.md) - * [Managing Endpoints](ConfigureArango/Endpoint.md) - * [Cluster options](ConfigureArango/Cluster.md) - * [Logging options](ConfigureArango/Logging.md) - * [Communication options](ConfigureArango/Communication.md) - * [Authentication](ConfigureArango/Authentication.md) - * [Emergency Console](ConfigureArango/EmergencyConsole.md) -* [HTTP API](HttpApi/README.md) - * [General HTTP Handling](GeneralHttp/README.md) - * [Databases](HttpDatabase/README.md) - * [To-Endpoint](HttpDatabase/DatabaseEndpoint.md) - * [Management](HttpDatabase/DatabaseManagement.md) - * [Notes on Databases](HttpDatabase/NotesOnDatabases.md) - * [Documents](HttpDocument/README.md) - * [Address and ETag](HttpDocument/AddressAndEtag.md) - * [Working with](HttpDocument/WorkingWithDocuments.md) - * [Edges](HttpEdge/README.md) - * [Address and ETag](HttpEdge/AddressAndEtag.md) - * [Working with Edges](HttpEdge/WorkingWithEdges.md) - * [Exporting data](HttpExport/README.md) - * [AQL Query Cursors](HttpAqlQueryCursor/README.md) - * [Query Results](HttpAqlQueryCursor/QueryResults.md) - * [Accessing Cursors](HttpAqlQueryCursor/AccessingCursors.md) - * [AQL Queries](HttpAqlQuery/README.md) - * [AQL Query Cache](HttpAqlQueryCache/README.md) - * [AQL User Functions Management](HttpAqlUserFunctions/README.md) - * [Simple Queries](HttpSimpleQuery/README.md) - * [Collections](HttpCollection/README.md) - * [Creating](HttpCollection/Creating.md) - * [Getting Information](HttpCollection/Getting.md) - * [Modifying](HttpCollection/Modifying.md) - * [Indexes](HttpIndexes/README.md) - * [Working with Indexes](HttpIndexes/WorkingWith.md) - * [Cap Constraints](HttpIndexes/Cap.md) - * [Hash](HttpIndexes/Hash.md) - * [Skiplist](HttpIndexes/Skiplist.md) - * [Geo](HttpIndexes/Geo.md) - * [Fulltext](HttpIndexes/Fulltext.md) - * [Transactions](HttpTransaction/README.md) - * [General Graph](HttpGharial/README.md) - * [Management](HttpGharial/Management.md) - * [Vertices](HttpGharial/Vertices.md) - * [Edges](HttpGharial/Edges.md) - * [Traversals](HttpTraversal/README.md) - * [Replication](HttpReplications/README.md) - * [Replication Dump](HttpReplications/ReplicationDump.md) - * [Replication Logger](HttpReplications/ReplicationLogger.md) - * [Replication Applier](HttpReplications/ReplicationApplier.md) - * [Other Replication Commands](HttpReplications/OtherReplication.md) - * [Tasks](HttpTasks/README.md) - * [Monitoring](HttpAdministrationAndMonitoring/README.md) - * [User Management](HttpUserManagement/README.md) - * [Async Result Handling](HttpAsyncResultsManagement/README.md) - * [Endpoints](HttpEndpoints/README.md) - * [Sharding](HttpShardingInterface/README.md) - * [Miscellaneous functions](HttpMiscellaneousFunctions/README.md) -* [Bulk Import / Export](HttpBulkImports/README.md) - * [JSON Documents HTTP-API](HttpBulkImports/ImportingSelfContained.md) - * [Headers & Values HTTP-API](HttpBulkImports/ImportingHeadersAndValues.md) - * [Batch Requests HTTP-API](HttpBatchRequest/README.md) - * [Arangoimp](HttpBulkImports/Arangoimp.md) - * [Arangodump](HttpBulkImports/Arangodump.md) - * [Arangorestore](HttpBulkImports/Arangorestore.md) -* [JavaScript Modules](ModuleJavaScript/README.md) - * ["console"](ModuleConsole/README.md) - * ["fs"](ModuleFs/README.md) - * ["process"](ModuleProcess/README.md) - * ["request"](ModuleRequest/README.md) - * ["actions"](ModuleActions/README.md) - * ["queries"](ModuleQueries/README.md) - * [Write-ahead log](ModuleWal/README.md) - * [Task Management](ModuleTasks/README.md) - * [Using jsUnity](UsingJsUnity/README.md) -* [Administrating ArangoDB](AdministratingArango/README.md) -* [Advanced](Advanced/README.md) - * [Arangobench](Advanced/Arangobench.md) - * [Write-ahead log](Advanced/WriteAheadLog.md) - * [Server Internals](Advanced/ServerInternals.md) - * [Datafile Debugger](Advanced/DatafileDebugger.md) -* [Naming Conventions](NamingConventions/README.md) - * [Database Names](NamingConventions/DatabaseNames.md) - * [Collection Names](NamingConventions/CollectionNames.md) - * [Document Keys](NamingConventions/DocumentKeys.md) - * [Attribute Names](NamingConventions/AttributeNames.md) -* [Error codes and meanings](ErrorCodes/README.md) -* [Glossary](Glossary/README.md) - +* [Transactions](Transactions/README.md) + * [Transaction invocation](Transactions/TransactionInvocation.md) + * [Passing parameters](Transactions/Passing.md) + * [Locking and isolation](Transactions/LockingAndIsolation.md) + * [Durability](Transactions/Durability.md) + * [Limitations](Transactions/Limitations.md) +# +# Use cases / Advanced usage / Best practice (?) +# +* [Administration](Administration/README.md) + * [ArangoDB Shell](Administration/Arangosh/README.md) + * [Shell Output](Administration/Arangosh/Output.md) + * [Configuration](Administration/Arangosh/Configuration.md) + # relocate file? + * [Details](GettingStarted/Arangosh.md) + * [Arangoimp](Administration/Arangoimp.md) + * [Arangodump](Administration/Arangodump.md) + * [Arangorestore](Administration/Arangorestore.md) + * [Upgrading](Administration/Upgrading/README.md) + * [Upgrading to 2.8](Administration/Upgrading/Upgrading28.md) + * [Upgrading to 2.6](Administration/Upgrading/Upgrading26.md) + * [Upgrading to 2.5](Administration/Upgrading/Upgrading25.md) + * [Upgrading to 2.4](Administration/Upgrading/Upgrading24.md) + * [Upgrading to 2.3](Administration/Upgrading/Upgrading23.md) + * [Upgrading to 2.2](Administration/Upgrading/Upgrading22.md) + * [Server Configuration](Administration/Configuration/README.md) + * [Arangod options](Administration/Configuration/Arangod.md) + * [Write-ahead log options](Administration/Configuration/Wal.md) + * [Managing Endpoints](Administration/Configuration/Endpoint.md) + * [Cluster options](Administration/Configuration/Cluster.md) + * [Logging options](Administration/Configuration/Logging.md) + * [Communication options](Administration/Configuration/Communication.md) + * [Authentication](Administration/Configuration/Authentication.md) + * [Replication](Administration/Replication/README.md) + * [Components](Administration/Replication/Components.md) + * [Example Setup](Administration/Replication/ExampleSetup.md) + * [Syncing Collections](Administration/Replication/SyncingCollections.md) + * [Replication Limitations](Administration/Replication/Limitations.md) + * [Replication Overhead](Administration/Replication/Overhead.md) + * [Sharding](Administration/Sharding/README.md) + * [How to try it out](Administration/Sharding/HowTo.md) + * [Implementation](Administration/Sharding/StatusOfImplementation.md) + * [Authentication](Administration/Sharding/Authentication.md) + * [Firewall setup](Administration/Sharding/FirewallSetup.md) +# +* [Deployment](Deployment/README.md) +# +* [Troubleshooting](Troubleshooting/README.md) + * [Emergency Console](Troubleshooting/EmergencyConsole.md) + * [Datafile Debugger](Troubleshooting/DatafileDebugger.md) + * [Arangob](Troubleshooting/Arangob.md) +# +* [Architecture](Architecture/README.md) + * [Write-ahead log](Architecture/WriteAheadLog.md) + * [Server Internals](Architecture/ServerInternals.md) +# +* [Release notes](ReleaseNotes/README.md) + * [Whats New in 2.8](ReleaseNotes/NewFeatures28.md) + * [Whats New in 2.7](ReleaseNotes/NewFeatures27.md) + * [Whats New in 2.6](ReleaseNotes/NewFeatures26.md) + * [Whats New in 2.5](ReleaseNotes/NewFeatures25.md) + * [Whats New in 2.4](ReleaseNotes/NewFeatures24.md) + * [Whats New in 2.3](ReleaseNotes/NewFeatures23.md) + * [Whats New in 2.2](ReleaseNotes/NewFeatures22.md) + * [Whats New in 2.1](ReleaseNotes/NewFeatures21.md) + # Place next to Upgrading instead? + * [Incompatible changes in 2.8](ReleaseNotes/UpgradingChanges28.md) + * [Incompatible changes in 2.7](ReleaseNotes/UpgradingChanges27.md) + * [Incompatible changes in 2.6](ReleaseNotes/UpgradingChanges26.md) + * [Incompatible changes in 2.5](ReleaseNotes/UpgradingChanges25.md) + * [Incompatible changes in 2.4](ReleaseNotes/UpgradingChanges24.md) + * [Incompatible changes in 2.3](ReleaseNotes/UpgradingChanges23.md) +# +* [Appendix](Appendix/README.md) + * [JavaScript Modules](Appendix/JavaScriptModules/README.md) + * ["console"](Appendix/Modules/Console.md) + * ["fs"](Appendix/Modules/FS.md) + * ["process"](Appendix/Modules/Process.md) + * ["request"](Appendix/Modules/Request.md) + * ["actions"](Appendix/Modules/Actions.md) + * ["queries"](Appendix/Modules/Queries.md) + * ["planner"](Appendix/Modules/Planner.md) + * [Write-ahead log](Appendix/Modules/WAL.md) + * [Task Management](Appendix/Modules/Tasks.md) + * [Deprecated](Appendix/Deprecated/README.md) + * [Simple Queries](Appendix/Deprecated/SimpleQueries/README.md) + * [Sequential Access](Appendix/Deprecated/SimpleQueries/Access.md) + * [Pagination](Appendix/Deprecated/SimpleQueries/Pagination.md) + * [Modification Queries](Appendix/Deprecated/SimpleQueries/ModificationQueries.md) + * [Geo Queries](Appendix/Deprecated/SimpleQueries/GeoQueries.md) + * [Fulltext Queries](Appendix/Deprecated/SimpleQueries/FulltextQueries.md) + * [Actions](Appendix/Deprecated/Actions/README.md) + * [Delivering HTML Pages](Appendix/Deprecated/Actions/HtmlExample.md) + * [Json Objects](Appendix/Deprecated/Actions/JsonExample.md) + * [Modifying](Appendix/Deprecated/Actions/Modifying.md) + # Link to here from arangosh, actions, foxx, transactions + * [Error codes and meanings](Appendix/ErrorCodes/README.md) + * [Glossary](Appendix/Glossary.md) diff --git a/Documentation/Books/Users/Scalability/README.mdpp b/Documentation/Books/Users/Scalability/README.mdpp new file mode 100644 index 0000000000..b8144672f2 --- /dev/null +++ b/Documentation/Books/Users/Scalability/README.mdpp @@ -0,0 +1 @@ +!CHAPTER Scalability diff --git a/Documentation/Books/Users/Advanced/Arangobench.mdpp b/Documentation/Books/Users/Troubleshooting/Arangobench.mdpp similarity index 100% rename from Documentation/Books/Users/Advanced/Arangobench.mdpp rename to Documentation/Books/Users/Troubleshooting/Arangobench.mdpp diff --git a/Documentation/Books/Users/Advanced/DatafileDebugger.mdpp b/Documentation/Books/Users/Troubleshooting/DatafileDebugger.mdpp similarity index 100% rename from Documentation/Books/Users/Advanced/DatafileDebugger.mdpp rename to Documentation/Books/Users/Troubleshooting/DatafileDebugger.mdpp diff --git a/Documentation/Books/Users/ConfigureArango/EmergencyConsole.mdpp b/Documentation/Books/Users/Troubleshooting/EmergencyConsole.mdpp similarity index 100% rename from Documentation/Books/Users/ConfigureArango/EmergencyConsole.mdpp rename to Documentation/Books/Users/Troubleshooting/EmergencyConsole.mdpp diff --git a/Documentation/Books/Users/Troubleshooting/README.mdpp b/Documentation/Books/Users/Troubleshooting/README.mdpp new file mode 100644 index 0000000000..6f2656a73e --- /dev/null +++ b/Documentation/Books/Users/Troubleshooting/README.mdpp @@ -0,0 +1 @@ +!CHAPTER Troubleshooting diff --git a/Documentation/Books/Users/UsingJsUnity/README.mdpp b/Documentation/Books/Users/UsingJsUnity/README.mdpp deleted file mode 100644 index 79fc020b12..0000000000 --- a/Documentation/Books/Users/UsingJsUnity/README.mdpp +++ /dev/null @@ -1,36 +0,0 @@ -!CHAPTER Using jsUnity and node-jscoverage - - -!SUBSECTION jsUnity - -The ArangoDB contains a wrapper for [jsUnity](http://jsunity.com/), a -lightweight universal JavaScript unit testing framework. - -!SUBSECTION Running jsUnity Tests - -Assume that you have a test file containing - -```js -function exampleTestSuite () { - return { - testSizeOfTestCollection : function () { - assertEqual(5, 5); - }; -} - -jsUnity.run(aqlTestSuite); - -return jsunity.done(); -``` - -Then you can run the test suite using *jsunity.runTest* - -``` -arangosh> require("jsunity").runTest("test.js"); -2012-01-28T19:10:23Z [10671] INFO Running aqlTestSuite -2012-01-28T19:10:23Z [10671] INFO 1 test found -2012-01-28T19:10:23Z [10671] INFO [PASSED] testSizeOfTestCollection -2012-01-28T19:10:23Z [10671] INFO 1 test passed -2012-01-28T19:10:23Z [10671] INFO 0 tests failed -2012-01-28T19:10:23Z [10671] INFO 1 millisecond elapsed -``` diff --git a/Documentation/Books/Users/book.json b/Documentation/Books/Users/book.json index 824d5532f7..89f6dd5b37 100644 --- a/Documentation/Books/Users/book.json +++ b/Documentation/Books/Users/book.json @@ -4,7 +4,7 @@ "author": "ArangoDB GmbH", "description": "Official manual for ArangoDB - the multi-model NoSQL database", "language": "en", - "plugins":["toggle-chapters", "addcssjs"], + "plugins":["-search", "-sharing", "toggle-chapters", "addcssjs", "heading-anchors", "add-header"], "pdf": { "fontSize": 12, "toc": true, diff --git a/Documentation/Books/Users/styles/header.css b/Documentation/Books/Users/styles/header.css index 194fbff024..14be63b299 100644 --- a/Documentation/Books/Users/styles/header.css +++ b/Documentation/Books/Users/styles/header.css @@ -92,30 +92,11 @@ body { margin-top: 48px; } -.book-search, -.toggle-search, -.facebook-sharing-link { - display: none !important; -} - .book .book-summary ul.summary li.active > a, .book .book-summary ul.summary li a:hover { color: #fff !important; } -/* Header Hack - to prevent using a custom theme */ - -/* Disable Search - temp. -.book-search { visibility: hidden} -.toggle-search { visibility: hidden} -*/ - -#spacer { - margin-top: 40px; -} - -#searchx { padding-left: 100;} - #logo { display: block; float: left; @@ -138,10 +119,10 @@ body { } #header { - display: block; + position: fixed; width: 100%; height: 48px; - background: #444; + z-index: 1; } #header .socialIcons-googlegroups a img { @@ -149,10 +130,12 @@ body { top: 3px; } +/* #header .wrap, #header .wrap .clearfix { max-height: 48px; } +*/ .absolute{ position: absolute; @@ -186,14 +169,10 @@ body { font-family: Roboto, Helvetica, sans-serif; } -#navmenu li a:hover { +#navmenu li a:hover, #navmenu li.active-tab a { background: #8aa051 !important; } -.owntab { - background-color: #444444; -} - .arangodb_version { float: left; padding-left: 130px; @@ -248,7 +227,6 @@ body { float: left; left: -10px; } - .owntab { display: none !important; } .arangodb_version { display: none !important; } } diff --git a/Documentation/Books/Users/styles/header.js b/Documentation/Books/Users/styles/header.js index ea778b2798..78d4cfe65c 100644 --- a/Documentation/Books/Users/styles/header.js +++ b/Documentation/Books/Users/styles/header.js @@ -4,12 +4,12 @@ window.localStorage.removeItem(":keyword"); $(document).ready(function() { function appendHeader() { - +/* var div = document.createElement('div'); - div.innerHTML = ''; + div.innerHTML = ''; $('.book').before(div.innerHTML); - +*/ }; @@ -22,7 +22,7 @@ function appendHeader() { function renderGoogleSearch() { }; //render header - rerenderNavbar(); + //rerenderNavbar(); function addGoogleSrc() { var cx = '002866056653122356950:ju52xx-w-w8'; var gcse = document.createElement('script'); diff --git a/Documentation/Books/Users/styles/website.css b/Documentation/Books/Users/styles/website.css index 26234a82fd..3813329463 100755 --- a/Documentation/Books/Users/styles/website.css +++ b/Documentation/Books/Users/styles/website.css @@ -1 +1,43 @@ -div.example_show_button { border: medium solid lightgray; text-align: center; position: relative; top: -10px; } .book .book-body .navigation.navigation-next { right: 10px !important; } .book .book-summary ul.summary li.active>a,.book .book-summary ul.summary li a:hover { color: #fff !important; background: #80A54D !important; text-decoration: none; } .book .book-body .page-wrapper .page-inner section.normal .deprecated{ background-color: rgba(240,240,0,0.4); } .gsib_a { padding: 0px !important; } .gsc-control-cse { border: 0px !important; background-color: transparent !important; } .gsc-input { margin: 0px !important; } \ No newline at end of file +div.example_show_button { + border: medium solid lightgray; + text-align: center; + position: relative; + top: -10px; +} + +.book .book-body .navigation.navigation-next { + right: 10px !important; +} + +.book .book-summary ul.summary li.active>a,.book .book-summary ul.summary li a:hover { + color: #fff !important; + background: #80A54D !important; + text-decoration: none; +} + +.book .book-body .page-wrapper .page-inner section.normal .deprecated{ + background-color: rgba(240,240,0,0.4); +} + +.columns-3 { + -webkit-column-count: 3; + -moz-column-count: 3; + -ms-column-count: 3; + -o-column-count: 3; + column-count: 3; + columns: 3; +} + +.gsib_a { +padding: 0px !important; +} + +.gsc-control-cse { +border: 0px !important; +background-color: transparent !important; +} + + +.gsc-input { +margin: 0px !important; +} diff --git a/Documentation/DocuBlocks/JSF_general_graph_edge_collection_update.md b/Documentation/DocuBlocks/JSF_general_graph_edge_collection_update.md index 4b63da6a17..04e6d3e82f 100644 --- a/Documentation/DocuBlocks/JSF_general_graph_edge_collection_update.md +++ b/Documentation/DocuBlocks/JSF_general_graph_edge_collection_update.md @@ -21,7 +21,7 @@ See [collection documentation](../Documents/DocumentMethods.md) var examples = require("@arangodb/graph-examples/example-graph.js"); var graph = examples.loadGraph("social"); graph.relation.save("female/alice", "female/diana", {type: "knows", _key: "aliceAndDiana"}); - graph.relation.update("relation/aliceAndDiana", {type: "quarrelled", _key: "aliceAndDiana"}); + graph.relation.update("relation/aliceAndDiana", {type: "quarreled", _key: "aliceAndDiana"}); ~ examples.dropGraph("social"); @END_EXAMPLE_ARANGOSH_OUTPUT diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md index 9428bae0f7..af81cb1b0a 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md @@ -1,162 +1,231 @@ -@startDocuBlock REST_DOCUMENT_CREATE -@brief creates a document - -@RESTHEADER{POST /_api/document,Create document} - -@RESTALLBODYPARAM{document,json,required} -A JSON representation of the document. - -@RESTQUERYPARAMETERS - -@RESTQUERYPARAM{collection,string,required} -The collection name. - -@RESTQUERYPARAM{waitForSync,boolean,optional} -Wait until document has been synced to disk. - -@RESTDESCRIPTION -Creates a new document in the collection named *collection*. A JSON -representation of the document must be passed as the body of the POST -request. - -If the document was created successfully, then the "Location" header -contains the path to the newly created document. The "ETag" header field -contains the revision of the document. - -The body of the response contains a JSON object with the following -attributes: - -- *_id* contains the document handle of the newly created document -- *_key* contains the document key -- *_rev* contains the document revision - -If the collection parameter *waitForSync* is *false*, then the call returns -as soon as the document has been accepted. It will not wait until the -document has been synced to disk. - -Optionally, the query parameter *waitForSync* can be used to force -synchronization of the document creation operation to disk even in case that -the *waitForSync* flag had been disabled for the entire collection. Thus, -the *waitForSync* query parameter can be used to force synchronization of just -this specific operations. To use this, set the *waitForSync* parameter to -*true*. If the *waitForSync* parameter is not specified or set to *false*, -then the collection's default *waitForSync* behavior is applied. The -*waitForSync* query parameter cannot be used to disable synchronization for -collections that have a default *waitForSync* value of *true*. - -@RESTRETURNCODES - -@RESTRETURNCODE{201} -is returned if the document was created successfully and *waitForSync* was -*true*. - -@RESTRETURNCODE{202} -is returned if the document was created successfully and *waitForSync* was -*false*. - -@RESTRETURNCODE{400} -is returned if the body does not contain a valid JSON representation of a -document. The response body contains an error document in this case. - -@RESTRETURNCODE{404} -is returned if the collection specified by *collection* is unknown. The -response body contains an error document in this case. - -@RESTRETURNCODE{409} -is returned if a document with the same qualifiers in -an indexed attribute conflicts with an already existing document -and thus violating that uniq constraint. -The response body contains an error document in this case. - -@EXAMPLES - -Create a document in a collection named *products*. Note that the -revision identifier might or might not by equal to the auto-generated -key. - -@EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostCreate1} - var cn = "products"; - db._drop(cn); - db._create(cn, { waitForSync: true }); - - var url = "/_api/document?collection=" + cn; - var body = '{ "Hello": "World" }'; - - var response = logCurlRequest('POST', url, body); - - assert(response.code === 201); - - logJsonResponse(response); - ~ db._drop(cn); -@END_EXAMPLE_ARANGOSH_RUN - -Create a document in a collection named *products* with a collection-level -*waitForSync* value of *false*. - -@EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostAccept1} - var cn = "products"; - db._drop(cn); - db._create(cn, { waitForSync: false }); - - var url = "/_api/document?collection=" + cn; - var body = '{ "Hello": "World" }'; - - var response = logCurlRequest('POST', url, body); - - assert(response.code === 202); - - logJsonResponse(response); - ~ db._drop(cn); -@END_EXAMPLE_ARANGOSH_RUN - -Create a document in a collection with a collection-level *waitForSync* -value of *false*, but using the *waitForSync* query parameter. - -@EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostWait1} - var cn = "products"; - db._drop(cn); - db._create(cn, { waitForSync: false }); - - var url = "/_api/document?collection=" + cn + "&waitForSync=true"; - var body = '{ "Hello": "World" }'; - - var response = logCurlRequest('POST', url, body); - - assert(response.code === 201); - - logJsonResponse(response); - ~ db._drop(cn); -@END_EXAMPLE_ARANGOSH_RUN - -Unknown collection name - -@EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostUnknownCollection1} - var cn = "products"; - db._drop(cn); - - var url = "/_api/document?collection=" + cn; - var body = '{ "Hello": "World" }'; - - var response = logCurlRequest('POST', url, body); - - assert(response.code === 404); - - logJsonResponse(response); -@END_EXAMPLE_ARANGOSH_RUN - -Illegal document - -@EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostBadJson1} - var cn = "products"; - db._drop(cn); - - var url = "/_api/document?collection=" + cn; - var body = '{ 1: "World" }'; - - var response = logCurlRequest('POST', url, body); - - assert(response.code === 400); - - logJsonResponse(response); -@END_EXAMPLE_ARANGOSH_RUN -@endDocuBlock +//////////////////////////////////////////////////////////////////////////////// +/// @startDocuBlock REST_DOCUMENT_CREATE +/// @brief creates documents +/// +/// @RESTHEADER{POST /_api/document/{collection},Create document} +/// +/// @RESTALLBODYPARAM{data,json,required} +/// A JSON representation of a single document or of an array of documents. +/// +/// @RESTQUERYPARAMETERS +/// +/// @RESTQUERYPARAM{collection,string,optional} +/// The name of the collection. This is only for backward compatibility. +/// In ArangoDB versions < 3.0, the URL path was */_api/document* and +/// this query parameter was required. This combination still works, but +/// the recommended way is to specify the collection in the URL path. +/// +/// @RESTQUERYPARAM{waitForSync,boolean,optional} +/// Wait until document has been synced to disk. +/// +/// @RESTQUERYPARAM{returnNew,boolean,optional} +/// Return additionally the complete new document under the attribute *new* +/// in the result. +/// +/// @RESTDESCRIPTION +/// Creates a new document from the document given in the body, unless there +/// is already a document with the *_key* given. If no *_key* is given, a new +/// unique *_key* is generated automatically. +/// +/// The body can be an array of documents, in which case all +/// documents in the array are inserted with the same semantics as for a +/// single document. The result body will contain a JSON array of the +/// same length as the input array, and each entry contains the result +/// of the operation for the corresponding input. In case of an error +/// the entry is a document with attributes *error* set to *true* and +/// errorCode set to the error code that has happened. +/// +/// Possibly given *_id* and *_rev* attributes in the body are always ignored, +/// the URL part or the query parameter collection respectively counts. +/// +/// If the document was created successfully, then the *Location* header +/// contains the path to the newly created document. The *ETag* header field +/// contains the revision of the document. Both are only set in the single +/// document case. +/// +/// The body of the response contains a JSON object (single document case) +/// with the following attributes: +/// +/// - *_id* contains the document handle of the newly created document +/// - *_key* contains the document key +/// - *_rev* contains the document revision +/// +/// In the multi case the body is an array of such objects. +/// +/// If the collection parameter *waitForSync* is *false*, then the call +/// returns as soon as the document has been accepted. It will not wait +/// until the documents have been synced to disk. +/// +/// Optionally, the query parameter *waitForSync* can be used to force +/// synchronization of the document creation operation to disk even in +/// case that the *waitForSync* flag had been disabled for the entire +/// collection. Thus, the *waitForSync* query parameter can be used to +/// force synchronization of just this specific operations. To use this, +/// set the *waitForSync* parameter to *true*. If the *waitForSync* +/// parameter is not specified or set to *false*, then the collection's +/// default *waitForSync* behavior is applied. The *waitForSync* query +/// parameter cannot be used to disable synchronization for collections +/// that have a default *waitForSync* value of *true*. +/// +/// If the query parameter *returnNew* is *true*, then, for each +/// generated document, the complete new document is returned under +/// the *new* attribute in the result. +/// +/// @RESTRETURNCODES +/// +/// @RESTRETURNCODE{201} +/// is returned if the documents were created successfully and +/// *waitForSync* was *true*. +/// +/// @RESTRETURNCODE{202} +/// is returned if the documents were created successfully and +/// *waitForSync* was *false*. +/// +/// @RESTRETURNCODE{400} +/// is returned if the body does not contain a valid JSON representation +/// of one document or an array of documents. The response body contains +/// an error document in this case. +/// +/// @RESTRETURNCODE{404} +/// is returned if the collection specified by *collection* is unknown. +/// The response body contains an error document in this case. +/// +/// @RESTRETURNCODE{409} +/// is returned in the single document case if a document with the +/// same qualifiers in an indexed attribute conflicts with an already +/// existing document and thus violates that unique constraint. The +/// response body contains an error document in this case. In the array +/// case only 201 or 202 is returned, but if an error occurred, the +/// additional HTTP header *X-Arango-Error-Codes* is set, which +/// contains a map of the error codes that occurred together with their +/// multiplicities, as in: *1205:10,1210:17* which means that in 10 +/// cases the error 1205 "illegal document handle" and in 17 cases the +/// error 1210 "unique constraint violated" has happened. +/// +/// @EXAMPLES +/// +/// Create a document in a collection named *products*. Note that the +/// revision identifier might or might not by equal to the auto-generated +/// key. +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostCreate1} +/// var cn = "products"; +/// db._drop(cn); +/// db._create(cn, { waitForSync: true }); +/// +/// var url = "/_api/document/" + cn; +/// var body = '{ "Hello": "World" }'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 201); +/// +/// logJsonResponse(response); +/// ~ db._drop(cn); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Create a document in a collection named *products* with a collection-level +/// *waitForSync* value of *false*. +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostAccept1} +/// var cn = "products"; +/// db._drop(cn); +/// db._create(cn, { waitForSync: false }); +/// +/// var url = "/_api/document/" + cn; +/// var body = '{ "Hello": "World" }'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 202); +/// +/// logJsonResponse(response); +/// ~ db._drop(cn); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Create a document in a collection with a collection-level *waitForSync* +/// value of *false*, but using the *waitForSync* query parameter. +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostWait1} +/// var cn = "products"; +/// db._drop(cn); +/// db._create(cn, { waitForSync: false }); +/// +/// var url = "/_api/document/" + cn + "&waitForSync=true"; +/// var body = '{ "Hello": "World" }'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 201); +/// +/// logJsonResponse(response); +/// ~ db._drop(cn); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Unknown collection name +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostUnknownCollection1} +/// var cn = "products"; +/// db._drop(cn); +/// +/// var url = "/_api/document/" + cn; +/// var body = '{ "Hello": "World" }'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 404); +/// +/// logJsonResponse(response); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Illegal document +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostBadJson1} +/// var cn = "products"; +/// db._drop(cn); +/// +/// var url = "/_api/document/" + cn; +/// var body = '{ 1: "World" }'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 400); +/// +/// logJsonResponse(response); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Insert multiple documents: +/// TODO, make this example work. +/// +/// @ EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostMulti} +/// var cn = "products"; +/// db._drop(cn); +/// +/// var url = "/_api/document/" + cn; +/// var body = '[{"Hello":"Earth"}, {"Hello":"Venus"}, {"Hello":"Mars"}]'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 200); +/// +/// logJsonResponse(response); +/// @ END_EXAMPLE_ARANGOSH_RUN +/// +/// Use of returnNew: +/// TODO, make this example work. +/// +/// @ EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostMulti} +/// var cn = "products"; +/// db._drop(cn); +/// +/// var url = "/_api/document/" + cn + "?returnNew=true"; +/// var body = '{"Hello":"World"}'; +/// +/// var response = logCurlRequest('POST', url, body); +/// +/// assert(response.code === 200); +/// +/// logJsonResponse(response); +/// @ END_EXAMPLE_ARANGOSH_RUN +/// @endDocuBlock +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md index d844089ec6..c1985cda11 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md @@ -11,18 +11,13 @@ /// /// @RESTQUERYPARAMETERS /// -/// @RESTQUERYPARAM{rev,string,optional} -/// You can conditionally remove a document based on a target revision id by -/// using the *rev* query parameter. -/// -/// @RESTQUERYPARAM{policy,string,optional} -/// To control the update behavior in case there is a revision mismatch, you -/// can use the *policy* parameter. This is the same as when replacing -/// documents (see replacing documents for more details). -/// /// @RESTQUERYPARAM{waitForSync,boolean,optional} /// Wait until deletion operation has been synced to disk. /// +/// @RESTQUERYPARAM{returnOld,boolean,optional} +/// Return additionally the complete previous revision of the changed +/// document under the attribute *old* in the result. +/// /// @RESTHEADERPARAMETERS /// /// @RESTHEADERPARAM{If-Match,string,optional} @@ -30,27 +25,31 @@ /// using the *if-match* HTTP header. /// /// @RESTDESCRIPTION -/// The body of the response contains a JSON object with the information about -/// the handle and the revision. The attribute *_id* contains the known -/// *document-handle* of the removed document, *_key* contains the key which -/// uniquely identifies a document in a given collection, and the attribute *_rev* -/// contains the new document revision. +/// The body of the response contains a JSON object with the information +/// about the handle and the revision. The attribute *_id* contains the +/// known *document-handle* of the removed document, *_key* contains the +/// key which uniquely identifies a document in a given collection, and +/// the attribute *_rev* contains the document revision. /// -/// If the *waitForSync* parameter is not specified or set to -/// *false*, then the collection's default *waitForSync* behavior is -/// applied. The *waitForSync* query parameter cannot be used to disable -/// synchronization for collections that have a default *waitForSync* value -/// of *true*. +/// If the *waitForSync* parameter is not specified or set to *false*, +/// then the collection's default *waitForSync* behavior is applied. +/// The *waitForSync* query parameter cannot be used to disable +/// synchronization for collections that have a default *waitForSync* +/// value of *true*. +/// +/// If the query parameter *returnOld* is *true*, then +/// the complete previous revision of the document +/// is returned under the *old* attribute in the result. /// /// @RESTRETURNCODES /// /// @RESTRETURNCODE{200} -/// is returned if the document was removed successfully and *waitForSync* was -/// *true*. +/// is returned if the document was removed successfully and +/// *waitForSync* was *true*. /// /// @RESTRETURNCODE{202} -/// is returned if the document was removed successfully and *waitForSync* was -/// *false*. +/// is returned if the document was removed successfully and +/// *waitForSync* was *false*. /// /// @RESTRETURNCODE{404} /// is returned if the collection or the document was not found. @@ -121,4 +120,4 @@ /// ~ db._drop(cn); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md new file mode 100644 index 0000000000..32796d0066 --- /dev/null +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md @@ -0,0 +1,138 @@ +//////////////////////////////////////////////////////////////////////////////// +/// @startDocuBlock REST_DOCUMENT_DELETE_MULTI +/// @brief removes multiple document +/// +/// @RESTHEADER{DELETE /_api/document/{collection},Removes multiple documents} +/// +/// @RESTALLBODYPARAM{array,json,required} +/// A JSON array of strings or documents. +/// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{collection,string,required} +/// Collection from which documents are removed. +/// +/// @RESTURLPARAMETERS +/// +/// @RESTQUERYPARAMETERS +/// +/// @RESTQUERYPARAM{waitForSync,boolean,optional} +/// Wait until deletion operation has been synced to disk. +/// +/// @RESTQUERYPARAM{returnOld,boolean,optional} +/// Return additionally the complete previous revision of the changed +/// document under the attribute *old* in the result. +/// +/// @RESTQUERYPARAM{ignoreRevs,boolean,optional} +/// If set to *true*, ignore any *_rev* attribute in the selectors. No +/// revision check is performed. +/// +/// @RESTDESCRIPTION +/// The body of the request is an array consisting of selectors for +/// documents. A selector can either be a string with a key or a string +/// with a document handle or an object with a *_key* attribute. This +/// API call removes all specified documents from *collection*. If the +/// selector is an object and has a *_rev* attribute, it is a +/// precondition that the actual revision of the removed document in the +/// collection is the specified one. +/// +/// The body of the response is an array of the same length as the input +/// array. For each input selector, the output contains a JSON object +/// with the information about the outcome of the operation. If no error +/// occurred, an object is built in which the attribute *_id* contains +/// the known *document-handle* of the removed document, *_key* contains +/// the key which uniquely identifies a document in a given collection, +/// and the attribute *_rev* contains the document revision. In case of +/// an error, an object with the attribute *error* set to *true* and +/// *errorCode* set to the error code is built. +/// +/// If the *waitForSync* parameter is not specified or set to *false*, +/// then the collection's default *waitForSync* behavior is applied. +/// The *waitForSync* query parameter cannot be used to disable +/// synchronization for collections that have a default *waitForSync* +/// value of *true*. +/// +/// If the query parameter *returnOld* is *true*, then +/// the complete previous revision of the document +/// is returned under the *old* attribute in the result. +/// +/// Note that if any precondition is violated or an error occurred with +/// some of the documents, the return code is still 200 or 202, but +/// the additional HTTP header *X-Arango-Error-Codes* is set, which +/// contains a map of the error codes that occurred together with their +/// multiplicities, as in: *1200:17,1205:10* which means that in 17 +/// cases the error 1200 "revision conflict" and in 10 cases the error +/// 1205 "illegal document handle" has happened. +/// +/// @RESTRETURNCODES +/// +/// @RESTRETURNCODE{200} +/// is returned if *waitForSync* was *true*. +/// +/// @RESTRETURNCODE{202} +/// is returned if *waitForSync* was *false*. +/// +/// @RESTRETURNCODE{404} +/// is returned if the collection was not found. +/// The response body contains an error document in this case. +/// +/// @EXAMPLES +/// +/// Using document handle: +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerDeleteDocument} +/// var cn = "products"; +/// db._drop(cn); +/// db._create(cn, { waitForSync: true }); +/// var document = db.products.save({"hello":"world"}); +/// +/// var url = "/_api/document/" + document._id; +/// +/// var response = logCurlRequest('DELETE', url); +/// +/// assert(response.code === 200); +/// +/// logJsonResponse(response); +/// ~ db._drop(cn); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Unknown document handle: +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerDeleteDocumentUnknownHandle} +/// var cn = "products"; +/// db._drop(cn); +/// db._create(cn, { waitForSync: true }); +/// var document = db.products.save({"hello":"world"}); +/// db.products.remove(document._id); +/// +/// var url = "/_api/document/" + document._id; +/// +/// var response = logCurlRequest('DELETE', url); +/// +/// assert(response.code === 404); +/// +/// logJsonResponse(response); +/// ~ db._drop(cn); +/// @END_EXAMPLE_ARANGOSH_RUN +/// +/// Revision conflict: +/// +/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerDeleteDocumentIfMatchOther} +/// var cn = "products"; +/// db._drop(cn); +/// db._create(cn); +/// +/// var document = db.products.save({"hello":"world"}); +/// var document2 = db.products.save({"hello2":"world"}); +/// var url = "/_api/document/" + document._id; +/// var headers = {"If-Match": "\"" + document2._rev + "\""}; +/// +/// var response = logCurlRequest('DELETE', url, "", headers); +/// +/// assert(response.code === 412); +/// +/// logJsonResponse(response); +/// ~ db._drop(cn); +/// @END_EXAMPLE_ARANGOSH_RUN +/// @endDocuBlock +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md index 7ab7cd2bbf..3387482534 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md @@ -13,14 +13,13 @@ /// /// @RESTHEADERPARAM{If-None-Match,string,optional} /// If the "If-None-Match" header is given, then it must contain exactly one -/// etag. The document is returned, if it has a different revision than the -/// given etag. Otherwise an *HTTP 304* is returned. +/// ETag. The document is returned, if it has a different revision than the +/// given ETag. Otherwise an *HTTP 304* is returned. /// /// @RESTHEADERPARAM{If-Match,string,optional} /// If the "If-Match" header is given, then it must contain exactly one -/// etag. The document is returned, if it has the same revision as the -/// given etag. Otherwise a *HTTP 412* is returned. As an alternative -/// you can supply the etag in an attribute *rev* in the URL. +/// ETag. The document is returned, if it has the same revision as the +/// given ETag. Otherwise a *HTTP 412* is returned. /// /// @RESTDESCRIPTION /// Returns the document identified by *document-handle*. The returned @@ -41,7 +40,7 @@ /// is returned if the document or collection was not found /// /// @RESTRETURNCODE{412} -/// is returned if a "If-Match" header or *rev* is given and the found +/// is returned if an "If-Match" header is given and the found /// document has a different version. The response will also contain the found /// document's current revision in the *_rev* attribute. Additionally, the /// attributes *_id* and *_key* will be returned. @@ -95,4 +94,4 @@ /// logJsonResponse(response); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md index e9097dcda8..a31ca76040 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md @@ -2,19 +2,22 @@ /// @startDocuBlock REST_DOCUMENT_READ_ALL /// @brief reads all documents from collection /// -/// @RESTHEADER{GET /_api/document,Read all documents} +/// @RESTHEADER{GET /_api/document/{collection},Read all documents} /// /// @RESTQUERYPARAMETERS /// -/// @RESTQUERYPARAM{collection,string,required} -/// The name of the collection. +/// @RESTQUERYPARAM{collection,string,optional} +/// The name of the collection. This is only for backward compatibility. +/// In ArangoDB versions < 3.0, the URL path was */_api/document* and +/// this query parameter was required. This combination still works, but +/// the recommended way is to specify the collection in the URL path. /// /// @RESTQUERYPARAM{type,string,optional} /// The type of the result. The following values are allowed: /// -/// - *id*: returns an array of document ids (*_id* attributes) -/// - *key*: returns an array of document keys (*_key* attributes) -/// - *path*: returns an array of document URI paths. This is the default. +/// - *id*: returns an array of document ids (*_id* attributes) +/// - *key*: returns an array of document keys (*_key* attributes) +/// - *path*: returns an array of document URI paths. This is the default. /// /// @RESTDESCRIPTION /// Returns an array of all keys, ids, or URI paths for all documents in the @@ -27,7 +30,7 @@ /// @RESTRETURNCODES /// /// @RESTRETURNCODE{200} -/// All went good. +/// All went well. /// /// @RESTRETURNCODE{404} /// The collection does not exist. @@ -44,7 +47,7 @@ /// db.products.save({"hello1":"world1"}); /// db.products.save({"hello2":"world1"}); /// db.products.save({"hello3":"world1"}); -/// var url = "/_api/document/?collection=" + cn; +/// var url = "/_api/document/" + cn; /// /// var response = logCurlRequest('GET', url); /// @@ -64,7 +67,7 @@ /// db.products.save({"hello1":"world1"}); /// db.products.save({"hello2":"world1"}); /// db.products.save({"hello3":"world1"}); -/// var url = "/_api/document/?collection=" + cn + "&type=key"; +/// var url = "/_api/document/" + cn + "&type=key"; /// /// var response = logCurlRequest('GET', url); /// @@ -79,7 +82,7 @@ /// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerReadDocumentAllCollectionDoesNotExist} /// var cn = "doesnotexist"; /// db._drop(cn); -/// var url = "/_api/document/?collection=" + cn; +/// var url = "/_api/document/" + cn; /// /// var response = logCurlRequest('GET', url); /// @@ -88,4 +91,4 @@ /// logJsonResponse(response); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md index b6aa4feedf..bb69942353 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md @@ -9,23 +9,18 @@ /// @RESTURLPARAM{document-handle,string,required} /// The handle of the document. /// -/// @RESTQUERYPARAMETERS -/// -/// @RESTQUERYPARAM{rev,string,optional} -/// You can conditionally fetch a document based on a target revision id by -/// using the *rev* query parameter. -/// /// @RESTHEADERPARAMETERS /// /// @RESTHEADERPARAM{If-None-Match,string,optional} /// If the "If-None-Match" header is given, then it must contain exactly one -/// etag. If the current document revision is different to the specified etag, +/// ETag. If the current document revision is not equal to the specified ETag, /// an *HTTP 200* response is returned. If the current document revision is -/// identical to the specified etag, then an *HTTP 304* is returned. +/// identical to the specified ETag, then an *HTTP 304* is returned. /// /// @RESTHEADERPARAM{If-Match,string,optional} -/// You can conditionally fetch a document based on a target revision id by -/// using the *if-match* HTTP header. +/// If the "If-Match" header is given, then it must contain exactly one +/// ETag. The document is returned, if it has the same revision as the +/// given ETag. Otherwise a *HTTP 412* is returned. /// /// @RESTDESCRIPTION /// Like *GET*, but only returns the header fields and not the body. You @@ -39,15 +34,15 @@ /// /// @RESTRETURNCODE{304} /// is returned if the "If-None-Match" header is given and the document has -/// same version -///* +/// the same version +/// /// @RESTRETURNCODE{404} /// is returned if the document or collection was not found /// /// @RESTRETURNCODE{412} -/// is returned if a "If-Match" header or *rev* is given and the found +/// is returned if an "If-Match" header is given and the found /// document has a different version. The response will also contain the found -/// document's current revision in the *etag* header. +/// document's current revision in the *ETag* header. /// /// @EXAMPLES /// @@ -66,4 +61,4 @@ /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md index 08a4e3defb..156f6c9f1c 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md @@ -5,25 +5,32 @@ /// @RESTHEADER{PUT /_api/document/{document-handle},Replace document} /// /// @RESTALLBODYPARAM{document,json,required} -/// A JSON representation of the new document. +/// A JSON representation of a single document. /// /// @RESTURLPARAMETERS /// /// @RESTURLPARAM{document-handle,string,required} -/// The handle of the document. +/// This URL parameter must be a document handle. /// /// @RESTQUERYPARAMETERS /// /// @RESTQUERYPARAM{waitForSync,boolean,optional} /// Wait until document has been synced to disk. /// -/// @RESTQUERYPARAM{rev,string,optional} -/// You can conditionally replace a document based on a target revision id by -/// using the *rev* query parameter. +/// @RESTQUERYPARAM{ignoreRevs,boolean,optional} +/// By default, or if this is set to *true*, the *_rev* attributes in +/// the given document is ignored. If this is set to *false*, then +/// the *_rev* attribute given in the body document is taken as a +/// precondition. The document is only replaced if the current revision +/// is the one specified. /// -/// @RESTQUERYPARAM{policy,string,optional} -/// To control the update behavior in case there is a revision mismatch, you -/// can use the *policy* parameter (see below). +/// @RESTQUERYPARAM{returnOld,boolean,optional} +/// Return additionally the complete previous revision of the changed +/// document under the attribute *old* in the result. +/// +/// @RESTQUERYPARAM{returnNew,boolean,optional} +/// Return additionally the complete new document under the attribute *new* +/// in the result. /// /// @RESTHEADERPARAMETERS /// @@ -32,15 +39,26 @@ /// using the *if-match* HTTP header. /// /// @RESTDESCRIPTION -/// Completely updates (i.e. replaces) the document identified by *document-handle*. -/// If the document exists and can be updated, then a *HTTP 201* is returned -/// and the "ETag" header field contains the new revision of the document. +/// Replaces the document with handle with the one in +/// the body, provided there is such a document and no precondition is +/// violated. /// -/// If the new document passed in the body of the request contains the -/// *document-handle* in the attribute *_id* and the revision in *_rev*, -/// these attributes will be ignored. Only the URI and the "ETag" header are -/// relevant in order to avoid confusion when using proxies. +/// If the *If-Match* header is specified and the revision of the +/// document in the database is unequal to the given revision, the +/// precondition is violated. /// +/// If *If-Match* is not given and *ignoreRevs* is *false* and there +/// is a *_rev* attribute in the body and its value does not match +/// the revision of the document in the database, the precondition is +/// violated. +/// +/// If a precondition is violated, an *HTTP 412* is returned. +/// +/// If the document exists and can be updated, then an *HTTP 201* or +/// an *HTTP 202* is returned (depending on *waitForSync*, see below), +/// the *ETag* header field contains the new revision of the document +/// and the *Location* header contains a complete URL under which the +/// document can be queried. /// /// Optionally, the query parameter *waitForSync* can be used to force /// synchronization of the document replacement operation to disk even in case @@ -53,82 +71,46 @@ /// synchronization for collections that have a default *waitForSync* value /// of *true*. /// +/// The body of the response contains a JSON object with the information +/// about the handle and the revision. The attribute *_id* contains the +/// known *document-handle* of the updated document, *_key* contains the +/// key which uniquely identifies a document in a given collection, and +/// the attribute *_rev* contains the new document revision. /// -/// The body of the response contains a JSON object with the information about -/// the handle and the revision. The attribute *_id* contains the known -/// *document-handle* of the updated document, *_key* contains the key which -/// uniquely identifies a document in a given collection, and the attribute *_rev* -/// contains the new document revision. +/// If the query parameter *returnOld* is *true*, then +/// the complete previous revision of the document +/// is returned under the *old* attribute in the result. +/// +/// If the query parameter *returnNew* is *true*, then +/// the complete new document is returned under +/// the *new* attribute in the result. /// /// If the document does not exist, then a *HTTP 404* is returned and the /// body of the response contains an error document. /// -/// There are two ways for specifying the targeted document revision id for -/// conditional replacements (i.e. replacements that will only be executed if -/// the revision id found in the database matches the document revision id specified -/// in the request): -/// - specifying the target revision in the *rev* URL query parameter -/// - specifying the target revision in the *if-match* HTTP header -/// -/// -/// Specifying a target revision is optional, however, if done, only one of the -/// described mechanisms must be used (either the *rev* query parameter or the -/// *if-match* HTTP header). -/// Regardless which mechanism is used, the parameter needs to contain the target -/// document revision id as returned in the *_rev* attribute of a document or -/// by an HTTP *etag* header. -/// -/// For example, to conditionally replace a document based on a specific revision -/// id, you can use the following request: -/// -/// -/// `PUT /_api/document/document-handle?rev=etag` -/// -/// -/// If a target revision id is provided in the request (e.g. via the *etag* value -/// in the *rev* URL query parameter above), ArangoDB will check that -/// the revision id of the document found in the database is equal to the target -/// revision id provided in the request. If there is a mismatch between the revision -/// id, then by default a *HTTP 412* conflict is returned and no replacement is -/// performed. -/// -/// -/// The conditional update behavior can be overridden with the *policy* URL query parameter: -/// -/// -/// `PUT /_api/document/document-handle?policy=policy` -/// -/// -/// If *policy* is set to *error*, then the behavior is as before: replacements -/// will fail if the revision id found in the database does not match the target -/// revision id specified in the request. -/// -/// If *policy* is set to *last*, then the replacement will succeed, even if the -/// revision id found in the database does not match the target revision id specified -/// in the request. You can use the *last* *policy* to force replacements. -/// /// @RESTRETURNCODES /// /// @RESTRETURNCODE{201} -/// is returned if the document was replaced successfully and *waitForSync* was -/// *true*. +/// is returned if the document was replaced successfully and +/// *waitForSync* was *true*. /// /// @RESTRETURNCODE{202} -/// is returned if the document was replaced successfully and *waitForSync* was -/// *false*. +/// is returned if the document was replaced successfully and +/// *waitForSync* was *false*. /// /// @RESTRETURNCODE{400} -/// is returned if the body does not contain a valid JSON representation of a -/// document. The response body contains an error document in this case. +/// is returned if the body does not contain a valid JSON representation +/// of a document. The response body contains +/// an error document in this case. /// /// @RESTRETURNCODE{404} -/// is returned if the collection or the document was not found +/// is returned if the collection or the document was not found. /// /// @RESTRETURNCODE{412} -/// is returned if a "If-Match" header or *rev* is given and the found -/// document has a different version. The response will also contain the found -/// document's current revision in the *_rev* attribute. Additionally, the -/// attributes *_id* and *_key* will be returned. +/// is returned if the precondition was violated. The response will +/// also contain the found documents' current revisions in the *_rev* +/// attributes. Additionally, the attributes *_id* and *_key* will be +/// returned. /// /// @EXAMPLES /// @@ -188,43 +170,5 @@ /// logJsonResponse(response); /// ~ db._drop(cn); /// @END_EXAMPLE_ARANGOSH_RUN -/// -/// Last write wins -/// -/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerUpdateDocumentIfMatchOtherLastWriteWins} -/// var cn = "products"; -/// db._drop(cn); -/// db._create(cn); -/// -/// var document = db.products.save({"hello":"world"}); -/// var document2 = db.products.replace(document._id,{"other":"content"}); -/// var url = "/_api/document/products/" + document._rev + "?policy=last"; -/// var headers = {"If-Match": "\"" + document2._rev + "\""}; -/// -/// var response = logCurlRequest('PUT', url, "{}", headers); -/// assert(response.code === 202); -/// -/// logJsonResponse(response); -/// ~ db._drop(cn); -/// @END_EXAMPLE_ARANGOSH_RUN -/// -/// Alternative to header fields -/// -/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerUpdateDocumentRevOther} -/// var cn = "products"; -/// db._drop(cn); -/// db._create(cn); -/// -/// var document = db.products.save({"hello":"world"}); -/// var document2 = db.products.save({"hello2":"world"}); -/// var url = "/_api/document/" + document._id + "?rev=" + document2._rev; -/// -/// var response = logCurlRequest('PUT', url, '{"other":"content"}'); -/// -/// assert(response.code === 412); -/// -/// logJsonResponse(response); -/// ~ db._drop(cn); -/// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md new file mode 100644 index 0000000000..4abc12b10e --- /dev/null +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md @@ -0,0 +1,105 @@ +//////////////////////////////////////////////////////////////////////////////// +/// @startDocuBlock REST_DOCUMENT_REPLACE_MULTI +/// @brief replaces multiple documents +/// +/// @RESTHEADER{PUT /_api/document/{collection},Replace documents} +/// +/// @RESTALLBODYPARAM{documents,json,required} +/// A JSON representation of an array of documents. +/// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{collection,string,required} +/// This URL parameter is the name of the collection in which the +/// documents are replaced. +/// +/// @RESTQUERYPARAMETERS +/// +/// @RESTQUERYPARAM{waitForSync,boolean,optional} +/// Wait until the new documents have been synced to disk. +/// +/// @RESTQUERYPARAM{ignoreRevs,boolean,optional} +/// By default, or if this is set to *true*, the *_rev* attributes in +/// the given documents are ignored. If this is set to *false*, then +/// any *_rev* attribute given in a body document is taken as a +/// precondition. The document is only replaced if the current revision +/// is the one specified. +/// +/// @RESTQUERYPARAM{returnOld,boolean,optional} +/// Return additionally the complete previous revision of the changed +/// documents under the attribute *old* in the result. +/// +/// @RESTQUERYPARAM{returnNew,boolean,optional} +/// Return additionally the complete new documents under the attribute *new* +/// in the result. +/// +/// @RESTDESCRIPTION +/// Replaces multiple documents in the specified collection with the +/// ones in the body, the replaced documents are specified by the *_key* +/// attributes in the body documents. +/// +/// If *ignoreRevs* is *false* and there is a *_rev* attribute in a +/// document in the body and its value does not match the revision of +/// the corresponding document in the database, the precondition is +/// violated. +/// +/// If the document exists and can be updated, then an *HTTP 201* or +/// an *HTTP 202* is returned (depending on *waitForSync*, see below). +/// +/// Optionally, the query parameter *waitForSync* can be used to force +/// synchronization of the document replacement operation to disk even in case +/// that the *waitForSync* flag had been disabled for the entire collection. +/// Thus, the *waitForSync* query parameter can be used to force synchronization +/// of just specific operations. To use this, set the *waitForSync* parameter +/// to *true*. If the *waitForSync* parameter is not specified or set to +/// *false*, then the collection's default *waitForSync* behavior is +/// applied. The *waitForSync* query parameter cannot be used to disable +/// synchronization for collections that have a default *waitForSync* value +/// of *true*. +/// +/// The body of the response contains a JSON array of the same length +/// as the input array with the information about the handle and the +/// revision of the replaced documents. In each entry, the attribute +/// *_id* contains the known *document-handle* of each updated document, +/// *_key* contains the key which uniquely identifies a document in a +/// given collection, and the attribute *_rev* contains the new document +/// revision. In case of an error or violated precondition, an error +/// object with the attribute *error* set to *true* and the attribute +/// *errorCode* set to the error code is built. +/// +/// If the query parameter *returnOld* is *true*, then, for each +/// generated document, the complete previous revision of the document +/// is returned under the *old* attribute in the result. +/// +/// If the query parameter *returnNew* is *true*, then, for each +/// generated document, the complete new document is returned under +/// the *new* attribute in the result. +/// +/// Note that if any precondition is violated or an error occurred with +/// some of the documents, the return code is still 201 or 202, but +/// the additional HTTP header *X-Arango-Error-Codes* is set, which +/// contains a map of the error codes that occurred together with their +/// multiplicities, as in: *1200:17,1205:10* which means that in 17 +/// cases the error 1200 "revision conflict" and in 10 cases the error +/// 1205 "illegal document handle" has happened. +/// +/// @RESTRETURNCODES +/// +/// @RESTRETURNCODE{201} +/// is returned if the documents were replaced successfully and +/// *waitForSync* was *true*. +/// +/// @RESTRETURNCODE{202} +/// is returned if the documents were replaced successfully and +/// *waitForSync* was *false*. +/// +/// @RESTRETURNCODE{400} +/// is returned if the body does not contain a valid JSON representation +/// of an array of documents. The response body contains +/// an error document in this case. +/// +/// @RESTRETURNCODE{404} +/// is returned if the collection was not found. +/// +/// @endDocuBlock +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md index 4c43ff8438..a58fb1fa91 100644 --- a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md @@ -2,60 +2,86 @@ /// @startDocuBlock REST_DOCUMENT_UPDATE /// @brief updates a document /// -/// @RESTHEADER{PATCH /_api/document/{document-handle}, Patch document} +/// @RESTHEADER{PATCH /_api/document/{document-handle},Update document} /// /// @RESTALLBODYPARAM{document,json,required} -/// A JSON representation of the document update. +/// A JSON representation of a document update as an object. /// /// @RESTURLPARAMETERS /// /// @RESTURLPARAM{document-handle,string,required} -/// The handle of the document. +/// This URL parameter must be a document handle. /// /// @RESTQUERYPARAMETERS /// /// @RESTQUERYPARAM{keepNull,boolean,optional} -/// If the intention is to delete existing attributes with the patch command, -/// the URL query parameter *keepNull* can be used with a value of *false*. -/// This will modify the behavior of the patch command to remove any attributes -/// from the existing document that are contained in the patch document with an -/// attribute value of *null*. +/// If the intention is to delete existing attributes with the patch +/// command, the URL query parameter *keepNull* can be used with a value +/// of *false*. This will modify the behavior of the patch command to +/// remove any attributes from the existing document that are contained +/// in the patch document with an attribute value of *null*. /// /// @RESTQUERYPARAM{mergeObjects,boolean,optional} -/// Controls whether objects (not arrays) will be merged if present in both the -/// existing and the patch document. If set to *false*, the value in the -/// patch document will overwrite the existing document's value. If set to -/// *true*, objects will be merged. The default is *true*. +/// Controls whether objects (not arrays) will be merged if present in +/// both the existing and the patch document. If set to *false*, the +/// value in the patch document will overwrite the existing document's +/// value. If set to *true*, objects will be merged. The default is +/// *true*. /// /// @RESTQUERYPARAM{waitForSync,boolean,optional} /// Wait until document has been synced to disk. /// -/// @RESTQUERYPARAM{rev,string,optional} -/// You can conditionally patch a document based on a target revision id by -/// using the *rev* query parameter. +/// @RESTQUERYPARAM{ignoreRevs,boolean,optional} +/// By default, or if this is set to *true*, the *_rev* attributes in +/// the given document is ignored. If this is set to *false*, then +/// the *_rev* attribute given in the body document is taken as a +/// precondition. The document is only updated if the current revision +/// is the one specified. /// -/// @RESTQUERYPARAM{policy,string,optional} -/// To control the update behavior in case there is a revision mismatch, you -/// can use the *policy* parameter. +/// @RESTQUERYPARAM{returnOld,boolean,optional} +/// Return additionally the complete previous revision of the changed +/// document under the attribute *old* in the result. +/// +/// @RESTQUERYPARAM{returnNew,boolean,optional} +/// Return additionally the complete new document under the attribute *new* +/// in the result. /// /// @RESTHEADERPARAMETERS /// /// @RESTHEADERPARAM{If-Match,string,optional} -/// You can conditionally patch a document based on a target revision id by +/// You can conditionally update a document based on a target revision id by /// using the *if-match* HTTP header. /// /// @RESTDESCRIPTION /// Partially updates the document identified by *document-handle*. -/// The body of the request must contain a JSON document with the attributes -/// to patch (the patch document). All attributes from the patch document will -/// be added to the existing document if they do not yet exist, and overwritten -/// in the existing document if they do exist there. +/// The body of the request must contain a JSON document with the +/// attributes to patch (the patch document). All attributes from the +/// patch document will be added to the existing document if they do not +/// yet exist, and overwritten in the existing document if they do exist +/// there. /// /// Setting an attribute value to *null* in the patch document will cause a -/// value of *null* be saved for the attribute by default. +/// value of *null* to be saved for the attribute by default. +/// +/// If the *If-Match* header is specified and the revision of the +/// document in the database is unequal to the given revision, the +/// precondition is violated. +/// +/// If *If-Match* is not given and *ignoreRevs* is *false* and there +/// is a *_rev* attribute in the body and its value does not match +/// the revision of the document in the database, the precondition is +/// violated. +/// +/// If a precondition is violated, an *HTTP 412* is returned. +/// +/// If the document exists and can be updated, then an *HTTP 201* or +/// an *HTTP 202* is returned (depending on *waitForSync*, see below), +/// the *ETag* header field contains the new revision of the document +/// and the *Location* header contains a complete URL under which the +/// document can be queried. /// /// Optionally, the query parameter *waitForSync* can be used to force -/// synchronization of the document update operation to disk even in case +/// synchronization of the updated document operation to disk even in case /// that the *waitForSync* flag had been disabled for the entire collection. /// Thus, the *waitForSync* query parameter can be used to force synchronization /// of just specific operations. To use this, set the *waitForSync* parameter @@ -65,47 +91,50 @@ /// synchronization for collections that have a default *waitForSync* value /// of *true*. /// -/// The body of the response contains a JSON object with the information about -/// the handle and the revision. The attribute *_id* contains the known -/// *document-handle* of the updated document, *_key* contains the key which -/// uniquely identifies a document in a given collection, and the attribute *_rev* -/// contains the new document revision. +/// The body of the response contains a JSON object with the information +/// about the handle and the revision. The attribute *_id* contains the +/// known *document-handle* of the updated document, *_key* contains the +/// key which uniquely identifies a document in a given collection, and +/// the attribute *_rev* contains the new document revision. +/// +/// If the query parameter *returnOld* is *true*, then +/// the complete previous revision of the document +/// is returned under the *old* attribute in the result. +/// +/// If the query parameter *returnNew* is *true*, then +/// the complete new document is returned under +/// the *new* attribute in the result. /// /// If the document does not exist, then a *HTTP 404* is returned and the /// body of the response contains an error document. /// -/// You can conditionally update a document based on a target revision id by -/// using either the *rev* query parameter or the *if-match* HTTP header. -/// To control the update behavior in case there is a revision mismatch, you -/// can use the *policy* parameter. This is the same as when replacing -/// documents (see replacing documents for details). -/// /// @RESTRETURNCODES /// /// @RESTRETURNCODE{201} -/// is returned if the document was created successfully and *waitForSync* was -/// *true*. +/// is returned if the document was updated successfully and +/// *waitForSync* was *true*. /// /// @RESTRETURNCODE{202} -/// is returned if the document was created successfully and *waitForSync* was -/// *false*. +/// is returned if the document was updated successfully and +/// *waitForSync* was *false*. /// /// @RESTRETURNCODE{400} -/// is returned if the body does not contain a valid JSON representation of a -/// document. The response body contains an error document in this case. +/// is returned if the body does not contain a valid JSON representation +/// of a document. The response body contains +/// an error document in this case. /// /// @RESTRETURNCODE{404} -/// is returned if the collection or the document was not found +/// is returned if the collection or the document was not found. /// /// @RESTRETURNCODE{412} -/// is returned if a "If-Match" header or *rev* is given and the found -/// document has a different version. The response will also contain the found -/// document's current revision in the *_rev* attribute. Additionally, the -/// attributes *_id* and *_key* will be returned. +/// is returned if the precondition was violated. The response will +/// also contain the found documents' current revisions in the *_rev* +/// attributes. Additionally, the attributes *_id* and *_key* will be +/// returned. /// /// @EXAMPLES /// -/// patches an existing document with new content. +/// Patches an existing document with new content. /// /// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPatchDocument} /// var cn = "products"; @@ -166,4 +195,4 @@ /// ~ db._drop(cn); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md new file mode 100644 index 0000000000..4b7e2b6360 --- /dev/null +++ b/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md @@ -0,0 +1,126 @@ +//////////////////////////////////////////////////////////////////////////////// +/// @startDocuBlock REST_DOCUMENT_UPDATE_MULTI +/// @brief updates multiple documents +/// +/// @RESTHEADER{PATCH /_api/document/{collection},Update documents} +/// +/// @RESTALLBODYPARAM{documents,json,required} +/// A JSON representation of an array of document updates as objects. +/// +/// @RESTURLPARAMETERS +/// +/// @RESTURLPARAM{collection,string,required} +/// This URL parameter is the name of the collection in which the +/// documents are updated. +/// +/// @RESTQUERYPARAMETERS +/// +/// @RESTQUERYPARAM{keepNull,boolean,optional} +/// If the intention is to delete existing attributes with the patch +/// command, the URL query parameter *keepNull* can be used with a value +/// of *false*. This will modify the behavior of the patch command to +/// remove any attributes from the existing document that are contained +/// in the patch document with an attribute value of *null*. +/// +/// @RESTQUERYPARAM{mergeObjects,boolean,optional} +/// Controls whether objects (not arrays) will be merged if present in +/// both the existing and the patch document. If set to *false*, the +/// value in the patch document will overwrite the existing document's +/// value. If set to *true*, objects will be merged. The default is +/// *true*. +/// +/// @RESTQUERYPARAM{waitForSync,boolean,optional} +/// Wait until the new documents have been synced to disk. +/// +/// @RESTQUERYPARAM{ignoreRevs,boolean,optional} +/// By default, or if this is set to *true*, the *_rev* attributes in +/// the given documents are ignored. If this is set to *false*, then +/// any *_rev* attribute given in a body document is taken as a +/// precondition. The document is only updated if the current revision +/// is the one specified. +/// +/// @RESTQUERYPARAM{returnOld,boolean,optional} +/// Return additionally the complete previous revision of the changed +/// documents under the attribute *old* in the result. +/// +/// @RESTQUERYPARAM{returnNew,boolean,optional} +/// Return additionally the complete new documents under the attribute *new* +/// in the result. +/// +/// @RESTDESCRIPTION +/// Partially updates documents, the documents to update are specified +/// by the *_key* attributes in the body objects. The body of the +/// request must contain a JSON array of document updates with the +/// attributes to patch (the patch documents). All attributes from the +/// patch documents will be added to the existing documents if they do +/// not yet exist, and overwritten in the existing documents if they do +/// exist there. +/// +/// Setting an attribute value to *null* in the patch documents will cause a +/// value of *null* to be saved for the attribute by default. +/// +/// If *ignoreRevs* is *false* and there is a *_rev* attribute in a +/// document in the body and its value does not match the revision of +/// the corresponding document in the database, the precondition is +/// violated. +/// +/// If the document exists and can be updated, then an *HTTP 201* or +/// an *HTTP 202* is returned (depending on *waitForSync*, see below). +/// +/// Optionally, the query parameter *waitForSync* can be used to force +/// synchronization of the document replacement operation to disk even in case +/// that the *waitForSync* flag had been disabled for the entire collection. +/// Thus, the *waitForSync* query parameter can be used to force synchronization +/// of just specific operations. To use this, set the *waitForSync* parameter +/// to *true*. If the *waitForSync* parameter is not specified or set to +/// *false*, then the collection's default *waitForSync* behavior is +/// applied. The *waitForSync* query parameter cannot be used to disable +/// synchronization for collections that have a default *waitForSync* value +/// of *true*. +/// +/// The body of the response contains a JSON array of the same length +/// as the input array with the information about the handle and the +/// revision of the updated documents. In each entry, the attribute +/// *_id* contains the known *document-handle* of each updated document, +/// *_key* contains the key which uniquely identifies a document in a +/// given collection, and the attribute *_rev* contains the new document +/// revision. In case of an error or violated precondition, an error +/// object with the attribute *error* set to *true* and the attribute +/// *errorCode* set to the error code is built. +/// +/// If the query parameter *returnOld* is *true*, then, for each +/// generated document, the complete previous revision of the document +/// is returned under the *old* attribute in the result. +/// +/// If the query parameter *returnNew* is *true*, then, for each +/// generated document, the complete new document is returned under +/// the *new* attribute in the result. +/// +/// Note that if any precondition is violated or an error occurred with +/// some of the documents, the return code is still 201 or 202, but +/// the additional HTTP header *X-Arango-Error-Codes* is set, which +/// contains a map of the error codes that occurred together with their +/// multiplicities, as in: *1200:17,1205:10* which means that in 17 +/// cases the error 1200 "revision conflict" and in 10 cases the error +/// 1205 "illegal document handle" has happened. +/// +/// @RESTRETURNCODES +/// +/// @RESTRETURNCODE{201} +/// is returned if the documents were updated successfully and +/// *waitForSync* was *true*. +/// +/// @RESTRETURNCODE{202} +/// is returned if the documents were updated successfully and +/// *waitForSync* was *false*. +/// +/// @RESTRETURNCODE{400} +/// is returned if the body does not contain a valid JSON representation +/// of an array of documents. The response body contains +/// an error document in this case. +/// +/// @RESTRETURNCODE{404} +/// is returned if the collection was not found. +/// +/// @endDocuBlock +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md b/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md index c2d504cf4a..0859ec11ff 100644 --- a/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md +++ b/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md @@ -13,7 +13,7 @@ /// @RESTBODYPARAM{options,object,optional,put_api_simple_remove_by_example_opts} /// a json object which can contains following attributes: /// -/// @RESTSTRUCT{waitForSync,put_api_simple_remove_by_example_opts,string,optional,string} +/// @RESTSTRUCT{waitForSync,put_api_simple_remove_by_example_opts,boolean,optional,} /// if set to true, then all removal operations will /// instantly be synchronized to disk. If this is not specified, then the /// collection's default sync behavior will be applied. @@ -115,4 +115,4 @@ /// db._drop(cn); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md b/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md index e55aeaf369..356734f91a 100644 --- a/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md +++ b/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md @@ -17,7 +17,7 @@ /// @RESTBODYPARAM{options,object,optional,put_api_simple_update_by_example_options} /// a json object which can contains following attributes: /// -/// @RESTSTRUCT{keepNull,put_api_simple_update_by_example_options,string,optional,string} +/// @RESTSTRUCT{keepNull,put_api_simple_update_by_example_options,boolean,optional,} /// This parameter can be used to modify the behavior when /// handling *null* values. Normally, *null* values are stored in the /// database. By setting the *keepNull* parameter to *false*, this @@ -122,4 +122,4 @@ /// db._drop(cn); /// @END_EXAMPLE_ARANGOSH_RUN /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md b/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md index 85ded2506d..6c6fbf7810 100644 --- a/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md +++ b/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md @@ -1,6 +1,6 @@ //////////////////////////////////////////////////////////////////////////////// /// @startDocuBlock RestRemoveByKeys -/// @brief removes multiple documents by their keys +/// @brief Hihi removes multiple documents by their keys /// /// @RESTHEADER{PUT /_api/simple/remove-by-keys, Remove documents by their keys} /// @@ -13,11 +13,22 @@ /// @RESTBODYPARAM{options,object,optional,put_api_simple_remove_by_keys_opts} /// a json object which can contains following attributes: /// -/// @RESTSTRUCT{waitForSync,put_api_simple_remove_by_keys_opts,string,optional,string} +/// @RESTSTRUCT{waitForSync,put_api_simple_remove_by_keys_opts,boolean,optional,} /// if set to true, then all removal operations will /// instantly be synchronized to disk. If this is not specified, then the /// collection's default sync behavior will be applied. /// +/// @RESTSTRUCT{silent,put_api_simple_remove_by_keys_opts,boolean,optional,} +/// if set to *false*, then the result will contain an additional +/// attribute *old* which contains an array with one entry for each +/// removed document. By default, these entries will have the *_id*, +/// *_key* and *_rev* attributes. +/// +/// @RESTSTRUCT{returnOld,put_api_simple_remove_by_keys_opts,boolean,optional,} +/// if set to *true* and *silent* above is *false*, then the above +/// information about the removed documents contains the complete +/// removed documents. +/// /// @RESTDESCRIPTION /// Looks up the documents in the specified collection using the array of keys /// provided, and removes all documents from the collection whose keys are @@ -87,4 +98,4 @@ /// @END_EXAMPLE_ARANGOSH_RUN /// /// @endDocuBlock -//////////////////////////////////////////////////////////////////////////////// \ No newline at end of file +//////////////////////////////////////////////////////////////////////////////// diff --git a/Documentation/DocuBlocks/collectionDatabaseCreate.md b/Documentation/DocuBlocks/collectionDatabaseCreate.md index 1673602023..207842fe4d 100644 --- a/Documentation/DocuBlocks/collectionDatabaseCreate.md +++ b/Documentation/DocuBlocks/collectionDatabaseCreate.md @@ -26,7 +26,7 @@ to the [naming conventions](../NamingConventions/README.md). only. API implementors may be required to create system collections in very special occasions, but normally a regular collection will do. -* *isVolatile* (optional, default is *false*): If *true then the +* *isVolatile* (optional, default is *false*): If *true* then the collection data is kept in-memory only and not made persistent. Unloading the collection will cause the collection data to be discarded. Stopping or re-starting the server will also cause full loss of data in the diff --git a/README_maintainers.md b/README_maintainers.md index 4c3a78f959..fa3cdc9448 100644 --- a/README_maintainers.md +++ b/README_maintainers.md @@ -147,6 +147,34 @@ HttpInterface - RSpec Client Tests ---------------------------------- These tests work on the plain RESTfull interface of arangodb, and thus also test invalid HTTP-requests and so forth, plus check error handling in the server. +Running jsUnity tests +--------------------- +Assume that you have a test file containing + +```js +function exampleTestSuite () { + return { + testSizeOfTestCollection : function () { + assertEqual(5, 5); + }; +} + +jsUnity.run(aqlTestSuite); + +return jsunity.done(); +``` + +Then you can run the test suite using *jsunity.runTest* + +``` +arangosh> require("jsunity").runTest("test.js"); +2012-01-28T19:10:23Z [10671] INFO Running aqlTestSuite +2012-01-28T19:10:23Z [10671] INFO 1 test found +2012-01-28T19:10:23Z [10671] INFO [PASSED] testSizeOfTestCollection +2012-01-28T19:10:23Z [10671] INFO 1 test passed +2012-01-28T19:10:23Z [10671] INFO 0 tests failed +2012-01-28T19:10:23Z [10671] INFO 1 millisecond elapsed +``` jsUnity on arangod ------------------ diff --git a/js/apps/system/_admin/aardvark/APP/api-docs.json b/js/apps/system/_admin/aardvark/APP/api-docs.json index d18f47b95c..61f2bd4f04 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 - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "JSA_put_api_simple_any": { "properties": { @@ -35,7 +35,7 @@ "collection" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_by_example": { "properties": { @@ -63,7 +63,7 @@ "limit" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_first": { "properties": { @@ -80,7 +80,7 @@ "collection" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_first_example": { "properties": { @@ -98,7 +98,7 @@ "example" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_fulltext": { "properties": { @@ -136,7 +136,7 @@ "index" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_last": { "properties": { @@ -155,7 +155,7 @@ "count" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_near": { "properties": { @@ -198,7 +198,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_range": { "properties": { @@ -242,7 +242,7 @@ "skip" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_remove_by_example": { "properties": { @@ -263,7 +263,7 @@ "example" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_replace_by_example": { "properties": { @@ -289,7 +289,7 @@ "newValue" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_update_by_example": { "properties": { @@ -316,7 +316,7 @@ "newValue" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_within": { "properties": { @@ -364,7 +364,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSA_put_api_simple_within_rectangle": { "properties": { @@ -412,7 +412,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "JSF_HTTP_API_TRAVERSAL": { "properties": { @@ -485,7 +485,7 @@ "startVertex" ], "type": "object", - "x-filename": "Graph Traversal - ./Documentation/DocuBlocks/Rest//Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" + "x-filename": "Graph Traversal - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" }, "JSF_cluster_dispatcher_POST": { "properties": { @@ -514,7 +514,7 @@ "action" ], "type": "object", - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "JSF_general_graph_create_http_examples": { "properties": { @@ -535,7 +535,7 @@ "name" ], "type": "object", - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "JSF_general_graph_edge_definition_add_http_examples": { "properties": { @@ -564,7 +564,7 @@ "to" ], "type": "object", - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "JSF_general_graph_edge_definition_modify_http_examples": { "properties": { @@ -593,7 +593,7 @@ "to" ], "type": "object", - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "JSF_get_api_database_new": { "properties": { @@ -631,7 +631,7 @@ "name" ], "type": "object", - "x-filename": "Database - ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_list.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_new.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_user.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_delete.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md" }, "JSF_get_api_database_new_USERS": { "description": "", @@ -672,7 +672,7 @@ "version" ], "type": "object", - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" }, "JSF_post_api_aqlfunction": { "properties": { @@ -695,7 +695,7 @@ "code" ], "type": "object", - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "JSF_post_api_collection": { "properties": { @@ -755,7 +755,7 @@ "name" ], "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "JSF_post_api_collection_opts": { "description": "/// additional options for key generation. If specified, then *keyOptions*\n/// should be a JSON array containing the following attributes:\n///\n", @@ -780,7 +780,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "JSF_post_api_cursor": { "properties": { @@ -824,7 +824,7 @@ "query" ], "type": "object", - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/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", @@ -852,7 +852,7 @@ } }, "type": "object", - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_cursor_rc_201": { "properties": { @@ -904,7 +904,7 @@ "cached" ], "type": "object", - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_cursor_rc_400": { "properties": { @@ -935,7 +935,7 @@ "errorMessage" ], "type": "object", - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "JSF_post_api_explain": { "properties": { @@ -959,7 +959,7 @@ "query" ], "type": "object", - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "JSF_post_api_export": { "properties": { @@ -1006,7 +1006,7 @@ "ttl" ], "type": "object", - "x-filename": "Bulk - ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_document.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_json.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_batch_processing.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" }, "JSF_post_api_export_restrictions": { "description": "/// an object containing an array of attribute names that will be \n/// included or excluded when returning result documents.\n///\n/// Not specifying *restrict* will by default return all attributes of each document.\n///\n", @@ -1025,7 +1025,7 @@ } }, "type": "object", - "x-filename": "Bulk - ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_document.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_json.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_batch_processing.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" }, "JSF_post_api_index_cap": { "properties": { @@ -1048,7 +1048,7 @@ "type" ], "type": "object", - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "JSF_post_api_index_fulltext": { "properties": { @@ -1075,7 +1075,7 @@ "minLength" ], "type": "object", - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "JSF_post_api_index_geo": { "properties": { @@ -1101,7 +1101,7 @@ "geoJson" ], "type": "object", - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "JSF_post_api_index_hash": { "properties": { @@ -1134,7 +1134,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "JSF_post_api_index_skiplist": { "properties": { @@ -1167,7 +1167,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "JSF_post_api_new_tasks": { "properties": { @@ -1200,7 +1200,7 @@ "params" ], "type": "object", - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" }, "JSF_post_api_transaction": { "properties": { @@ -1232,7 +1232,7 @@ "action" ], "type": "object", - "x-filename": "Transactions - ./Documentation/DocuBlocks/Rest//Transactions/JSF_post_api_transaction.md" + "x-filename": "Transactions - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" }, "JSF_post_batch_replication": { "properties": { @@ -1246,7 +1246,7 @@ "ttl" ], "type": "object", - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" }, "JSF_put_api_new_tasks": { "properties": { @@ -1279,7 +1279,7 @@ "params" ], "type": "object", - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" }, "JSF_put_api_replication_applier_adjust": { "properties": { @@ -1402,7 +1402,7 @@ "restrictType" ], "type": "object", - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" }, "JSF_put_api_replication_makeSlave": { "properties": { @@ -1511,7 +1511,7 @@ "includeSystem" ], "type": "object", - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" }, "JSF_put_api_replication_synchronize": { "properties": { @@ -1563,7 +1563,7 @@ "password" ], "type": "object", - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" }, "JSF_put_batch_replication": { "properties": { @@ -1577,7 +1577,7 @@ "ttl" ], "type": "object", - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" }, "PostApiQueryProperties": { "properties": { @@ -1590,7 +1590,7 @@ "query" ], "type": "object", - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "PutApiQueryCacheProperties": { "properties": { @@ -1609,7 +1609,7 @@ "maxResults" ], "type": "object", - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "PutApiQueryProperties": { "properties": { @@ -1647,7 +1647,7 @@ "maxQueryStringLength" ], "type": "object", - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "RestLookupByKeys": { "properties": { @@ -1668,7 +1668,7 @@ "keys" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "RestRemoveByKeys": { "properties": { @@ -1692,7 +1692,7 @@ "keys" ], "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "collection_figures": { "description": "/// metrics of the collection\n///\n", @@ -1760,7 +1760,7 @@ "indexes" ], "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_alive": { "description": "/// the currently active figures\n///\n", @@ -1777,7 +1777,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_attributes": { "description": "", @@ -1794,7 +1794,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_compactors": { "description": "///\n", @@ -1811,7 +1811,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_datafiles": { "description": "/// Metrics regarding the datafiles\n///\n", @@ -1828,7 +1828,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_dead": { "description": "/// the items waiting to be swept away by the cleaner\n///\n", @@ -1850,7 +1850,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_indexes": { "description": "", @@ -1867,7 +1867,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_journals": { "description": "/// Metrics regarding the journal files\n///\n", @@ -1884,7 +1884,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_shapefiles": { "description": "/// **deprecated**\n///\n", @@ -1901,7 +1901,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "collection_figures_shapes": { "description": "", @@ -1918,7 +1918,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "compactionStatus_attributes": { "description": "", @@ -1933,7 +1933,7 @@ } }, "type": "object", - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "explain_options": { "description": "/// Options for the query\n///\n", @@ -1957,7 +1957,7 @@ } }, "type": "object", - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "put_api_simple_remove_by_example_opts": { "description": "/// a json object which can contains following attributes:\n///\n", @@ -1968,22 +1968,30 @@ }, "waitForSync": { "description": "/// 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///\n", - "type": "string" + "type": "boolean" } }, "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "put_api_simple_remove_by_keys_opts": { "description": "/// a json object which can contains following attributes:\n///\n", "properties": { + "returnOld": { + "description": "/// 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///\n", + "type": "boolean" + }, + "silent": { + "description": "/// 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///\n", + "type": "boolean" + }, "waitForSync": { "description": "/// 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///\n", - "type": "string" + "type": "boolean" } }, "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "put_api_simple_replace_by_example_options": { "description": "/// a json object which can contain following attributes\n///\n", @@ -1998,14 +2006,14 @@ } }, "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" }, "put_api_simple_update_by_example_options": { "description": "/// a json object which can contains following attributes:\n///\n", "properties": { "keepNull": { "description": "/// This parameter can be used to modify the behavior when\n/// handling *null* values. Normally, *null* values are stored in the\n/// database. By setting the *keepNull* parameter to *false*, this\n/// behavior can be changed so that all attributes in *data* with *null*\n/// values will be removed from the updated document.\n///\n", - "type": "string" + "type": "boolean" }, "limit": { "description": "/// an optional value that determines how many documents to\n/// update at most. If *limit* is specified but is less than the number\n/// of documents in the collection, it is undefined which of the documents\n/// will be updated.\n///\n", @@ -2022,7 +2030,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "info": { @@ -2043,7 +2051,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "get": { "description": "\n\n///\n/// Executes a cluster roundtrip from a coordinator to a DB server and\n/// back. This call only works in a coordinator node in a cluster.\n/// One can and should append an arbitrary path to the URL and the\n/// part after */_admin/cluster-test* is used as the path of the HTTP\n/// request which is sent from the coordinator to a DB node. Likewise,\n/// any form data appended to the URL is forwarded in the request to the\n/// DB node. This handler takes care of all request types (see below)\n/// and uses the same request type in its request to the DB node.\n///\n/// The 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///\n/// All other HTTP headers and the body of the request (if present, see\n/// other HTTP methods below) are forwarded as given in the original request.\n///\n/// In asynchronous mode the DB server answers with an HTTP request of its\n/// own, in synchronous mode it sends a HTTP response. In both cases the\n/// headers and the body are used to produce the HTTP response of this\n/// API call.\n///\n", @@ -2064,7 +2072,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "head": { "description": "\n\n/// See GET method.\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -2074,7 +2082,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "patch": { "description": "\nfree style json body\n\n\n\n/// See GET method. The body can be any type and is simply forwarded.\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -2096,7 +2104,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "post": { "description": "\nfree style json body\n\n\n\n/// See GET method.\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -2118,7 +2126,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" }, "put": { "description": "\nfree style json body\n\n\n\n/// See GET method. The body can be any type and is simply forwarded.\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -2140,7 +2148,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/clusterCheckPort": { @@ -2168,7 +2176,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/clusterDispatch": { @@ -2198,7 +2206,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/clusterPlanner": { @@ -2230,7 +2238,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/clusterStatistics": { @@ -2261,7 +2269,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_check_port_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PUT.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_HEAD.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_PATCH.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_dispatcher_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_statistics_GET.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_planner_POST.md, ./Documentation/DocuBlocks/Rest//Cluster/JSF_cluster_test_DELETE.md" + "x-filename": "Cluster - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_planner_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_dispatcher_POST.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md" } }, "/_admin/database/target-version": { @@ -2278,7 +2286,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/echo": { @@ -2295,7 +2303,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/execute": { @@ -2319,7 +2327,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/log": { @@ -2392,7 +2400,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/long_echo": { @@ -2409,7 +2417,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/routing/reload": { @@ -2426,7 +2434,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/server/role": { @@ -2443,7 +2451,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/shutdown": { @@ -2460,7 +2468,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/sleep": { @@ -2486,7 +2494,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/statistics": { @@ -2503,7 +2511,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/statistics-description": { @@ -2520,7 +2528,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/test": { @@ -2544,7 +2552,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/time": { @@ -2561,7 +2569,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_admin/wal/flush": { @@ -2596,7 +2604,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_transactions.md, ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md" } }, "/_admin/wal/properties": { @@ -2616,7 +2624,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_transactions.md, ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md" }, "put": { "description": "\n\n///\n/// Configures the behavior of the write-ahead log. The body of the request\n/// must 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///\n/// Specifying any of the above attributes is optional. Not specified attributes\n/// will be ignored and the configuration for them will not be modified.\n///\n\n
Example: ///

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\" : 1, \n  \"syncInterval\" : 100, \n  \"throttleWait\" : 15000, \n  \"throttleWhenPending\" : 0, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -2634,7 +2642,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_transactions.md, ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md" } }, "/_admin/wal/transactions": { @@ -2654,7 +2662,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_transactions.md, ./Documentation/DocuBlocks/Rest//wal/JSF_get_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_properties.md, ./Documentation/DocuBlocks/Rest//wal/JSF_put_admin_wal_flush.md" + "x-filename": "wal - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md" } }, "/_api/aqlfunction": { @@ -2679,7 +2687,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.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 ///\n - **code**: /// a string representation of the function body.\n ///\n - **name**: /// the fully qualified name of the user functions.\n ///\n\n\n\n\n///\n/// In 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///\n/// The body of the response will contain a JSON object with additional error\n/// details. 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
Example: ///

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", @@ -2710,7 +2718,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/aqlfunction/{name}": { @@ -2749,7 +2757,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/batch": { @@ -2784,7 +2792,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_document.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_json.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_batch_processing.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" } }, "/_api/collection": { @@ -2809,7 +2817,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.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 ///\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 ///\n - **type**: /// specifies the type of the key generator. The currently available generators are\n /// *traditional* and *autoincrement*.\n ///\n - **increment**: /// increment value for *autoincrement* key generator. Not used for other key\n /// generator types.\n ///\n - **offset**: /// Initial offset value for *autoincrement* key generator.\n /// Not used for other key generator types.\n ///\n - **name**: /// The name of the collection.\n ///\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 ///\n - **doCompact**: /// whether or not the collection will be compacted (default is *true*)\n ///\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 ///\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 ///\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 ///\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 ///\n - **type**: /// (The default is *2*): the type of the collection to create.\n /// The following values for *type* are valid:\n ///\n /// - *2*: document collection\n /// - *3*: edges collection\n ///\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 /// \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\n\n/// Creates an new collection with a given name. The request must contain an\n/// object with the following attributes.\n///\n///\n\n
Example: ///

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\" : \"648485586\", \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\" : \"648616658\", \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
Example: ///

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\" : \"648878802\", \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", @@ -2837,7 +2845,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}": { @@ -2866,7 +2874,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "get": { "description": "\n\n/// The result is an object describing the collection with the following\n/// attributes:\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///\n/// Every 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", @@ -2890,7 +2898,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/checksum": { @@ -2933,7 +2941,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/count": { @@ -2962,7 +2970,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/figures": { @@ -3001,7 +3009,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/load": { @@ -3030,7 +3038,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/properties": { @@ -3059,7 +3067,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" }, "put": { "description": "\n\n/// Changes the properties of a collection. Expects an object with the\n/// attribute(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///\n/// On 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\n/// created.\n///\n\n
Example: ///

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\" : \"673782482\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 1048576, \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", @@ -3086,7 +3094,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/rename": { @@ -3115,7 +3123,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/revision": { @@ -3144,7 +3152,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/rotate": { @@ -3173,7 +3181,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/truncate": { @@ -3202,7 +3210,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/collection/{collection-name}/unload": { @@ -3231,7 +3239,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rotate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_name.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_load.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_properties.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_count.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_truncate.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_checksum.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_delete_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_figures.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_post_api_collection.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_get_api_collections.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_unload.md, ./Documentation/DocuBlocks/Rest//Collections/JSA_get_api_collection_revision.md, ./Documentation/DocuBlocks/Rest//Collections/JSF_put_api_collection_rename.md" + "x-filename": "Collections - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" } }, "/_api/cursor": { @@ -3278,7 +3286,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" } }, "/_api/cursor/{cursor-identifier}": { @@ -3307,7 +3315,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" }, "put": { "description": "\n\n///\n/// If the cursor is still alive, returns an object with the following\n/// attributes:\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///\n/// Note that even if *hasMore* returns *true*, the next call might\n/// still return no documents. If, however, *hasMore* is *false*, then\n/// the cursor is exhausted. Once the *hasMore* attribute has a value of\n/// *false*, the client can stop.\n///\n\n
Example: ///\n/// Valid request for next batch\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/685054674\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : [ \n    { \n      \"hello3\" : \"world1\", \n      \"_id\" : \"products/684202706\", \n      \"_rev\" : \"684202706\", \n      \"_key\" : \"684202706\" \n    }, \n    { \n      \"hello4\" : \"world1\", \n      \"_id\" : \"products/684530386\", \n      \"_rev\" : \"684530386\", \n      \"_key\" : \"684530386\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"685054674\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"filtered\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// Missing identifier\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  \"code\" : 400, \n  \"error\" : true, \n  \"errorMessage\" : \"expecting PUT \\\\/_api\\\\/cursor\\\\/<cursor-id>\", \n  \"errorNum\" : 400 \n}\n

\n
Example: ///\n/// Unknown identifier\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  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"cursor not found\", \n  \"errorNum\" : 1600 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -3337,7 +3345,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_identifier.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor_delete.md, ./Documentation/DocuBlocks/Rest//Cursors/JSF_post_api_cursor.md" + "x-filename": "Cursors - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" } }, "/_api/database": { @@ -3360,7 +3368,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_list.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_new.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_user.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_delete.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.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 ///\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 ///\n - **username**: /// Loginname of the user to be created\n ///\n - **passwd**: /// Password for the user\n ///\n - **active**: /// if *False* the user won't be able to log into the database.\n ///\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 - **passwd**: /// The user password as a string. If not specified, it will default to an empty string.\n ///\n - **active**: /// A Flag indicating whether the user account should be activated or not.\n /// The default value is *true*.\n ///\n - **name**: /// Has to contain a valid database name.\n ///\n\n\n\n\n/// Creates a new database\n///\n/// The 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
Example: ///\n/// Creating a database named *example*.\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
Example: ///\n/// Creating a database named *mydb* with two users.\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", @@ -3394,7 +3402,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_list.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_new.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_user.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_delete.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md" } }, "/_api/database/current": { @@ -3417,7 +3425,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_list.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_new.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_user.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_delete.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md" } }, "/_api/database/user": { @@ -3437,7 +3445,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_list.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_new.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_user.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_delete.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md" } }, "/_api/database/{database-name}": { @@ -3472,48 +3480,15 @@ "Database" ], "x-examples": [], - "x-filename": "Database - ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_list.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_new.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_user.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_delete.md, ./Documentation/DocuBlocks/Rest//Database/JSF_get_api_database_current.md" + "x-filename": "Database - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md" } }, - "/_api/document": { - "get": { - "description": "\n\n/// Returns an array of all keys, ids, or URI paths for all documents in the\n/// collection identified by *collection*. The type of the result array is\n/// determined by the *type* attribute.\n///\n/// Note that the results have no defined order and thus the order should\n/// not be relied on.\n///\n\n
Example: ///\n/// Return all document paths\n///

shell> curl --dump - http://localhost:8529/_api/document/?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"documents\" : [ \n    \"/_db/_system/_api/document/products/737417938\", \n    \"/_db/_system/_api/document/products/738073298\", \n    \"/_db/_system/_api/document/products/737745618\" \n  ] \n}\n

\n
Example: ///\n/// Return all document keys\n///

shell> curl --dump - http://localhost:8529/_api/document/?collection=products&type=key\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"documents\" : [ \n    \"736828114\", \n    \"736500434\", \n    \"736172754\" \n  ] \n}\n

\n
Example: ///\n/// Collection does not exist\n///

shell> curl --dump - http://localhost:8529/_api/document/?collection=doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'doesnotexist' not found\", \n  \"errorNum\" : 1203 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "/_api/document/{collection}": { + "delete": { + "description": "\nfree style json body\n\n\n\n/// The body of the request is an array consisting of selectors for\n/// documents. A selector can either be a string with a key or a string\n/// with a document handle or an object with a *_key* attribute. This\n/// API call removes all specified documents from *collection*. If the\n/// selector is an object and has a *_rev* attribute, it is a\n/// precondition that the actual revision of the removed document in the\n/// collection is the specified one.\n///\n/// The body of the response contains a JSON object with the information\n/// about the handle and the revision. The attribute *_id* contains the\n/// known *document-handle* of the removed document, *_key* contains the\n/// key which uniquely identifies a document in a given collection, and\n/// the attribute *_rev* contains the document revision.\n///\n/// If the *waitForSync* parameter is not specified or set to *false*,\n/// then the collection's default *waitForSync* behavior is applied.\n/// The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync*\n/// value of *true*.\n///\n/// If the query parameter *returnOld* is *true*, then\n/// the complete previous revision of the document\n/// is returned under the *old* attribute in the result.\n///\n\n
Example: ///\n/// Using document handle:\n///

shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/727128786\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/727128786\", \n  \"_rev\" : \"727128786\", \n  \"_key\" : \"727128786\" \n}\n

\n
Example: ///\n/// Unknown document handle:\n///

shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/728832722\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"errorNum\" : 1202 \n}\n

\n
Example: ///\n/// Revision conflict:\n///

shell> curl -X DELETE --header 'If-Match: \"728177362\"' --dump - http://localhost:8529/_api/document/products/727849682\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"727849682\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/727849682\", \n  \"_rev\" : \"727849682\", \n  \"_key\" : \"727849682\" \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { - "description": "/// The name of the collection.\n///\n", - "in": "query", - "name": "collection", - "required": true, - "type": "string" - }, - { - "description": "/// The type of the result. The following values are allowed:\n///\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///\n", - "in": "query", - "name": "type", - "required": false, - "type": "string" - } - ], - "responses": { - "200": { - "description": "/// All went good.\n///\n" - }, - "404": { - "description": "/// The collection does not exist.\n///\n" - } - }, - "summary": "Read all documents", - "tags": [ - "Documents" - ], - "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" - }, - "post": { - "description": "\nfree style json body\n\n\n\n/// Creates a new document in the collection named *collection*. A JSON\n/// representation of the document must be passed as the body of the POST\n/// request.\n///\n/// If the document was created successfully, then the \"Location\" header\n/// contains the path to the newly created document. The \"ETag\" header field\n/// contains the revision of the document.\n///\n/// The body of the response contains a JSON object with the following\n/// 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///\n/// If the collection parameter *waitForSync* is *false*, then the call returns\n/// as soon as the document has been accepted. It will not wait until the\n/// document has been synced to disk.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document creation operation to disk even in case that\n/// the *waitForSync* flag had been disabled for the entire collection. Thus,\n/// the *waitForSync* query parameter can be used to force synchronization of just\n/// this specific operations. To use this, set the *waitForSync* parameter to\n/// *true*. If the *waitForSync* parameter is not specified or set to *false*,\n/// then the collection's default *waitForSync* behavior is applied. The\n/// *waitForSync* query parameter cannot be used to disable synchronization for\n/// collections that have a default *waitForSync* value of *true*.\n///\n\n
Example: ///\n/// Create a document in a collection named *products*. Note that the\n/// revision identifier might or might not by equal to the auto-generated\n/// key.\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"734010066\"\nlocation: /_db/_system/_api/document/products/734010066\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/734010066\", \n  \"_rev\" : \"734010066\", \n  \"_key\" : \"734010066\" \n}\n

\n
Example: ///\n/// Create a document in a collection named *products* with a collection-level\n/// *waitForSync* value of *false*.\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"733485778\"\nlocation: /_db/_system/_api/document/products/733485778\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/733485778\", \n  \"_rev\" : \"733485778\", \n  \"_key\" : \"733485778\" \n}\n

\n
Example: ///\n/// Create a document in a collection with a collection-level *waitForSync*\n/// value of *false*, but using the *waitForSync* query parameter.\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products&waitForSync=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"735058642\"\nlocation: /_db/_system/_api/document/products/735058642\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/735058642\", \n  \"_rev\" : \"735058642\", \n  \"_key\" : \"735058642\" \n}\n

\n
Example: ///\n/// Create a document in a new, named collection\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products&createCollection=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"734534354\"\nlocation: /_db/_system/_api/document/products/734534354\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/734534354\", \n  \"_rev\" : \"734534354\", \n  \"_key\" : \"734534354\" \n}\n

\n
Example: ///\n/// Unknown collection name\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"errorNum\" : 1203 \n}\n

\n
Example: ///\n/// Illegal document\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 400, \n  \"error\" : true, \n  \"errorMessage\" : \"Parse error: Expecting '\\\\\\\"' or '}'\", \n  \"errorNum\" : 600 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", - "parameters": [ - { - "description": "/// A JSON representation of the document.\n///\n", + "description": "/// A JSON array of strings or documents.\n///\n", "in": "body", "name": "Json Post Body", "required": true, @@ -3524,39 +3499,229 @@ "x-description-offset": 0 }, { - "description": "/// The collection name.\n///\n", - "in": "query", + "description": "/// Collection from which documents are removed.\n///\n", + "format": "string", + "in": "path", "name": "collection", "required": true, "type": "string" }, { - "description": "/// If this parameter has a value of *true* or *yes*, then the collection is\n/// created if it does not yet exist. Other values will be ignored so the\n/// collection must be present for the operation to succeed.\n///\n/// **Note**: this flag is not supported in a cluster. Using it will result in an\n/// error.\n///\n", + "description": "/// Wait until deletion operation has been synced to disk.\n///\n", "in": "query", - "name": "createCollection", + "name": "waitForSync", "required": false, "type": "boolean" }, + { + "description": "/// Return additionally the complete previous revision of the changed \n/// document under the attribute *old* in the result.\n///\n", + "in": "query", + "name": "returnOld", + "required": false, + "type": "boolean" + }, + { + "description": "/// If set to *true*, ignore any *_rev* attribute in the selectors. No\n/// revision check is performed.\n///\n", + "in": "query", + "name": "ignoreRevs", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "/// is returned if the document was removed successfully and\n/// *waitForSync* was *true*.\n///\n" + }, + "202": { + "description": "/// is returned if the document was removed successfully and\n/// *waitForSync* was *false*.\n///\n" + }, + "404": { + "description": "/// is returned if the collection or the document was not found.\n/// The response body contains an error document in this case.\n///\n" + }, + "412": { + "description": "/// is returned if a *_rev* attribute is given and the found document\n/// has a different revision. The response will also contain the found\n/// document's current revision in the *_rev* attribute. Additionally,\n/// the attributes *_id* and *_key* will be returned.\n///\n" + } + }, + "summary": "Removes multiple documents", + "tags": [ + "Documents" + ], + "x-examples": [], + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" + }, + "get": { + "description": "\n\n/// Returns an array of all keys, ids, or URI paths for all documents in the\n/// collection identified by *collection*. The type of the result array is\n/// determined by the *type* attribute.\n///\n/// Note that the results have no defined order and thus the order should\n/// not be relied on.\n///\n\n
Example: ///\n/// Return all document paths\n///

shell> curl --dump - http://localhost:8529/_api/document/?collection=products\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"documents\" : [ \n    \"/_db/_system/_api/document/products/737417938\", \n    \"/_db/_system/_api/document/products/738073298\", \n    \"/_db/_system/_api/document/products/737745618\" \n  ] \n}\n

\n
Example: ///\n/// Return all document keys\n///

shell> curl --dump - http://localhost:8529/_api/document/?collection=products&type=key\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"documents\" : [ \n    \"736828114\", \n    \"736500434\", \n    \"736172754\" \n  ] \n}\n

\n
Example: ///\n/// Collection does not exist\n///

shell> curl --dump - http://localhost:8529/_api/document/?collection=doesnotexist\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'doesnotexist' not found\", \n  \"errorNum\" : 1203 \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", + "parameters": [ + { + "description": "/// 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 query parameter was required. This combination still works, but\n/// the recommended way is to specify the collection in the URL path.\n///\n", + "in": "query", + "name": "collection", + "required": false, + "type": "string" + }, + { + "description": "/// The type of the result. The following values are allowed:\n///\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///\n", + "in": "query", + "name": "type", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "/// All went well.\n///\n" + }, + "404": { + "description": "/// The collection does not exist.\n///\n" + } + }, + "summary": "Read all documents", + "tags": [ + "Documents" + ], + "x-examples": [], + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" + }, + "patch": { + "description": "\nfree style json body\n\n\n\n/// Partially updates documents, the documents to update are specified\n/// by the *_key* attributes in the body objects. The body of the\n/// request must contain a JSON array of document updates with the\n/// attributes to patch (the patch documents). All attributes from the\n/// patch documents will be added to the existing documents if they do\n/// not yet exist, and overwritten in the existing documents if they do\n/// exist there.\n///\n/// Setting an attribute value to *null* in the patch documents will cause a\n/// value of *null* to be saved for the attribute by default.\n///\n/// If *ignoreRevs* is *false* and there is a *_rev* attribute in a\n/// document in the body and its value does not match the revision of\n/// the corresponding document in the database, the precondition is\n/// violated.\n///\n/// If the document exists and can be updated, then an *HTTP 201* or\n/// an *HTTP 202* is returned (depending on *waitForSync*, see below).\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document replacement operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON array with the information\n/// about the handle and the revision of the replaced documents. The\n/// attribute *_id* contains the known *document-handle* of each updated\n/// document, *_key* contains the key which uniquely identifies a\n/// document in a given collection, and the attribute *_rev* contains\n/// the new document revision.\n///\n/// If the query parameter *returnOld* is *true*, then, for each\n/// generated document, the complete previous revision of the document\n/// is returned under the *old* attribute in the result.\n///\n/// If the query parameter *returnNew* is *true*, then, for each\n/// generated document, the complete new document is returned under\n/// the *new* attribute in the result.\n///\n/// If any of the document does not exist, then a *HTTP 404* is returned\n/// and the body of the response contains an error document.\n///\n", + "parameters": [ + { + "description": "/// A JSON representation of an array of document updates as objects.\n///\n", + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "additionalProperties": {}, + "type": "object" + }, + "x-description-offset": 0 + }, + { + "description": "/// This URL parameter is the name of the collection in which the\n/// documents are updated.\n///\n", + "format": "string", + "in": "path", + "name": "collection", + "required": true, + "type": "string" + }, + { + "description": "/// If the intention is to delete existing attributes with the patch\n/// command, the URL query parameter *keepNull* can be used with a value\n/// of *false*. This will modify the behavior of the patch command to\n/// remove any attributes from the existing document that are contained\n/// in the patch document with an attribute value of *null*.\n///\n", + "in": "query", + "name": "keepNull", + "required": false, + "type": "boolean" + }, + { + "description": "/// Controls whether objects (not arrays) will be merged if present in\n/// both the existing and the patch document. If set to *false*, the\n/// value in the patch document will overwrite the existing document's\n/// value. If set to *true*, objects will be merged. The default is\n/// *true*.\n///\n", + "in": "query", + "name": "mergeObjects", + "required": false, + "type": "boolean" + }, + { + "description": "/// Wait until the new documents have been synced to disk.\n///\n", + "in": "query", + "name": "waitForSync", + "required": false, + "type": "boolean" + }, + { + "description": "/// By default, or if this is set to *true*, the *_rev* attributes in \n/// the given documents are ignored. If this is set to *false*, then\n/// any *_rev* attribute given in a body document is taken as a\n/// precondition. The document is only updated if the current revision\n/// is the one specified.\n///\n", + "in": "query", + "name": "ignoreRevs", + "required": false, + "type": "boolean" + }, + { + "description": "/// Return additionally the complete previous revision of the changed \n/// documents under the attribute *old* in the result.\n///\n", + "in": "query", + "name": "returnOld", + "required": false, + "type": "boolean" + }, + { + "description": "/// Return additionally the complete new documents under the attribute *new*\n/// in the result.\n///\n", + "in": "query", + "name": "returnNew", + "required": false, + "type": "boolean" + } + ], + "responses": { + "201": { + "description": "/// is returned if the documents were updated successfully and\n/// *waitForSync* was *true*.\n///\n" + }, + "202": { + "description": "/// is returned if the documents were updated successfully and\n/// *waitForSync* was *false*.\n///\n" + }, + "400": { + "description": "/// is returned if the body does not contain a valid JSON representation\n/// of an array of documents. The response body contains\n/// an error document in this case.\n///\n" + }, + "404": { + "description": "/// is returned if the collection or a document was not found.\n///\n" + }, + "412": { + "description": "/// is returned if the precondition was violated. The response will\n/// also contain the found documents' current revisions in the *_rev*\n/// attributes. Additionally, the attributes *_id* and *_key* will be\n/// returned.\n///\n/// \n////////////////////////////////////////////////////////////////////////////////\n" + } + }, + "summary": "Update documents", + "tags": [ + "Documents" + ], + "x-examples": [], + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" + }, + "post": { + "description": "\nfree style json body\n\n\n\n/// Creates a new document from the document given in the body, unless there\n/// is already a document with the *_key* given. If no *_key* is given, a new\n/// unique *_key* is generated automatically.\n///\n/// The body can be an array of documents, in which case all\n/// documents in the array are inserted with the same semantics as for a\n/// single document. The operation either succeeds for all documents or\n/// fails without adding a single document.\n/// \n/// Possibly given *_id* and *_rev* attributes in the body are always ignored,\n/// the URL part or the query parameter collection respectively counts.\n///\n/// If the document was created successfully, then the *Location* header\n/// contains the path to the newly created document. The *ETag* header field\n/// contains the revision of the document. Both are only set in the single\n/// document case.\n///\n/// The body of the response contains a JSON object (single document case)\n/// with the following attributes:\n///\n/// - *_id* contains the document handle of the newly created document\n/// - *_key* contains the document key\n/// - *_rev* contains the document revision\n///\n/// In the multi case the body is an array of such objects.\n///\n/// If the collection parameter *waitForSync* is *false*, then the call\n/// returns as soon as the document has been accepted. It will not wait\n/// until the documents have been synced to disk.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document creation operation to disk even in\n/// case that the *waitForSync* flag had been disabled for the entire\n/// collection. Thus, the *waitForSync* query parameter can be used to\n/// force synchronization of just this specific operations. To use this,\n/// set the *waitForSync* parameter to *true*. If the *waitForSync*\n/// parameter is not specified or set to *false*, then the collection's\n/// default *waitForSync* behavior is applied. The *waitForSync* query\n/// parameter cannot be used to disable synchronization for collections\n/// that have a default *waitForSync* value of *true*.\n///\n/// If the query parameter *returnNew* is *true*, then, for each\n/// generated document, the complete new document is returned under\n/// the *new* attribute in the result.\n///\n\n
Example: ///\n/// Create a document in a collection named *products*. Note that the\n/// revision identifier might or might not by equal to the auto-generated\n/// key.\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"734010066\"\nlocation: /_db/_system/_api/document/products/734010066\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/734010066\", \n  \"_rev\" : \"734010066\", \n  \"_key\" : \"734010066\" \n}\n

\n
Example: ///\n/// Create a document in a collection named *products* with a collection-level\n/// *waitForSync* value of *false*.\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"733485778\"\nlocation: /_db/_system/_api/document/products/733485778\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/733485778\", \n  \"_rev\" : \"733485778\", \n  \"_key\" : \"733485778\" \n}\n

\n
Example: ///\n/// Create a document in a collection with a collection-level *waitForSync*\n/// value of *false*, but using the *waitForSync* query parameter.\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products&waitForSync=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"735058642\"\nlocation: /_db/_system/_api/document/products/735058642\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/735058642\", \n  \"_rev\" : \"735058642\", \n  \"_key\" : \"735058642\" \n}\n

\n
Example: ///\n/// Unknown collection name\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"errorNum\" : 1203 \n}\n

\n
Example: ///\n/// Illegal document\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document?collection=products <<EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 400, \n  \"error\" : true, \n  \"errorMessage\" : \"Parse error: Expecting '\\\\\\\"' or '}'\", \n  \"errorNum\" : 600 \n}\n

\n///\n/// Insert multiple documents:\n/// TODO, make this example work.\n///\n/// @ EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostMulti}\n/// var cn = \"products\";\n/// db._drop(cn);\n///\n/// var url = \"/_api/document/\" + cn;\n/// var body = '[{\"Hello\":\"Earth\"}, {\"Hello\":\"Venus\"}, {\"Hello\":\"Mars\"}]';\n///\n/// var response = logCurlRequest('POST', url, body);\n///\n/// assert(response.code === 200);\n///\n/// logJsonResponse(response);\n/// @ END_EXAMPLE_ARANGOSH_RUN\n///\n/// Use of returnNew:\n/// TODO, make this example work.\n///\n/// @ EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostMulti}\n/// var cn = \"products\";\n/// db._drop(cn);\n///\n/// var url = \"/_api/document/\" + cn + \"?returnNew=true\";\n/// var body = '{\"Hello\":\"World\"}';\n///\n/// var response = logCurlRequest('POST', url, body);\n///\n/// assert(response.code === 200);\n///\n/// logJsonResponse(response);\n/// @ END_EXAMPLE_ARANGOSH_RUN\n/// \n////////////////////////////////////////////////////////////////////////////////\n", + "parameters": [ + { + "description": "/// A JSON representation of a single document or of an array of documents.\n///\n", + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "additionalProperties": {}, + "type": "object" + }, + "x-description-offset": 0 + }, + { + "description": "/// 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 query parameter was required. This combination still works, but\n/// the recommended way is to specify the collection in the URL path.\n///\n", + "in": "query", + "name": "collection", + "required": false, + "type": "string" + }, { "description": "/// Wait until document has been synced to disk.\n///\n", "in": "query", "name": "waitForSync", "required": false, "type": "boolean" + }, + { + "description": "/// Return additionally the complete new document under the attribute *new*\n/// in the result.\n///\n", + "in": "query", + "name": "returnNew", + "required": false, + "type": "boolean" } ], "responses": { "201": { - "description": "/// is returned if the document was created successfully and *waitForSync* was\n/// *true*.\n///\n" + "description": "/// is returned if the documents were created successfully and\n/// *waitForSync* was *true*.\n///\n" }, "202": { - "description": "/// is returned if the document was created successfully and *waitForSync* was\n/// *false*.\n///\n" + "description": "/// is returned if the documents were created successfully and\n/// *waitForSync* was *false*.\n///\n" }, "400": { - "description": "/// is returned if the body does not contain a valid JSON representation of a\n/// document. The response body contains an error document in this case.\n///\n" + "description": "/// is returned if the body does not contain a valid JSON representation\n/// of one document or an array of documents. The response body contains\n/// an error document in this case.\n///\n" }, "404": { - "description": "/// is returned if the collection specified by *collection* is unknown. The\n/// response body contains an error document in this case.\n///\n" + "description": "/// is returned if the collection specified by *collection* is unknown.\n/// The response body contains an error document in this case.\n///\n" + }, + "409": { + "description": "/// is returned if a document with the same qualifiers in an indexed\n/// attribute conflicts with an already existing document and thus\n/// violating that uniq constraint. The response body contains an error\n/// document in this case.\n///\n" } }, "summary": "Create document", @@ -3564,12 +3729,87 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" + }, + "put": { + "description": "\nfree style json body\n\n\n\n/// Replaces multiple documents in the specified collection with the\n/// ones in the body, the replaced documents are specified by the *_key*\n/// attributes in the body documents. The operation is only performed,\n/// if no precondition is violated and the operation succeeds for all\n/// documents or fails without replacing a single document.\n///\n/// If *ignoreRevs* is *false* and there is a *_rev* attribute in a\n/// document in the body and its value does not match the revision of\n/// the corresponding document in the database, the precondition is\n/// violated.\n///\n/// If the document exists and can be updated, then an *HTTP 201* or\n/// an *HTTP 202* is returned (depending on *waitForSync*, see below).\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document replacement operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON array with the information\n/// about the handle and the revision of the replaced documents. The\n/// attribute *_id* contains the known *document-handle* of each updated\n/// document, *_key* contains the key which uniquely identifies a\n/// document in a given collection, and the attribute *_rev* contains\n/// the new document revision.\n///\n/// If the query parameter *returnOld* is *true*, then, for each\n/// generated document, the complete previous revision of the document\n/// is returned under the *old* attribute in the result.\n///\n/// If the query parameter *returnNew* is *true*, then, for each\n/// generated document, the complete new document is returned under\n/// the *new* attribute in the result.\n///\n/// If any of the document does not exist, then a *HTTP 404* is returned\n/// and the body of the response contains an error document.\n///\n", + "parameters": [ + { + "description": "/// A JSON representation of an array of documents.\n///\n", + "in": "body", + "name": "Json Post Body", + "required": true, + "schema": { + "additionalProperties": {}, + "type": "object" + }, + "x-description-offset": 0 + }, + { + "description": "/// This URL parameter is the name of the collection in which the\n/// documents are replaced.\n///\n", + "format": "string", + "in": "path", + "name": "collection", + "required": true, + "type": "string" + }, + { + "description": "/// Wait until the new documents have been synced to disk.\n///\n", + "in": "query", + "name": "waitForSync", + "required": false, + "type": "boolean" + }, + { + "description": "/// By default, or if this is set to *true*, the *_rev* attributes in \n/// the given documents are ignored. If this is set to *false*, then\n/// any *_rev* attribute given in a body document is taken as a\n/// precondition. The document is only replaced if the current revision\n/// is the one specified.\n///\n", + "in": "query", + "name": "ignoreRevs", + "required": false, + "type": "boolean" + }, + { + "description": "/// Return additionally the complete previous revision of the changed \n/// documents under the attribute *old* in the result.\n///\n", + "in": "query", + "name": "returnOld", + "required": false, + "type": "boolean" + }, + { + "description": "/// Return additionally the complete new documents under the attribute *new*\n/// in the result.\n///\n", + "in": "query", + "name": "returnNew", + "required": false, + "type": "boolean" + } + ], + "responses": { + "201": { + "description": "/// is returned if the documents were replaced successfully and\n/// *waitForSync* was *true*.\n///\n" + }, + "202": { + "description": "/// is returned if the documents were replaced successfully and\n/// *waitForSync* was *false*.\n///\n" + }, + "400": { + "description": "/// is returned if the body does not contain a valid JSON representation\n/// of an array of documents. The response body contains\n/// an error document in this case.\n///\n" + }, + "404": { + "description": "/// is returned if the collection or a document was not found.\n///\n" + }, + "412": { + "description": "/// is returned if the precondition was violated. The response will\n/// also contain the found documents' current revisions in the *_rev*\n/// attributes. Additionally, the attributes *_id* and *_key* will be\n/// returned.\n///\n/// \n////////////////////////////////////////////////////////////////////////////////\n" + } + }, + "summary": "Replace documents", + "tags": [ + "Documents" + ], + "x-examples": [], + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" } }, "/_api/document/{document-handle}": { "delete": { - "description": "\n\n/// The body of the response contains a JSON object with the information about\n/// the handle and the revision. The attribute *_id* contains the known\n/// *document-handle* of the removed document, *_key* contains the key which\n/// uniquely identifies a document in a given collection, and the attribute *_rev*\n/// contains the new document revision.\n///\n/// If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n\n
Example: ///\n/// Using document handle:\n///

shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/727128786\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/727128786\", \n  \"_rev\" : \"727128786\", \n  \"_key\" : \"727128786\" \n}\n

\n
Example: ///\n/// Unknown document handle:\n///

shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/728832722\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"errorNum\" : 1202 \n}\n

\n
Example: ///\n/// Revision conflict:\n///

shell> curl -X DELETE --header 'If-Match: \"728177362\"' --dump - http://localhost:8529/_api/document/products/727849682\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"727849682\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/727849682\", \n  \"_rev\" : \"727849682\", \n  \"_key\" : \"727849682\" \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "\n\n/// The body of the response contains a JSON object with the information\n/// about the handle and the revision. The attribute *_id* contains the\n/// known *document-handle* of the removed document, *_key* contains the\n/// key which uniquely identifies a document in a given collection, and\n/// the attribute *_rev* contains the document revision.\n///\n/// If the *waitForSync* parameter is not specified or set to *false*,\n/// then the collection's default *waitForSync* behavior is applied.\n/// The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync*\n/// value of *true*.\n///\n/// If the query parameter *returnOld* is *true*, then\n/// the complete previous revision of the document\n/// is returned under the *old* attribute in the result.\n///\n\n
Example: ///\n/// Using document handle:\n///

shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/727128786\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/727128786\", \n  \"_rev\" : \"727128786\", \n  \"_key\" : \"727128786\" \n}\n

\n
Example: ///\n/// Unknown document handle:\n///

shell> curl -X DELETE --dump - http://localhost:8529/_api/document/products/728832722\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"errorNum\" : 1202 \n}\n

\n
Example: ///\n/// Revision conflict:\n///

shell> curl -X DELETE --header 'If-Match: \"728177362\"' --dump - http://localhost:8529/_api/document/products/727849682\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"727849682\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/727849682\", \n  \"_rev\" : \"727849682\", \n  \"_key\" : \"727849682\" \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { "description": "/// Removes the document identified by *document-handle*.\n///\n", @@ -3579,20 +3819,6 @@ "required": true, "type": "string" }, - { - "description": "/// You can conditionally remove a document based on a target revision id by\n/// using the *rev* query parameter.\n///\n", - "in": "query", - "name": "rev", - "required": false, - "type": "string" - }, - { - "description": "/// To control the update behavior in case there is a revision mismatch, you\n/// can use the *policy* parameter. This is the same as when replacing\n/// documents (see replacing documents for more details).\n///\n", - "in": "query", - "name": "policy", - "required": false, - "type": "string" - }, { "description": "/// Wait until deletion operation has been synced to disk.\n///\n", "in": "query", @@ -3600,6 +3826,13 @@ "required": false, "type": "boolean" }, + { + "description": "/// Return additionally the complete previous revision of the changed \n/// document under the attribute *old* in the result.\n///\n", + "in": "query", + "name": "returnOld", + "required": false, + "type": "boolean" + }, { "description": "/// You can conditionally remove a document based on a target revision id by\n/// using the *if-match* HTTP header.\n///\n", "in": "header", @@ -3609,10 +3842,10 @@ ], "responses": { "200": { - "description": "/// is returned if the document was removed successfully and *waitForSync* was\n/// *true*.\n///\n" + "description": "/// is returned if the document was removed successfully and\n/// *waitForSync* was *true*.\n///\n" }, "202": { - "description": "/// is returned if the document was removed successfully and *waitForSync* was\n/// *false*.\n///\n" + "description": "/// is returned if the document was removed successfully and\n/// *waitForSync* was *false*.\n///\n" }, "404": { "description": "/// is returned if the collection or the document was not found.\n/// The response body contains an error document in this case.\n///\n" @@ -3626,10 +3859,10 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" }, "get": { - "description": "\n\n/// Returns the document identified by *document-handle*. The returned\n/// document contains three special attributes: *_id* containing the document\n/// handle, *_key* containing key which uniquely identifies a document\n/// in a given collection and *_rev* containing the revision.\n///\n\n
Example: ///\n/// Use a document handle:\n///

shell> curl --dump - http://localhost:8529/_api/document/products/735582930\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"735582930\"\n\n{ \n  \"hello\" : \"world\", \n  \"_id\" : \"products/735582930\", \n  \"_rev\" : \"735582930\", \n  \"_key\" : \"735582930\" \n}\n

\n
Example: ///\n/// Use a document handle and an etag:\n///

shell> curl --header 'If-None-Match: \"739252946\"' --dump - http://localhost:8529/_api/document/products/739252946\n\n

\n
Example: ///\n/// Unknown document handle:\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  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"errorNum\" : 1203 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "\n\n/// Returns the document identified by *document-handle*. The returned\n/// document contains three special attributes: *_id* containing the document\n/// handle, *_key* containing key which uniquely identifies a document\n/// in a given collection and *_rev* containing the revision.\n///\n\n
Example: ///\n/// Use a document handle:\n///

shell> curl --dump - http://localhost:8529/_api/document/products/735582930\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"735582930\"\n\n{ \n  \"hello\" : \"world\", \n  \"_id\" : \"products/735582930\", \n  \"_rev\" : \"735582930\", \n  \"_key\" : \"735582930\" \n}\n

\n
Example: ///\n/// Use a document handle and an etag:\n///

shell> curl --header 'If-None-Match: \"739252946\"' --dump - http://localhost:8529/_api/document/products/739252946\n\n

\n
Example: ///\n/// Unknown document handle:\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  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"collection 'products' not found\", \n  \"errorNum\" : 1203 \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { "description": "/// The handle of the document.\n///\n", @@ -3640,13 +3873,13 @@ "type": "string" }, { - "description": "/// If the \"If-None-Match\" header is given, then it must contain exactly one\n/// etag. The document is returned, if it has a different revision than the\n/// given etag. Otherwise an *HTTP 304* is returned.\n///\n", + "description": "/// If the \"If-None-Match\" header is given, then it must contain exactly one\n/// ETag. The document is returned, if it has a different revision than the\n/// given ETag. Otherwise an *HTTP 304* is returned.\n///\n", "in": "header", "name": "If-None-Match", "type": "string" }, { - "description": "/// If the \"If-Match\" header is given, then it must contain exactly one\n/// etag. The document is returned, if it has the same revision as the\n/// given etag. Otherwise a *HTTP 412* is returned. As an alternative\n/// you can supply the etag in an attribute *rev* in the URL.\n///\n", + "description": "/// If the \"If-Match\" header is given, then it must contain exactly one\n/// ETag. The document is returned, if it has the same revision as the\n/// given ETag. Otherwise a *HTTP 412* is returned.\n///\n", "in": "header", "name": "If-Match", "type": "string" @@ -3663,7 +3896,7 @@ "description": "/// is returned if the document or collection was not found\n///\n" }, "412": { - "description": "/// is returned if a \"If-Match\" header or *rev* is given and the found\n/// document has a different version. The response will also contain the found\n/// document's current revision in the *_rev* attribute. Additionally, the\n/// attributes *_id* and *_key* will be returned.\n///\n" + "description": "/// is returned if an \"If-Match\" header is given and the found\n/// document has a different version. The response will also contain the found\n/// document's current revision in the *_rev* attribute. Additionally, the\n/// attributes *_id* and *_key* will be returned.\n///\n" } }, "summary": "Read document", @@ -3671,10 +3904,10 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" }, "head": { - "description": "\n\n/// Like *GET*, but only returns the header fields and not the body. You\n/// can use this call to get the current revision of a document or check if\n/// the document was deleted.\n///\n\n
Example: ///

shell> curl -X HEAD --dump - http://localhost:8529/_api/document/products/738663122\n\n

\n/// \n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "\n\n/// Like *GET*, but only returns the header fields and not the body. You\n/// can use this call to get the current revision of a document or check if\n/// the document was deleted.\n///\n\n
Example: ///

shell> curl -X HEAD --dump - http://localhost:8529/_api/document/products/738663122\n\n

\n/// \n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { "description": "/// The handle of the document.\n///\n", @@ -3685,20 +3918,13 @@ "type": "string" }, { - "description": "/// You can conditionally fetch a document based on a target revision id by\n/// using the *rev* query parameter.\n///\n", - "in": "query", - "name": "rev", - "required": false, - "type": "string" - }, - { - "description": "/// If the \"If-None-Match\" header is given, then it must contain exactly one\n/// etag. If the current document revision is different to the specified etag,\n/// an *HTTP 200* response is returned. If the current document revision is\n/// identical to the specified etag, then an *HTTP 304* is returned.\n///\n", + "description": "/// If the \"If-None-Match\" header is given, then it must contain exactly one\n/// ETag. If the current document revision is not equal to the specified ETag,\n/// an *HTTP 200* response is returned. If the current document revision is\n/// identical to the specified ETag, then an *HTTP 304* is returned.\n///\n", "in": "header", "name": "If-None-Match", "type": "string" }, { - "description": "/// You can conditionally fetch a document based on a target revision id by\n/// using the *if-match* HTTP header.\n///\n", + "description": "/// If the \"If-Match\" header is given, then it must contain exactly one\n/// ETag. The document is returned, if it has the same revision as the\n/// given ETag. Otherwise a *HTTP 412* is returned.\n///\n", "in": "header", "name": "If-Match", "type": "string" @@ -3709,13 +3935,13 @@ "description": "/// is returned if the document was found\n///\n" }, "304": { - "description": "/// is returned if the \"If-None-Match\" header is given and the document has\n/// same version\n///*\n" + "description": "/// is returned if the \"If-None-Match\" header is given and the document has\n/// the same version\n///\n" }, "404": { "description": "/// is returned if the document or collection was not found\n///\n" }, "412": { - "description": "/// is returned if a \"If-Match\" header or *rev* is given and the found\n/// document has a different version. The response will also contain the found\n/// document's current revision in the *etag* header.\n///\n" + "description": "/// is returned if an \"If-Match\" header is given and the found\n/// document has a different version. The response will also contain the found\n/// document's current revision in the *ETag* header.\n///\n" } }, "summary": "Read document header", @@ -3723,13 +3949,13 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" }, "patch": { - "description": "\nfree style json body\n\n\n\n/// Partially updates the document identified by *document-handle*.\n/// The body of the request must contain a JSON document with the attributes\n/// to patch (the patch document). All attributes from the patch document will\n/// be added to the existing document if they do not yet exist, and overwritten\n/// in the existing document if they do exist there.\n///\n/// Setting an attribute value to *null* in the patch document will cause a\n/// value of *null* be saved for the attribute by default.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document update operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON object with the information about\n/// the handle and the revision. The attribute *_id* contains the known\n/// *document-handle* of the updated document, *_key* contains the key which \n/// uniquely identifies a document in a given collection, and the attribute *_rev*\n/// contains the new document revision.\n///\n/// If the document does not exist, then a *HTTP 404* is returned and the\n/// body of the response contains an error document.\n///\n/// You can conditionally update a document based on a target revision id by\n/// using either the *rev* query parameter or the *if-match* HTTP header.\n/// To control the update behavior in case there is a revision mismatch, you\n/// can use the *policy* parameter. This is the same as when replacing\n/// documents (see replacing documents for details).\n///\n\n
Example: ///\n/// patches an existing document with new content.\n///

shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/729684690 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"730012370\"\nlocation: /_db/_system/_api/document/products/729684690\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"730012370\", \n  \"_key\" : \"729684690\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/729684690 <<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: \"730602194\"\nlocation: /_db/_system/_api/document/products/729684690\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"730602194\", \n  \"_key\" : \"729684690\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/729684690\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"730602194\"\n\n{ \n  \"one\" : \"world\", \n  \"hello\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2 \n  }, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"730602194\", \n  \"_key\" : \"729684690\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/729684690?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: \"731060946\"\nlocation: /_db/_system/_api/document/products/729684690\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"731060946\", \n  \"_key\" : \"729684690\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/729684690\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"731060946\"\n\n{ \n  \"one\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  }, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"731060946\", \n  \"_key\" : \"729684690\" \n}\n

\n
Example: ///\n/// Merging attributes of an object using `mergeObjects`:\n///

shell> curl --dump - http://localhost:8529/_api/document/products/731912914\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"731912914\"\n\n{ \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000 \n  }, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"731912914\", \n  \"_key\" : \"731912914\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/731912914?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/731912914\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"732437202\"\n\n{ \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000, \n    \"brazil\" : 203553000, \n    \"indonesia\" : 252164800 \n  }, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"732437202\", \n  \"_key\" : \"731912914\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/731912914?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: \"732895954\"\nlocation: /_db/_system/_api/document/products/731912914\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"732895954\", \n  \"_key\" : \"731912914\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/731912914\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"732895954\"\n\n{ \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  }, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"732895954\", \n  \"_key\" : \"731912914\" \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "\nfree style json body\n\n\n\n/// Partially updates the document identified by *document-handle*.\n/// The body of the request must contain a JSON document with the\n/// attributes to patch (the patch document). All attributes from the\n/// patch document will be added to the existing document if they do not\n/// yet exist, and overwritten in the existing document if they do exist\n/// there.\n///\n/// Setting an attribute value to *null* in the patch document will cause a\n/// value of *null* to be saved for the attribute by default.\n///\n/// If the *If-Match* header is specified and the revision of the\n/// document in the database is unequal to the given revision, the\n/// precondition is violated.\n///\n/// If *If-Match* is not given and *ignoreRevs* is *false* and there\n/// is a *_rev* attribute in the body and its value does not match\n/// the revision of the document in the database, the precondition is\n/// violated.\n///\n/// If a precondition is violated, an *HTTP 412* is returned.\n///\n/// If the document exists and can be updated, then an *HTTP 201* or\n/// an *HTTP 202* is returned (depending on *waitForSync*, see below),\n/// the *ETag* header field contains the new revision of the document\n/// and the *Location* header contains a complete URL under which the\n/// document can be queried.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the updated document operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON object with the information\n/// about the handle and the revision. The attribute *_id* contains the\n/// known *document-handle* of the updated document, *_key* contains the\n/// key which uniquely identifies a document in a given collection, and\n/// the attribute *_rev* contains the new document revision.\n///\n/// If the query parameter *returnOld* is *true*, then\n/// the complete previous revision of the document\n/// is returned under the *old* attribute in the result.\n///\n/// If the query parameter *returnNew* is *true*, then\n/// the complete new document is returned under\n/// the *new* attribute in the result.\n///\n/// If the document does not exist, then a *HTTP 404* is returned and the\n/// body of the response contains an error document.\n///\n\n
Example: ///\n/// Patches an existing document with new content.\n///

shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/729684690 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"730012370\"\nlocation: /_db/_system/_api/document/products/729684690\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"730012370\", \n  \"_key\" : \"729684690\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/729684690 <<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: \"730602194\"\nlocation: /_db/_system/_api/document/products/729684690\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"730602194\", \n  \"_key\" : \"729684690\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/729684690\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"730602194\"\n\n{ \n  \"one\" : \"world\", \n  \"hello\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2 \n  }, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"730602194\", \n  \"_key\" : \"729684690\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/729684690?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: \"731060946\"\nlocation: /_db/_system/_api/document/products/729684690\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"731060946\", \n  \"_key\" : \"729684690\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/729684690\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"731060946\"\n\n{ \n  \"one\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  }, \n  \"_id\" : \"products/729684690\", \n  \"_rev\" : \"731060946\", \n  \"_key\" : \"729684690\" \n}\n

\n
Example: ///\n/// Merging attributes of an object using `mergeObjects`:\n///

shell> curl --dump - http://localhost:8529/_api/document/products/731912914\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"731912914\"\n\n{ \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000 \n  }, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"731912914\", \n  \"_key\" : \"731912914\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/731912914?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/731912914\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"732437202\"\n\n{ \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000, \n    \"brazil\" : 203553000, \n    \"indonesia\" : 252164800 \n  }, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"732437202\", \n  \"_key\" : \"731912914\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/731912914?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: \"732895954\"\nlocation: /_db/_system/_api/document/products/731912914\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"732895954\", \n  \"_key\" : \"731912914\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/731912914\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"732895954\"\n\n{ \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  }, \n  \"_id\" : \"products/731912914\", \n  \"_rev\" : \"732895954\", \n  \"_key\" : \"731912914\" \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { - "description": "/// A JSON representation of the document update.\n///\n", + "description": "/// A JSON representation of a document update as an object.\n///\n", "in": "body", "name": "Json Post Body", "required": true, @@ -3740,7 +3966,7 @@ "x-description-offset": 0 }, { - "description": "/// The handle of the document.\n///\n", + "description": "/// This URL parameter must be a document handle.\n///\n", "format": "string", "in": "path", "name": "document-handle", @@ -3748,14 +3974,14 @@ "type": "string" }, { - "description": "/// If the intention is to delete existing attributes with the patch command,\n/// the URL query parameter *keepNull* can be used with a value of *false*.\n/// This will modify the behavior of the patch command to remove any attributes\n/// from the existing document that are contained in the patch document with an\n/// attribute value of *null*.\n///\n", + "description": "/// If the intention is to delete existing attributes with the patch\n/// command, the URL query parameter *keepNull* can be used with a value\n/// of *false*. This will modify the behavior of the patch command to\n/// remove any attributes from the existing document that are contained\n/// in the patch document with an attribute value of *null*.\n///\n", "in": "query", "name": "keepNull", "required": false, "type": "boolean" }, { - "description": "/// Controls whether objects (not arrays) will be merged if present in both the\n/// existing and the patch document. If set to *false*, the value in the\n/// patch document will overwrite the existing document's value. If set to\n/// *true*, objects will be merged. The default is *true*.\n///\n", + "description": "/// Controls whether objects (not arrays) will be merged if present in\n/// both the existing and the patch document. If set to *false*, the\n/// value in the patch document will overwrite the existing document's\n/// value. If set to *true*, objects will be merged. The default is\n/// *true*.\n///\n", "in": "query", "name": "mergeObjects", "required": false, @@ -3769,21 +3995,28 @@ "type": "boolean" }, { - "description": "/// You can conditionally patch a document based on a target revision id by\n/// using the *rev* query parameter.\n///\n", + "description": "/// By default, or if this is set to *true*, the *_rev* attributes in \n/// the given document is ignored. If this is set to *false*, then\n/// the *_rev* attribute given in the body document is taken as a\n/// precondition. The document is only updated if the current revision\n/// is the one specified.\n///\n", "in": "query", - "name": "rev", + "name": "ignoreRevs", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "/// To control the update behavior in case there is a revision mismatch, you\n/// can use the *policy* parameter.\n///\n", + "description": "/// Return additionally the complete previous revision of the changed \n/// document under the attribute *old* in the result.\n///\n", "in": "query", - "name": "policy", + "name": "returnOld", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "/// You can conditionally patch a document based on a target revision id by\n/// using the *if-match* HTTP header.\n///\n", + "description": "/// Return additionally the complete new document under the attribute *new*\n/// in the result.\n///\n", + "in": "query", + "name": "returnNew", + "required": false, + "type": "boolean" + }, + { + "description": "/// You can conditionally update a document based on a target revision id by\n/// using the *if-match* HTTP header.\n///\n", "in": "header", "name": "If-Match", "type": "string" @@ -3791,33 +4024,33 @@ ], "responses": { "201": { - "description": "/// is returned if the document was created successfully and *waitForSync* was\n/// *true*.\n///\n" + "description": "/// is returned if the document was updated successfully and\n/// *waitForSync* was *true*.\n///\n" }, "202": { - "description": "/// is returned if the document was created successfully and *waitForSync* was\n/// *false*.\n///\n" + "description": "/// is returned if the document was updated successfully and\n/// *waitForSync* was *false*.\n///\n" }, "400": { - "description": "/// is returned if the body does not contain a valid JSON representation of a\n/// document. The response body contains an error document in this case.\n///\n" + "description": "/// is returned if the body does not contain a valid JSON representation\n/// of a document. The response body contains\n/// an error document in this case.\n///\n" }, "404": { - "description": "/// is returned if the collection or the document was not found\n///\n" + "description": "/// is returned if the collection or the document was not found.\n///\n" }, "412": { - "description": "/// is returned if a \"If-Match\" header or *rev* is given and the found\n/// document has a different version. The response will also contain the found\n/// document's current revision in the *_rev* attribute. Additionally, the\n/// attributes *_id* and *_key* will be returned.\n///\n" + "description": "/// is returned if the precondition was violated. The response will\n/// also contain the found documents' current revisions in the *_rev*\n/// attributes. Additionally, the attributes *_id* and *_key* will be\n/// returned.\n///\n" } }, - "summary": " Patch document", + "summary": "Update document", "tags": [ "Documents" ], "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" }, "put": { - "description": "\nfree style json body\n\n\n\n/// Completely updates (i.e. replaces) the document identified by *document-handle*.\n/// If the document exists and can be updated, then a *HTTP 201* is returned\n/// and the \"ETag\" header field contains the new revision of the document.\n///\n/// If the new document passed in the body of the request contains the\n/// *document-handle* in the attribute *_id* and the revision in *_rev*,\n/// these attributes will be ignored. Only the URI and the \"ETag\" header are\n/// relevant in order to avoid confusion when using proxies.\n///\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document replacement operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n///\n/// The body of the response contains a JSON object with the information about\n/// the handle and the revision. The attribute *_id* contains the known\n/// *document-handle* of the updated document, *_key* contains the key which \n/// uniquely identifies a document in a given collection, and the attribute *_rev*\n/// contains the new document revision.\n///\n/// If the document does not exist, then a *HTTP 404* is returned and the\n/// body of the response contains an error document.\n///\n/// There are two ways for specifying the targeted document revision id for\n/// conditional replacements (i.e. replacements that will only be executed if\n/// the revision id found in the database matches the document revision id specified\n/// in the request):\n/// - specifying the target revision in the *rev* URL query parameter\n/// - specifying the target revision in the *if-match* HTTP header\n///\n///\n/// Specifying a target revision is optional, however, if done, only one of the\n/// described mechanisms must be used (either the *rev* query parameter or the\n/// *if-match* HTTP header).\n/// Regardless which mechanism is used, the parameter needs to contain the target\n/// document revision id as returned in the *_rev* attribute of a document or\n/// by an HTTP *etag* header.\n///\n/// For example, to conditionally replace a document based on a specific revision\n/// id, you can use the following request:\n///\n///\n/// `PUT /_api/document/document-handle?rev=etag`\n///\n///\n/// If a target revision id is provided in the request (e.g. via the *etag* value\n/// in the *rev* URL query parameter above), ArangoDB will check that\n/// the revision id of the document found in the database is equal to the target\n/// revision id provided in the request. If there is a mismatch between the revision\n/// id, then by default a *HTTP 412* conflict is returned and no replacement is\n/// performed.\n///\n///\n/// The conditional update behavior can be overridden with the *policy* URL query parameter:\n///\n///\n/// `PUT /_api/document/document-handle?policy=policy`\n///\n///\n/// If *policy* is set to *error*, then the behavior is as before: replacements\n/// will fail if the revision id found in the database does not match the target\n/// revision id specified in the request.\n///\n/// If *policy* is set to *last*, then the replacement will succeed, even if the\n/// revision id found in the database does not match the target revision id specified\n/// in the request. You can use the *last* *policy* to force replacements.\n///\n\n
Example: ///\n/// Using a document handle\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/739842770 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"740170450\"\nlocation: /_db/_system/_api/document/products/739842770\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/739842770\", \n  \"_rev\" : \"740170450\", \n  \"_key\" : \"739842770\" \n}\n

\n
Example: ///\n/// Unknown document handle\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/744037074 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"errorNum\" : 1202 \n}\n

\n
Example: ///\n/// Produce a revision conflict\n///

shell> curl -X PUT --header 'If-Match: \"741022418\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/740694738 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"740694738\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/740694738\", \n  \"_rev\" : \"740694738\", \n  \"_key\" : \"740694738\" \n}\n

\n
Example: ///\n/// Last write wins\n///

shell> curl -X PUT --header 'If-Match: \"742136530\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/741808850?policy=last <<EOF\n{}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"742398674\"\nlocation: /_db/_system/_api/document/products/741808850\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/741808850\", \n  \"_rev\" : \"742398674\", \n  \"_key\" : \"741808850\" \n}\n

\n
Example: ///\n/// Alternative to header fields\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/742922962?rev=743250642 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"742922962\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/742922962\", \n  \"_rev\" : \"742922962\", \n  \"_key\" : \"742922962\" \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "\nfree style json body\n\n\n\n/// Replaces the document with handle with the one in\n/// the body, provided there is such a document and no precondition is\n/// violated.\n///\n/// If the *If-Match* header is specified and the revision of the\n/// document in the database is unequal to the given revision, the\n/// precondition is violated.\n///\n/// If *If-Match* is not given and *ignoreRevs* is *false* and there\n/// is a *_rev* attribute in the body and its value does not match\n/// the revision of the document in the database, the precondition is\n/// violated.\n///\n/// If a precondition is violated, an *HTTP 412* is returned.\n///\n/// If the document exists and can be updated, then an *HTTP 201* or\n/// an *HTTP 202* is returned (depending on *waitForSync*, see below),\n/// the *ETag* header field contains the new revision of the document\n/// and the *Location* header contains a complete URL under which the\n/// document can be queried.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the document replacement operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON object with the information\n/// about the handle and the revision. The attribute *_id* contains the\n/// known *document-handle* of the updated document, *_key* contains the\n/// key which uniquely identifies a document in a given collection, and\n/// the attribute *_rev* contains the new document revision.\n///\n/// If the query parameter *returnOld* is *true*, then\n/// the complete previous revision of the document\n/// is returned under the *old* attribute in the result.\n///\n/// If the query parameter *returnNew* is *true*, then\n/// the complete new document is returned under\n/// the *new* attribute in the result.\n///\n/// If the document does not exist, then a *HTTP 404* is returned and the\n/// body of the response contains an error document.\n///\n\n
Example: ///\n/// Using a document handle\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/739842770 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"740170450\"\nlocation: /_db/_system/_api/document/products/739842770\n\n{ \n  \"error\" : false, \n  \"_id\" : \"products/739842770\", \n  \"_rev\" : \"740170450\", \n  \"_key\" : \"739842770\" \n}\n

\n
Example: ///\n/// Unknown document handle\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/744037074 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"errorNum\" : 1202 \n}\n

\n
Example: ///\n/// Produce a revision conflict\n///

shell> curl -X PUT --header 'If-Match: \"741022418\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/740694738 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"740694738\"\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/740694738\", \n  \"_rev\" : \"740694738\", \n  \"_key\" : \"740694738\" \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { - "description": "/// A JSON representation of the new document.\n///\n", + "description": "/// A JSON representation of a single document.\n///\n", "in": "body", "name": "Json Post Body", "required": true, @@ -3828,7 +4061,7 @@ "x-description-offset": 0 }, { - "description": "/// The handle of the document.\n///\n", + "description": "/// This URL parameter must be a document handle.\n///\n", "format": "string", "in": "path", "name": "document-handle", @@ -3843,18 +4076,25 @@ "type": "boolean" }, { - "description": "/// You can conditionally replace a document based on a target revision id by\n/// using the *rev* query parameter.\n///\n", + "description": "/// By default, or if this is set to *true*, the *_rev* attributes in \n/// the given document is ignored. If this is set to *false*, then\n/// the *_rev* attribute given in the body document is taken as a\n/// precondition. The document is only replaced if the current revision\n/// is the one specified.\n///\n", "in": "query", - "name": "rev", + "name": "ignoreRevs", "required": false, - "type": "string" + "type": "boolean" }, { - "description": "/// To control the update behavior in case there is a revision mismatch, you\n/// can use the *policy* parameter (see below).\n///\n", + "description": "/// Return additionally the complete previous revision of the changed \n/// document under the attribute *old* in the result.\n///\n", "in": "query", - "name": "policy", + "name": "returnOld", "required": false, - "type": "string" + "type": "boolean" + }, + { + "description": "/// Return additionally the complete new document under the attribute *new*\n/// in the result.\n///\n", + "in": "query", + "name": "returnNew", + "required": false, + "type": "boolean" }, { "description": "/// You can conditionally replace a document based on a target revision id by\n/// using the *if-match* HTTP header.\n///\n", @@ -3865,19 +4105,19 @@ ], "responses": { "201": { - "description": "/// is returned if the document was replaced successfully and *waitForSync* was\n/// *true*.\n///\n" + "description": "/// is returned if the document was replaced successfully and\n/// *waitForSync* was *true*.\n///\n" }, "202": { - "description": "/// is returned if the document was replaced successfully and *waitForSync* was\n/// *false*.\n///\n" + "description": "/// is returned if the document was replaced successfully and\n/// *waitForSync* was *false*.\n///\n" }, "400": { - "description": "/// is returned if the body does not contain a valid JSON representation of a\n/// document. The response body contains an error document in this case.\n///\n" + "description": "/// is returned if the body does not contain a valid JSON representation\n/// of a document. The response body contains\n/// an error document in this case.\n///\n" }, "404": { - "description": "/// is returned if the collection or the document was not found\n///\n" + "description": "/// is returned if the collection or the document was not found.\n///\n" }, "412": { - "description": "/// is returned if a \"If-Match\" header or *rev* is given and the found\n/// document has a different version. The response will also contain the found\n/// document's current revision in the *_rev* attribute. Additionally, the\n/// attributes *_id* and *_key* will be returned.\n///\n" + "description": "/// is returned if the precondition was violated. The response will\n/// also contain the found documents' current revisions in the *_rev*\n/// attributes. Additionally, the attributes *_id* and *_key* will be\n/// returned.\n///\n" } }, "summary": "Replace document", @@ -3885,7 +4125,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_CREATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_ALL.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_DELETE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_UPDATE.md, ./Documentation/DocuBlocks/Rest//Documents/REST_DOCUMENT_REPLACE.md" + "x-filename": "Documents - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md" } }, "/_api/edge": { @@ -3913,7 +4153,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" }, "post": { "description": "\nfree style json body\n\n\n\n/// Creates a new edge document in the collection named *collection*. A JSON\n/// representation of the document must be passed as the body of the POST\n/// request.\n///\n/// The *from* and *to* handles are immutable once the edge has been created.\n///\n/// In all other respects the method works like *POST /document*.\n///\n\n
Example: ///\n/// Create an edge and read it back:\n///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/edge/?collection=edges&from=vertices/1&to=vertices/2 <<EOF\n{ \n  \"name\" : \"Emil\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"746920658\"\nlocation: /_db/_system/_api/edge/edges/746920658\n\n{ \n  \"error\" : false, \n  \"_id\" : \"edges/746920658\", \n  \"_rev\" : \"746920658\", \n  \"_key\" : \"746920658\" \n}\nshell> curl --dump - http://localhost:8529/_api/edge/edges/746920658\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"746920658\"\n\n{ \n  \"name\" : \"Emil\", \n  \"_id\" : \"edges/746920658\", \n  \"_rev\" : \"746920658\", \n  \"_key\" : \"746920658\", \n  \"_from\" : \"vertices/1\", \n  \"_to\" : \"vertices/2\" \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -3984,7 +4224,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" } }, "/_api/edge/{document-handle}": { @@ -4046,7 +4286,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" }, "get": { "description": "\n\n/// Returns the edge identified by *document-handle*. The returned\n/// edge contains a few special attributes:\n///\n/// - *_id* contains the document handle\n///\n/// - *_rev* contains the revision\n///\n/// - *_from* and *to* contain the document handles of the connected\n/// vertex documents\n///\n", @@ -4091,7 +4331,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" }, "head": { "description": "\n\n/// Like *GET*, but only returns the header fields and not the body. You\n/// can use this call to get the current revision of an edge document or check if\n/// it was deleted.\n///\n", @@ -4143,7 +4383,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" }, "patch": { "description": "\nfree style json body\n\n\n\n/// Partially updates the edge document identified by *document-handle*.\n/// The body of the request must contain a JSON document with the attributes\n/// to patch (the patch document). All attributes from the patch document will\n/// be added to the existing edge document if they do not yet exist, and overwritten\n/// in the existing edge document if they do exist there.\n///\n/// Setting an attribute value to *null* in the patch document will cause a\n/// value of *null* be saved for the attribute by default.\n///\n/// **Note**: Internal attributes such as *_key*, *_from* and *_to* are immutable\n/// once set and cannot be updated.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the edge document update operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON object with the information about\n/// the handle and the revision. The attribute *_id* contains the known\n/// *document-handle* of the updated edge document, *_key* contains the key which \n/// uniquely identifies a document in a given collection, and the attribute *_rev*\n/// contains the new document revision.\n///\n/// If the edge document does not exist, then a *HTTP 404* is returned and the\n/// body of the response contains an error document.\n///\n/// You can conditionally update an edge document based on a target revision id by\n/// using either the *rev* query parameter or the *if-match* HTTP header.\n/// To control the update behavior in case there is a revision mismatch, you\n/// can use the *policy* parameter. This is the same as when replacing\n/// edge documents (see replacing documents for details).\n///\n", @@ -4231,7 +4471,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" }, "put": { "description": "\nfree style json body\n\n\n\n/// Completely updates (i.e. replaces) the edge document identified by *document-handle*.\n/// If the edge document exists and can be updated, then a *HTTP 201* is returned\n/// and the \"ETag\" header field contains the new revision of the edge document.\n///\n/// If the new edge document passed in the body of the request contains the\n/// *document-handle* in the attribute *_id* and the revision in *_rev*,\n/// these attributes will be ignored. Only the URI and the \"ETag\" header are\n/// relevant in order to avoid confusion when using proxies. \n/// **Note**: The attributes\n/// *_from* and *_to* of an edge are immutable and cannot be updated either.\n///\n/// Optionally, the query parameter *waitForSync* can be used to force\n/// synchronization of the edge document replacement operation to disk even in case\n/// that the *waitForSync* flag had been disabled for the entire collection.\n/// Thus, the *waitForSync* query parameter can be used to force synchronization\n/// of just specific operations. To use this, set the *waitForSync* parameter\n/// to *true*. If the *waitForSync* parameter is not specified or set to\n/// *false*, then the collection's default *waitForSync* behavior is\n/// applied. The *waitForSync* query parameter cannot be used to disable\n/// synchronization for collections that have a default *waitForSync* value\n/// of *true*.\n///\n/// The body of the response contains a JSON object with the information about\n/// the handle and the revision. The attribute *_id* contains the known\n/// *document-handle* of the updated edge document, *_key* contains the key which \n/// uniquely identifies a document in a given collection, and the attribute *_rev*\n/// contains the new document revision.\n///\n/// If the edge document does not exist, then a *HTTP 404* is returned and the\n/// body of the response contains an error document.\n///\n/// There are two ways for specifying the targeted revision id for\n/// conditional replacements (i.e. replacements that will only be executed if\n/// the revision id found in the database matches the revision id specified\n/// in the request):\n/// - specifying the target revision in the *rev* URL query parameter\n/// - specifying the target revision in the *if-match* HTTP header\n///\n/// Specifying a target revision is optional, however, if done, only one of the\n/// described mechanisms must be used (either the *rev* query parameter or the\n/// *if-match* HTTP header).\n/// Regardless which mechanism is used, the parameter needs to contain the target\n/// revision id as returned in the *_rev* attribute of an edge document or\n/// by an HTTP *etag* header.\n///\n/// For example, to conditionally replace an edge document based on a specific revision\n/// id, you can use the following request:\n///\n/// - PUT /_api/document/*document-handle*?rev=*etag*\n///\n/// If a target revision id is provided in the request (e.g. via the *etag* value\n/// in the *rev* URL query parameter above), ArangoDB will check that\n/// the revision id of the edge document found in the database is equal to the target\n/// revision id provided in the request. If there is a mismatch between the revision\n/// id, then by default a *HTTP 412* conflict is returned and no replacement is\n/// performed.\n///\n/// The conditional update behavior can be overridden with the *policy* URL query parameter:\n///\n/// - PUT /_api/document/*document-handle*?policy=*policy*\n///\n/// If *policy* is set to *error*, then the behavior is as before: replacements\n/// will fail if the revision id found in the database does not match the target\n/// revision id specified in the request.\n///\n/// If *policy* is set to *last*, then the replacement will succeed, even if the\n/// revision id found in the database does not match the target revision id specified\n/// in the request. You can use the *last* *policy* to force replacements.\n///\n", @@ -4305,7 +4545,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" } }, "/_api/edges/{collection-id}": { @@ -4351,7 +4591,7 @@ "Graph edges" ], "x-examples": [], - "x-filename": "Graph edges - ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_UPDATES.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_DELETE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READINOUTBOUND.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_REPLACE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_HEAD.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_CREATE.md, ./Documentation/DocuBlocks/Rest//Graph edges/API_EDGE_READ_ALL.md" + "x-filename": "Graph edges - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_UPDATES.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_HEAD.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_DELETE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ_ALL.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_CREATE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READ.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_REPLACE.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph edges/API_EDGE_READINOUTBOUND.md" } }, "/_api/endpoint": { @@ -4374,7 +4614,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_api/explain": { @@ -4407,7 +4647,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/export": { @@ -4453,7 +4693,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_document.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_json.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_batch_processing.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" } }, "/_api/gharial": { @@ -4470,7 +4710,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "post": { "description": "\n\n/// The creation of a graph requires the name of the graph and a definition of its edges.\n/// [See also edge definitions](../GeneralGraphs/Management.md#edge-definitions).\n///\n**A json post document with these Properties is required:**\n\n - **orphanCollections**: /// An array of additional vertex collections.\n ///\n - **edgeDefinitions**: /// An array of definitions for the edge\n ///\n - **name**: /// Name of the graph.\n ///\n\n\n\n
Example: ///

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 201 Created\ncontent-type: application/json\netag: 555817682\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \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\" : \"555817682\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4498,7 +4738,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}": { @@ -4518,7 +4758,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "get": { "description": "\n\n/// Gets a graph from the collection *\\_graphs*.\n/// Returns the definition content of this graph.\n///\n\n
Example: ///

shell> curl --dump - http://localhost:8529/_api/gharial/myGraph\n\nHTTP/1.1 200 OK\ncontent-type: application/json\netag: 580262610\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"580262610\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4536,7 +4776,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/edge": { @@ -4556,7 +4796,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "post": { "description": "\n\n/// Adds an additional edge definition to the graph.\n/// This edge definition has to contain a *collection* and an array of each *from* and *to* vertex collections.\n/// An edge definition can only be added if this definition is either not used in any other graph, or it is used\n/// with exactly the same definition. It is not possible to store a definition \"e\" from \"v1\" to \"v2\" in the one\n/// graph, and \"e\" from \"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.\n /// of type string\n - **from**: /// One or many vertex collections that can contain source vertices.\n /// of type string\n - **collection**: /// The name of the edge collection to be used.\n ///\n\n\n\n
Example: ///

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge <<EOF\n{ \n  \"collection\" : \"lives_in\", \n  \"from\" : [ \n    \"female\", \n    \"male\" \n  ], \n  \"to\" : [ \n    \"city\" \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json\netag: 543103698\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \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\" : \"lives_in\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"city\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"543103698\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4587,7 +4827,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}": { @@ -4622,7 +4862,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}": { @@ -4648,7 +4888,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "get": { "description": "\n\n/// Gets an edge from the given collection.\n///\n\n
Example: ///

shell> curl --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob\n\nHTTP/1.1 200 OK\ncontent-type: application/json\netag: 577968850\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_key\" : \"aliceAndBob\", \n    \"_rev\" : \"577968850\", \n    \"_from\" : \"female/alice\", \n    \"_to\" : \"male/bob\", \n    \"type\" : \"married\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4669,7 +4909,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "patch": { "description": "\n\n/// Updates the data of the specific edge in the collection.\n///\n\nfree style json body\n\n\n
Example: ///

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\netag: 609295058\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_rev\" : \"609295058\", \n    \"_oldRev\" : \"608180946\", \n    \"_key\" : \"aliceAndBob\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4702,7 +4942,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "put": { "description": "\n\n/// Replaces the data of an edge in the collection.\n///\n\nfree style json body\n\n\n
Example: ///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/aliceAndBob <<EOF\n{ \n  \"type\" : \"divorced\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json\netag: 613161682\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"edge\" : { \n    \"_id\" : \"relation/aliceAndBob\", \n    \"_rev\" : \"613161682\", \n    \"_oldRev\" : \"612178642\", \n    \"_key\" : \"aliceAndBob\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4738,7 +4978,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{definition-name}": { @@ -4761,7 +5001,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "post": { "description": "\n\n/// Change one specific edge definition.\n/// This 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.\n /// of type string\n - **from**: /// One or many vertex collections that can contain source vertices.\n /// of type string\n - **collection**: /// The name of the edge collection to be used.\n ///\n\n\n\n
Example: ///

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 200 OK\ncontent-type: application/json\netag: 622402258\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \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\" : \"622402258\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4792,7 +5032,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex": { @@ -4812,7 +5052,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "post": { "description": "\n\n/// Adds a vertex collection to the set of collections of the graph. If the\n/// collection does not exist, it will be created.\n///\n\n
Example: ///

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 201 Created\ncontent-type: application/json\netag: 551426770\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \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\" : \"551426770\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4830,7 +5070,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}": { @@ -4853,7 +5093,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "post": { "description": "\n\n/// Adds a vertex to the given collection.\n///\n\nfree style json body\n\n\n
Example: ///

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\netag: 549919442\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"vertex\" : { \n    \"_id\" : \"male/549919442\", \n    \"_rev\" : \"549919442\", \n    \"_key\" : \"549919442\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4886,7 +5126,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}": { @@ -4912,7 +5152,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "get": { "description": "\n\n/// Gets a vertex from the given collection.\n///\n\n
Example: ///

shell> curl --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice\n\nHTTP/1.1 200 OK\ncontent-type: application/json\netag: 582097618\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"582097618\", \n    \"name\" : \"Alice\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4933,7 +5173,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "patch": { "description": "\n\n/// Updates the data of the specific vertex in the collection.\n///\n\nfree style json body\n\n\n
Example: ///

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\netag: 605297362\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"605297362\", \n    \"_oldRev\" : \"603003602\", \n    \"_key\" : \"alice\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -4969,7 +5209,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" }, "put": { "description": "\n\n/// Replaces the data of a vertex in the collection.\n///\n\nfree style json body\n\n\n
Example: ///

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\netag: 629152466\n\n{ \n  \"error\" : false, \n  \"code\" : 202, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"629152466\", \n    \"_oldRev\" : \"626989778\", \n    \"_key\" : \"alice\" \n  } \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -5005,7 +5245,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_vertex_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_get_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_list_edge_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_modify_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_definition_remove_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_collection_add_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_replace_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_edge_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_create_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_drop_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_delete_http_examples.md, ./Documentation/DocuBlocks/Rest//Graph/JSF_general_graph_vertex_replace_http_examples.md" + "x-filename": "Graph - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md" } }, "/_api/import#document": { @@ -5105,7 +5345,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_document.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_json.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_batch_processing.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" } }, "/_api/import#json": { @@ -5212,7 +5452,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_document.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_import_json.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_batch_processing.md, ./Documentation/DocuBlocks/Rest//Bulk/JSF_post_api_export.md" + "x-filename": "Bulk - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" } }, "/_api/index": { @@ -5237,7 +5477,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "post": { "description": "**A json post document with these Properties is required:**\n\n - **fields**: /// an array of attribute paths.\n /// of type string\n - **unique**: /// if *true*, then create a unique index.\n ///\n - **type**: /// must be equal to *\"skiplist\"*.\n ///\n - **sparse**: /// if *true*, then create a sparse index.\n ///\n\n\n\n\n///\n/// Creates a skip-list index for the collection *collection-name*, if\n/// it does not already exist. The call expects an object containing the index\n/// details.\n///\n/// In a sparse index all documents will be excluded from the index that do not \n/// contain at least one of the specified index attributes (i.e. *fields*) or that \n/// have a value of *null* in any of the specified index attributes. Such documents \n/// will not be indexed, and not be taken into account for uniqueness checks if\n/// the *unique* flag is set.\n///\n/// In a non-sparse index, these documents will be indexed (for non-present\n/// indexed attributes, a value of *null* will be used) and will be taken into\n/// account 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
Example: ///\n/// Creating a skiplist index\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/788011730\", \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
Example: ///\n/// Creating a sparse skiplist index\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/789453522\", \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", @@ -5278,7 +5518,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/index#CapConstraints": { @@ -5321,7 +5561,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/index#fulltext": { @@ -5361,7 +5601,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/index#general": { @@ -5406,7 +5646,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/index#geo": { @@ -5446,7 +5686,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/index#hash": { @@ -5489,7 +5729,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/index/{index-handle}": { @@ -5518,7 +5758,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" }, "get": { "description": "\n\n///\n/// The result is an object describing the index. It has at least the following\n/// attributes:\n///\n/// - *id*: the identifier of the index\n///\n/// - *type*: the index type\n///\n/// All other attributes are type-dependent. For example, some indexes provide\n/// *unique* or *sparse* flags, whereas others don't. Some indexes also provide \n/// a selectivity estimate in the *selectivityEstimate* attribute of the result.\n///\n\n
Example: ///

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", @@ -5545,7 +5785,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_delete.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_skiplist.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_fulltext.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_hash.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_reads_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_get_api_index.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_geo.md, ./Documentation/DocuBlocks/Rest//Indexes/JSF_post_api_index_cap.md" + "x-filename": "Indexes - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_cap.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md" } }, "/_api/job/{job-id}": { @@ -5577,7 +5817,7 @@ "job" ], "x-examples": [], - "x-filename": "job - ./Documentation/DocuBlocks/Rest//job/JSF_job_cancel.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_fetch_result.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getStatusById.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getByType.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_delete.md" + "x-filename": "job - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" }, "put": { "description": "\n\n/// Returns the result of an async job identified by job-id. If the async job\n/// result is present on the server, the result will be removed from the list of\n/// result. That means this method can be called for each job-id once.\n/// The method will return the original job result's headers and body, plus the\n/// additional HTTP header x-arango-async-job-id. If this header is present,\n/// then\n/// the job was found and the response contains the original job's result. If\n/// the header is not present, the job was not found and the response contains\n/// status information from the job manager.\n///\n\n
Example: /// Not providing a job-id:\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  \"code\" : 400, \n  \"error\" : true, \n  \"errorMessage\" : \"bad parameter\", \n  \"errorNum\" : 400 \n}\n

\n
Example: ///\n/// Providing a job-id for a non-existing job:\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  \"code\" : 404, \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"errorNum\" : 404 \n}\n

\n
Example: ///\n/// Fetching the result of an HTTP GET job:\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: 145262130180444\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/145262130180444\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 145262130180444\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"2.8.0-devel\" \n}\n

\n
Example: ///\n/// Fetching the result of an HTTP POST job that failed:\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: 145262130180448\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/145262130180448\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-arango-async-id: 145262130180448\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", @@ -5607,7 +5847,7 @@ "job" ], "x-examples": [], - "x-filename": "job - ./Documentation/DocuBlocks/Rest//job/JSF_job_cancel.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_fetch_result.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getStatusById.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getByType.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_delete.md" + "x-filename": "job - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" } }, "/_api/job/{job-id}/cancel": { @@ -5639,7 +5879,7 @@ "job" ], "x-examples": [], - "x-filename": "job - ./Documentation/DocuBlocks/Rest//job/JSF_job_cancel.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_fetch_result.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getStatusById.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getByType.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_delete.md" + "x-filename": "job - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" } }, "/_api/job/{type}": { @@ -5671,7 +5911,7 @@ "job" ], "x-examples": [], - "x-filename": "job - ./Documentation/DocuBlocks/Rest//job/JSF_job_cancel.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_fetch_result.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getStatusById.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getByType.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_delete.md" + "x-filename": "job - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" }, "get": { "description": "\n\n/// Returns the list of ids of async jobs with a specific status (either done or\n/// pending).\n/// The list can be used by the client to get an overview of the job system\n/// status and\n/// to retrieve completed job results later.\n///\n\n
Example: ///\n/// Fetching the list of done jobs:\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: 145262130180454\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  \"145262130180454\" \n]\n

\n
Example: ///\n/// Fetching the list of pending jobs:\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: 145262130180458\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
Example: ///\n/// Querying the status of a pending job:\n/// (we create a sleep job therefore...)\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: 145262130180462\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  \"145262130180462\" \n]\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/145262130180462\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"result\" : true \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -5698,7 +5938,7 @@ "job" ], "x-examples": [], - "x-filename": "job - ./Documentation/DocuBlocks/Rest//job/JSF_job_cancel.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_fetch_result.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getStatusById.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_getByType.md, ./Documentation/DocuBlocks/Rest//job/JSF_job_delete.md" + "x-filename": "job - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md" } }, "/_api/query": { @@ -5728,7 +5968,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query-cache": { @@ -5748,7 +5988,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query-cache/properties": { @@ -5768,7 +6008,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "put": { "description": "\n\n/// After the properties have been changed, the current set of properties will\n/// be returned in the HTTP response.\n///\n/// Note: changing the properties may invalidate all results in the cache.\n/// The global properties for AQL query cache.\n/// The properties need to be passed in the attribute *properties* in the body\n/// of the HTTP request. *properties* needs to be a JSON object with the following\n/// properties:\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 ///\n - **maxResults**: /// the maximum number of query results that will be stored per database-specific cache.\n ///\n ///\n\n\n", @@ -5796,7 +6036,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query/current": { @@ -5816,7 +6056,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query/properties": { @@ -5836,7 +6076,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.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 ///\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 ///\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 ///\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 ///\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\n\n/// The properties need to be passed in the attribute *properties* in the body\n/// of the HTTP request. *properties* needs to be a JSON object.\n///\n/// After the properties have been changed, the current set of properties will\n/// be returned in the HTTP response.\n///\n", @@ -5864,7 +6104,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query/slow": { @@ -5884,7 +6124,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" }, "get": { "description": "\n\n/// Returns an array containing the last AQL queries that exceeded the slow\n/// query threshold in the selected database.\n/// The maximum amount of queries in the list can be controlled by setting\n/// the query tracking property `maxSlowQueries`. The threshold for treating\n/// a query as *slow* can be adjusted by setting the query tracking property\n/// `slowQueryThreshold`.\n///\n/// Each 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", @@ -5902,7 +6142,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/query/{query-id}": { @@ -5934,7 +6174,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCacheProperties.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryCurrent.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryCache.md, ./Documentation/DocuBlocks/Rest//AQL/PutApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQuerySlow.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_get_api_aqlfunction.md, ./Documentation/DocuBlocks/Rest//AQL/GetApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_post_api_explain.md, ./Documentation/DocuBlocks/Rest//AQL/PostApiQueryProperties.md, ./Documentation/DocuBlocks/Rest//AQL/DeleteApiQueryKill.md, ./Documentation/DocuBlocks/Rest//AQL/JSF_delete_api_aqlfunction.md" + "x-filename": "AQL - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md" } }, "/_api/replication/applier-config": { @@ -5957,7 +6197,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.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 ///\n - **includeSystem**: /// whether or not system collection operations will be applied\n ///\n - **endpoint**: /// the logger server to connect to (e.g. \"tcp://192.168.173.13:8529\"). The endpoint must be specified.\n ///\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 ///\n - **connectTimeout**: /// the timeout (in seconds) when attempting to connect to the\n /// endpoint. This value is used for each connection attempt.\n ///\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 ///\n - **database**: /// the name of the database on the endpoint. If not specified, defaults to the current local database name.\n ///\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 ///\n - **requestTimeout**: /// the timeout (in seconds) for individual requests to the endpoint.\n ///\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 ///\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 ///\n - **restrictCollections**: /// the array of collections to include or exclude,\n /// based on the setting of *restrictType*\n /// of type string\n - **restrictType**: /// the configuration for *restrictCollections*; Has to be either *include* or *exclude*\n ///\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 ///\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 ///\n - **autoStart**: /// whether or not to auto-start the replication applier on\n /// (next and following) server starts\n ///\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 ///\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 ///\n - **password**: /// the password to use when connecting to the endpoint.\n ///\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 ///\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 ///\n - **chunkSize**: /// the requested maximum size for log transfer packets that\n /// is used when the endpoint is contacted.\n ///\n\n\n\n\n/// Sets the configuration of the replication applier. The configuration can\n/// only be changed while the applier is not running. The updated configuration\n/// will be saved immediately but only become active with the next start of the\n/// applier.\n///\n/// In case of success, the body of the response is a JSON object with the updated\n/// configuration.\n///\n\n
Example: ///

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  \"adaptivePolling\" : true, \n  \"autoResync\" : false, \n  \"autoResyncRetries\" : 2, \n  \"autoStart\" : false, \n  \"chunkSize\" : 4194304, \n  \"connectTimeout\" : 10, \n  \"connectionRetryWaitTime\" : 15, \n  \"database\" : \"_system\", \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"idleMaxWaitTime\" : 2.5, \n  \"idleMinWaitTime\" : 0.5, \n  \"ignoreErrors\" : 0, \n  \"includeSystem\" : true, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"maxConnectRetries\" : 100, \n  \"requestTimeout\" : 600, \n  \"requireFromPresent\" : false, \n  \"restrictCollections\" : [ ], \n  \"restrictType\" : \"\", \n  \"sslProtocol\" : 0, \n  \"username\" : \"replicationApplier\", \n  \"verbose\" : false \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -5991,7 +6231,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/applier-start": { @@ -6025,7 +6265,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/applier-state": { @@ -6048,7 +6288,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/applier-stop": { @@ -6071,7 +6311,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/batch": { @@ -6104,7 +6344,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/batch/{id}": { @@ -6136,7 +6376,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.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\n\n/// Extends the ttl of an existing dump batch, using the batch's id and\n/// the provided ttl value.\n///\n/// If 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.\n/// The very same request is forwarded synchronously to that DBserver.\n/// It is an error if this attribute is not bound in the coordinator case.\n///\n", @@ -6175,7 +6415,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/clusterInventory": { @@ -6206,7 +6446,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/dump": { @@ -6295,7 +6535,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/inventory": { @@ -6326,7 +6566,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/logger-first-tick": { @@ -6352,7 +6592,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/logger-follow": { @@ -6413,7 +6653,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/logger-state": { @@ -6436,7 +6676,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/logger-tick-ranges": { @@ -6462,7 +6702,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/make-slave": { @@ -6501,7 +6741,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/server-id": { @@ -6524,7 +6764,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/replication/sync": { @@ -6563,7 +6803,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_return_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_post_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_start.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_serverID.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_stop.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_synchronize.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier_adjust.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_makeSlave.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_delete_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_api_replication_applier.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_dump.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_returns.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_cluster_inventory.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_applier_state.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_put_batch_replication.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_first_tick.md, ./Documentation/DocuBlocks/Rest//Replication/JSF_get_api_replication_logger_tick_ranges.md" + "x-filename": "Replication - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md" } }, "/_api/simple/all": { @@ -6598,7 +6838,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/any": { @@ -6631,7 +6871,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/by-example": { @@ -6664,7 +6904,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/first": { @@ -6697,7 +6937,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/first-example": { @@ -6730,7 +6970,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/fulltext": { @@ -6763,7 +7003,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/last": { @@ -6796,7 +7036,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/lookup-by-keys": { @@ -6829,7 +7069,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/near": { @@ -6862,7 +7102,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/range": { @@ -6895,12 +7135,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/remove-by-example": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **example**: /// An example document that all collection documents are compared against.\n ///\n - **collection**: /// The name of the collection to remove from.\n ///\n - **options**:\n - **limit**: /// an optional value that determines how many documents to\n /// delete at most. If *limit* is specified but is less than the number\n /// of documents in the collection, it is undefined which of the documents\n /// will be deleted.\n ///\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 ///\n\n\n\n\n///\n/// This will find all documents in the collection that match the specified\n/// example object.\n///\n/// Note: the *limit* attribute is not supported on sharded collections.\n/// Using it will result in an error.\n///\n/// Returns the number of documents that were deleted.\n///\n\n
Example: ///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// Using Parameter: waitForSync and limit\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"waitForSync\" : true, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// Using Parameter: waitForSync and limit with new signature\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"options\" : { \n    \"waitForSync\" : true, \n    \"limit\" : 2 \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "**A json post document with these Properties is required:**\n\n - **example**: /// An example document that all collection documents are compared against.\n ///\n - **collection**: /// The name of the collection to remove from.\n ///\n - **options**:\n - **limit**: /// an optional value that determines how many documents to\n /// delete at most. If *limit* is specified but is less than the number\n /// of documents in the collection, it is undefined which of the documents\n /// will be deleted.\n ///\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 ///\n\n\n\n\n///\n/// This will find all documents in the collection that match the specified\n/// example object.\n///\n/// Note: the *limit* attribute is not supported on sharded collections.\n/// Using it will result in an error.\n///\n/// Returns the number of documents that were deleted.\n///\n\n
Example: ///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// Using Parameter: waitForSync and limit\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"waitForSync\" : true, \n  \"limit\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// Using Parameter: waitForSync and limit with new signature\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/remove-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"options\" : { \n    \"waitForSync\" : true, \n    \"limit\" : 2 \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"deleted\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { "in": "body", @@ -6928,12 +7168,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.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.\n /// of type string\n - **options**:\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 ///\n - **collection**: /// The name of the collection to look in for the documents to remove\n ///\n\n\n\n\n/// Looks up the documents in the specified collection using the array of keys\n/// provided, and removes all documents from the collection whose keys are\n/// contained in the *keys* array. Keys for which no document can be found in\n/// the underlying collection are ignored, and no exception will be thrown for\n/// them.\n///\n/// The body of the response contains a JSON object with information how many\n/// documents were removed (and how many were not). The *removed* attribute will\n/// contain the number of actually removed documents. The *ignored* attribute \n/// will contain the number of keys in the request for which no matching document\n/// could be found.\n///\n\n
Example: ///

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  \"code\" : 200, \n  \"error\" : false, \n  \"ignored\" : 0, \n  \"removed\" : 10 \n}\n

\n
Example: ///

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  \"code\" : 200, \n  \"error\" : false, \n  \"ignored\" : 3, \n  \"removed\" : 0 \n}\n

\n///\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "**A json post document with these Properties is required:**\n\n - **keys**: /// array with the _keys of documents to remove.\n /// 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 ///\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 ///\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 ///\n - **collection**: /// The name of the collection to look in for the documents to remove\n ///\n\n\n\n\n/// Looks up the documents in the specified collection using the array of keys\n/// provided, and removes all documents from the collection whose keys are\n/// contained in the *keys* array. Keys for which no document can be found in\n/// the underlying collection are ignored, and no exception will be thrown for\n/// them.\n///\n/// The body of the response contains a JSON object with information how many\n/// documents were removed (and how many were not). The *removed* attribute will\n/// contain the number of actually removed documents. The *ignored* attribute \n/// will contain the number of keys in the request for which no matching document\n/// could be found.\n///\n\n
Example: ///

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  \"code\" : 200, \n  \"error\" : false, \n  \"ignored\" : 0, \n  \"removed\" : 10 \n}\n

\n
Example: ///

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  \"code\" : 200, \n  \"error\" : false, \n  \"ignored\" : 3, \n  \"removed\" : 0 \n}\n

\n///\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { "in": "body", @@ -6961,7 +7201,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/replace-by-example": { @@ -6994,12 +7234,12 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/update-by-example": { "put": { - "description": "**A json post document with these Properties is required:**\n\n - **options**:\n - **keepNull**: /// This parameter can be used to modify the behavior when\n /// handling *null* values. Normally, *null* values are stored in the\n /// database. By setting the *keepNull* parameter to *false*, this\n /// behavior can be changed so that all attributes in *data* with *null*\n /// values will be removed from the updated document.\n ///\n - **mergeObjects**: /// Controls whether objects (not arrays) will be merged if present in both the\n /// existing and the patch document. If set to false, the value in the\n /// patch document will overwrite the existing document's value. If set to\n /// true, objects will be merged. The default is true.\n ///\n - **limit**: /// an optional value that determines how many documents to\n /// update at most. If *limit* is specified but is less than the number\n /// of documents in the collection, it is undefined which of the documents\n /// will be updated.\n ///\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 ///\n - **example**: /// An example document that all collection documents are compared against.\n ///\n - **collection**: /// The name of the collection to update within.\n ///\n - **newValue**: /// A document containing all the attributes to update in the found documents.\n ///\n\n\n\n\n///\n/// This will find all documents in the collection that match the specified\n/// example object, and partially update the document body with the new value\n/// specified. Note that document meta-attributes such as *_id*, *_key*,\n/// *_from*, *_to* etc. cannot be replaced.\n///\n/// Note: the *limit* attribute is not supported on sharded collections.\n/// Using it will result in an error.\n///\n/// Returns the number of documents that were updated.\n///\n///\n\n
Example: ///\n/// using old syntax for options\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/update-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"a\" : { \n      \"j\" : 22 \n    } \n  }, \n  \"limit\" : 3 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"updated\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// using new signature for options\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/update-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"a\" : { \n      \"j\" : 22 \n    } \n  }, \n  \"options\" : { \n    \"limit\" : 3, \n    \"waitForSync\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"updated\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", + "description": "**A json post document with these Properties is required:**\n\n - **options**:\n - **keepNull**: /// This parameter can be used to modify the behavior when\n /// handling *null* values. Normally, *null* values are stored in the\n /// database. By setting the *keepNull* parameter to *false*, this\n /// behavior can be changed so that all attributes in *data* with *null*\n /// values will be removed from the updated document.\n ///\n - **mergeObjects**: /// Controls whether objects (not arrays) will be merged if present in both the\n /// existing and the patch document. If set to false, the value in the\n /// patch document will overwrite the existing document's value. If set to\n /// true, objects will be merged. The default is true.\n ///\n - **limit**: /// an optional value that determines how many documents to\n /// update at most. If *limit* is specified but is less than the number\n /// of documents in the collection, it is undefined which of the documents\n /// will be updated.\n ///\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 ///\n - **example**: /// An example document that all collection documents are compared against.\n ///\n - **collection**: /// The name of the collection to update within.\n ///\n - **newValue**: /// A document containing all the attributes to update in the found documents.\n ///\n\n\n\n\n///\n/// This will find all documents in the collection that match the specified\n/// example object, and partially update the document body with the new value\n/// specified. Note that document meta-attributes such as *_id*, *_key*,\n/// *_from*, *_to* etc. cannot be replaced.\n///\n/// Note: the *limit* attribute is not supported on sharded collections.\n/// Using it will result in an error.\n///\n/// Returns the number of documents that were updated.\n///\n///\n\n
Example: ///\n/// using old syntax for options\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/update-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"a\" : { \n      \"j\" : 22 \n    } \n  }, \n  \"limit\" : 3 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"updated\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// using new signature for options\n///

shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/simple/update-by-example <<EOF\n{ \n  \"collection\" : \"products\", \n  \"example\" : { \n    \"a\" : { \n      \"j\" : 1 \n    } \n  }, \n  \"newValue\" : { \n    \"a\" : { \n      \"j\" : 22 \n    } \n  }, \n  \"options\" : { \n    \"limit\" : 3, \n    \"waitForSync\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\n\n{ \n  \"updated\" : 1, \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n/// \n////////////////////////////////////////////////////////////////////////////////\n", "parameters": [ { "in": "body", @@ -7027,7 +7267,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/within": { @@ -7060,7 +7300,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/simple/within-rectangle": { @@ -7093,7 +7333,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_remove_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_all.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_range.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_any.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_within_rectangle.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestRemoveByKeys.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_replace_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_first_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_near.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_fulltext.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_last.md, ./Documentation/DocuBlocks/Rest//Simple Queries/JSA_put_api_simple_update_by_example.md, ./Documentation/DocuBlocks/Rest//Simple Queries/RestLookupByKeys.md" + "x-filename": "Simple Queries - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_last.md" } }, "/_api/tasks": { @@ -7120,7 +7360,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_api/tasks/": { @@ -7137,7 +7377,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_api/tasks/{id}": { @@ -7163,7 +7403,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" }, "get": { "description": "\n\n/// fetches one existing tasks on the server specified by *id*\n///\n\n
Example: ///\n/// Fetching a single task by its id

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\" : 1452621312.304436, \n  \"command\" : \"require('@arangodb/statistics').historianAverage();\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n
Example: ///\n/// trying to fetch a non-existing task

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", @@ -7187,7 +7427,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" }, "put": { "description": "**A json post document with these Properties is required:**\n\n - **params**: /// The parameters to be passed into command\n ///\n - **offset**: /// Number of seconds initial delay \n ///\n - **command**: /// The JavaScript code to be executed\n ///\n - **name**: /// The name of the task\n ///\n - **period**: /// number of seconds between the executions\n ///\n\n\n\n\n/// registers a new task with the specified id\n///\n\n
Example: ///

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\" : 1452621383.935555, \n  \"command\" : \"(function(params) { require('internal').print(params); })(params)\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n

\n/// \n///////////////////////////////////////////////////////////////////////////////\n", @@ -7220,7 +7460,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } }, "/_api/transaction": { @@ -7256,7 +7496,7 @@ "Transactions" ], "x-examples": [], - "x-filename": "Transactions - ./Documentation/DocuBlocks/Rest//Transactions/JSF_post_api_transaction.md" + "x-filename": "Transactions - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" } }, "/_api/traversal": { @@ -7292,7 +7532,7 @@ "Graph Traversal" ], "x-examples": [], - "x-filename": "Graph Traversal - ./Documentation/DocuBlocks/Rest//Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" + "x-filename": "Graph Traversal - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" } }, "/_api/user": { @@ -7312,7 +7552,7 @@ "User handling" ], "x-examples": [], - "x-filename": "User handling - ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_replace.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_delete.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_update.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch_list.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_create.md" + "x-filename": "User handling - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_create.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_update.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_replace.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch_list.md" } }, "/_api/user/": { @@ -7329,7 +7569,7 @@ "User handling" ], "x-examples": [], - "x-filename": "User handling - ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_replace.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_delete.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_update.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch_list.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_create.md" + "x-filename": "User handling - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_create.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_update.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_replace.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch_list.md" } }, "/_api/user/{user}": { @@ -7358,7 +7598,7 @@ "User handling" ], "x-examples": [], - "x-filename": "User handling - ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_replace.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_delete.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_update.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch_list.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_create.md" + "x-filename": "User handling - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_create.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_update.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_replace.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch_list.md" }, "get": { "description": "\n\n///\n/// Fetches data about the specified user.\n///\n/// The call will return a JSON object with at least the following attributes 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", @@ -7385,7 +7625,7 @@ "User handling" ], "x-examples": [], - "x-filename": "User handling - ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_replace.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_delete.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_update.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch_list.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_create.md" + "x-filename": "User handling - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_create.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_update.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_replace.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch_list.md" }, "patch": { "description": "\n\n///\n/// Partially updates the data of an existing user. The name of an existing\n/// user must be specified in *user*.\n///\n/// The following data can be passed in a JSON representation in the body of the\n/// POST request:\n///\n/// - *passwd*: The user password as a string. Specifying a password is optional.\n/// If not specified, the previously existing value will not be modified.\n/// - *active*: An optional flag that specifies whether the user is active.\n/// If not specified, the previously existing value will not be modified.\n/// - *extra*: An optional JSON object with arbitrary extra data about the user.\n/// If not specified, the previously existing value will not be modified.\n/// - *changePassword*: An optional flag that specifies whether the user must change\n/// the password or not. If not specified, the previously existing value will not be modified.\n///\n/// If the user can be updated by the server, the server will respond with HTTP 200.\n///\n/// In case of success, the returned JSON object has the following properties:\n///\n/// - *error*: Boolean flag to indicate that an error occurred (false in this case)\n/// - *code*: The HTTP status code\n///\n/// In case of error, the body of the response will contain a JSON object with additional error details.\n/// The object has the following attributes:\n///\n/// - *error*: Boolean flag to indicate that an error occurred (true in this case)\n/// - *code*: The HTTP status code\n/// - *errorNum*: The server error number\n/// - *errorMessage*: A descriptive error message\n///\n", @@ -7415,7 +7655,7 @@ "User handling" ], "x-examples": [], - "x-filename": "User handling - ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_replace.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_delete.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_update.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch_list.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_create.md" + "x-filename": "User handling - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_create.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_update.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_replace.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch_list.md" }, "put": { "description": "\n\n///\n/// Replaces the data of an existing user. The name of an existing user must be specified in user.\n///\n/// The following data can to be passed in a JSON representation in the body of the POST request:\n///\n/// - *passwd*: The user password as a string. Specifying a password is mandatory,\n/// but the empty string is allowed for passwords\n/// - *active*: An optional flag that specifies whether the user is active.\n/// If not specified, this will default to true\n/// - *extra*: An optional JSON object with arbitrary extra data about the user\n/// - *changePassword*: An optional flag that specifies whether the user must change\n/// the password or not. If not specified, this will default to false\n///\n/// If the user can be replaced by the server, the server will respond with HTTP 200.\n///\n/// In case of success, the returned JSON object has the following properties:\n///\n/// - *error*: Boolean flag to indicate that an error occurred (false in this case)\n/// - *code*: The HTTP status code\n///\n/// In case of error, the body of the response will contain a JSON object with additional\n/// error details. The object has the following attributes:\n///\n/// - *error*: Boolean flag to indicate that an error occurred (true in this case)\n/// - *code*: The HTTP status code\n/// - *errorNum*: The server error number\n/// - *errorMessage*: A descriptive error message\n///\n", @@ -7445,7 +7685,7 @@ "User handling" ], "x-examples": [], - "x-filename": "User handling - ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_replace.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_delete.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_update.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_fetch_list.md, ./Documentation/DocuBlocks/Rest//User handling/JSF_api_user_create.md" + "x-filename": "User handling - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_create.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_update.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_replace.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_delete.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/User handling/JSF_api_user_fetch_list.md" } }, "/_api/version": { @@ -7477,7 +7717,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_database_version.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_endpoint.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_time.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_test.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_server_role.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_sleep.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks_all.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_long_echo.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_post_admin_execute.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_modules_flush.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_routing_reloads.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_admin_statistics_description.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_delete_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_put_api_new_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_tasks.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_return.md, ./Documentation/DocuBlocks/Rest//Administration/JSF_get_api_initiate.md" + "x-filename": "Administration - /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/neunhoef/tmp/ArangoDB-NewDoc/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md" } } }, diff --git a/js/apps/system/_admin/aardvark/APP/foxxes.js b/js/apps/system/_admin/aardvark/APP/foxxes.js index ddb12292d3..629ad835b5 100644 --- a/js/apps/system/_admin/aardvark/APP/foxxes.js +++ b/js/apps/system/_admin/aardvark/APP/foxxes.js @@ -291,7 +291,8 @@ foxxRouter.get('/download/zip', function (req, res) { const service = FoxxManager.lookupService(mount); const dir = fs.join(fs.makeAbsolute(service.root), service.path); const zipPath = fmUtils.zipDirectory(dir); - res.download(zipPath, `${service.name}@${service.version}.zip.`); + const name = mount.replace(/^\/|\/$/g, '').replace(/\//g, '_'); + res.download(zipPath, `${name}.zip`); }) .summary('Download a service as zip archive') .description(dd` diff --git a/js/apps/system/_admin/aardvark/APP/frontend/html/body.html.part b/js/apps/system/_admin/aardvark/APP/frontend/html/body.html.part index 04e090fc08..c1efdcc1c3 100644 --- a/js/apps/system/_admin/aardvark/APP/frontend/html/body.html.part +++ b/js/apps/system/_admin/aardvark/APP/frontend/html/body.html.part @@ -24,11 +24,18 @@
+ + +
+
diff --git a/js/apps/system/_admin/aardvark/APP/frontend/js/views/dashboardView.js b/js/apps/system/_admin/aardvark/APP/frontend/js/views/dashboardView.js index 6ee037f679..58df1e5331 100644 --- a/js/apps/system/_admin/aardvark/APP/frontend/js/views/dashboardView.js +++ b/js/apps/system/_admin/aardvark/APP/frontend/js/views/dashboardView.js @@ -336,18 +336,29 @@ } }); - //sort for library - opts.file.sort(function(a,b){ - return new Date(b[0]) - new Date(a[0]); - }); + if (opts.file === undefined) { + $('#loadingScreen span').text('Statistics not ready yet. Waiting.'); + $('#loadingScreen').show(); + $('#content').hide(); + } + else { + $('#content').show(); + $('#loadingScreen').hide(); - g.updateOptions(opts); - - //clean up history - if (this.history[this.server].hasOwnProperty(figure)) { - this.cleanupHistory(figure); - } + //sort for library + opts.file.sort(function(a,b){ + return new Date(b[0]) - new Date(a[0]); + }); + g.updateOptions(opts); + + //clean up history + if (this.history[this.server].hasOwnProperty(figure)) { + this.cleanupHistory(figure); + } + } + $(window).trigger('resize'); + this.resize(); }, mergeDygraphHistory: function (newData, i) { diff --git a/js/apps/system/_admin/aardvark/APP/frontend/scss/_body.scss b/js/apps/system/_admin/aardvark/APP/frontend/scss/_body.scss index d1911c427b..1566395166 100644 --- a/js/apps/system/_admin/aardvark/APP/frontend/scss/_body.scss +++ b/js/apps/system/_admin/aardvark/APP/frontend/scss/_body.scss @@ -26,6 +26,26 @@ body { .centralRow { position: relative; } + + .loadingScreen { + background-color: $c-white; + bottom: 0; + left: 0; + padding-top: 100px; + position: absolute; + right: 0; + top: 102px; + z-index: 100; + + span { + display: inline-block; + margin-top: 10px; + text-align: center; + width: 100%; + } + + i { + width: 100%; + } + } } - - diff --git a/js/common/modules/@arangodb/foxx/manager-utils.js b/js/common/modules/@arangodb/foxx/manager-utils.js index a945fb99af..3586c5aba7 100644 --- a/js/common/modules/@arangodb/foxx/manager-utils.js +++ b/js/common/modules/@arangodb/foxx/manager-utils.js @@ -1,4 +1,3 @@ -/*jshint globalstrict: true */ 'use strict'; //////////////////////////////////////////////////////////////////////////////// @@ -38,7 +37,6 @@ var db = arangodb.db; var internal = require('internal'); var throwFileNotFound = arangodb.throwFileNotFound; -var throwDownloadError = arangodb.throwDownloadError; var errors = arangodb.errors; var ArangoError = arangodb.ArangoError; var mountRegEx = /^(\/[a-zA-Z0-9_\-%]+)+$/; @@ -91,189 +89,6 @@ function buildGithubUrl (repository, version) { return urlPrefix + repository + '/archive/' + version + '.zip'; } -//////////////////////////////////////////////////////////////////////////////// -/// @brief extracts the name and version from a manifest file -//////////////////////////////////////////////////////////////////////////////// - -function extractNameAndVersionManifest (source, filename) { - var manifest = JSON.parse(fs.read(filename)); - - source.name = manifest.name; - source.version = manifest.version; -} - - -//////////////////////////////////////////////////////////////////////////////// -/// @brief processes files in a directory -//////////////////////////////////////////////////////////////////////////////// - -function processDirectory (source) { - var location = source.location; - - if (! fs.exists(location) || ! fs.isDirectory(location)) { - throwFileNotFound("'" + String(location) + "' is not a directory"); - } - - // ............................................................................. - // extract name and version from manifest - // ............................................................................. - - extractNameAndVersionManifest(source, fs.join(location, "manifest.json")); - - // ............................................................................. - // extract name and version from manifest - // ............................................................................. - - var tree = fs.listTree(location); - var files = []; - var i; - var filename; - - for (i = 0; i < tree.length; ++i) { - filename = fs.join(location, tree[i]); - - if (fs.isFile(filename)) { - files.push(tree[i]); - } - } - - if (files.length === 0) { - throwFileNotFound("Directory '" + String(location) + "' is empty"); - } - - var tempFile = fs.getTempFile("downloads", false); - source.filename = tempFile; - source.removeFile = true; - - fs.zipFile(tempFile, location, files); - return tempFile; -} - - -//////////////////////////////////////////////////////////////////////////////// -/// @brief extracts the name and version from a zip -//////////////////////////////////////////////////////////////////////////////// - -function repackZipFile (source) { - var i; - - var filename = source.filename; - var path = fs.getTempFile("zip", false); - - fs.makeDirectory(path); - fs.unzipFile(filename, path, false, true); - - // ............................................................................. - // locate the manifest file - // ............................................................................. - - var tree = fs.listTree(path).sort(function(a,b) { - return a.length - b.length; - }); - var found; - var mf = "manifest.json"; - var re = /[\/\\\\]manifest\.json$/; // Windows! - var tf; - - for (i = 0; i < tree.length && found === undefined; ++i) { - tf = tree[i]; - - if (re.test(tf) || tf === mf) { - found = tf; - } - } - - if (found === undefined) { - throwFileNotFound("Cannot find manifest file in zip file '" + filename + "'"); - } - - var mp; - - if (found === mf) { - mp = "."; - } - else { - mp = found.substr(0, found.length - mf.length - 1); - } - - // ............................................................................. - // throw away source file if necessary - // ............................................................................. - - if (source.removeFile && source.filename !== '') { - try { - fs.remove(source.filename); - } - catch (err1) { - arangodb.printf("Cannot remove temporary file '%s'\n", source.filename); - } - } - - delete source.filename; - delete source.removeFile; - - // ............................................................................. - // repack the zip file - // ............................................................................. - - var newSource = { location: fs.join(path, mp) }; - - processDirectory(newSource); - - source.name = newSource.name; - source.version = newSource.version; - source.filename = newSource.filename; - source.removeFile = newSource.removeFile; - - // ............................................................................. - // cleanup temporary paths - // ............................................................................. - - try { - fs.removeDirectoryRecursive(path); - } - catch (err2) { - arangodb.printf("Cannot remove temporary directory '%s'\n", path); - } -} -//////////////////////////////////////////////////////////////////////////////// -/// @brief processes files from a github repository -//////////////////////////////////////////////////////////////////////////////// - -function processGithubRepository (source) { - var url = buildGithubUrl(source.location, source.version); - var tempFile = fs.getTempFile("downloads", false); - - try { - var result = internal.download(url, "", { - method: "get", - followRedirects: true, - timeout: 30 - }, tempFile); - - if (result.code >= 200 && result.code <= 299) { - source.filename = tempFile; - source.removeFile = true; - } - else { - let msg = "Could not download from repository '" + url + "'"; - if (result.hasOwnProperty('message')) { - msg += " message: " + result.message; - } - throwDownloadError(msg); - } - } - catch (err) { - let msg = "Could not download from repository '" + url + "': " + String(err); - if (err.hasOwnProperty('message')) { - msg += " message: " + err.message; - } - throwDownloadError(msg); - } - - repackZipFile(source); -} - //////////////////////////////////////////////////////////////////////////////// /// @brief returns all running Foxx applications //////////////////////////////////////////////////////////////////////////////// @@ -513,9 +328,6 @@ exports.listJson = listJson; exports.listDevelopment = listDevelopment; exports.listDevelopmentJson = listDevelopmentJson; exports.buildGithubUrl = buildGithubUrl; -exports.repackZipFile = repackZipFile; -exports.processDirectory = processDirectory; -exports.processGithubRepository = processGithubRepository; exports.validateServiceName = validateServiceName; exports.validateMount = validateMount; exports.parameterTypes = parameterTypes; diff --git a/js/server/modules/@arangodb/foxx/context.js b/js/server/modules/@arangodb/foxx/context.js index 8260466278..ba97cfe1b7 100644 --- a/js/server/modules/@arangodb/foxx/context.js +++ b/js/server/modules/@arangodb/foxx/context.js @@ -42,7 +42,7 @@ module.exports = class FoxxContext { } use(path, router, name) { - this.service.router.use(path, router, name); + return this.service.router.use(path, router, name); } registerType(type, def) { @@ -85,17 +85,13 @@ module.exports = class FoxxContext { } fileName(filename) { - return fs.safeJoin(this.basePath, filename); + return path.join(this.basePath, filename); } file(filename, encoding) { return fs.readFileSync(this.fileName(filename), encoding); } - path(name) { - return path.join(this.basePath, name); - } - collectionName(name) { const fqn = ( this.collectionPrefix + name @@ -116,7 +112,7 @@ module.exports = class FoxxContext { } get baseUrl() { - return `/_db/${encodeURIComponent(internal.db._name())}/${this.service.mount.slice(1)}`; + return `/_db/${encodeURIComponent(internal.db._name())}${this.service.mount}`; } get collectionPrefix() { @@ -127,14 +123,6 @@ module.exports = class FoxxContext { return this.service.mount; } - get name() { - return this.service.name; - } - - get version() { - return this.service.version; - } - get manifest() { return this.service.manifest; } @@ -147,10 +135,6 @@ module.exports = class FoxxContext { return !this.isDevelopment; } - get options() { - return this.service.options; - } - get configuration() { return this.service.configuration; } diff --git a/js/server/modules/@arangodb/foxx/legacy/swagger.js b/js/server/modules/@arangodb/foxx/legacy/swagger.js index a2b66daee7..9645a2e7e0 100644 --- a/js/server/modules/@arangodb/foxx/legacy/swagger.js +++ b/js/server/modules/@arangodb/foxx/legacy/swagger.js @@ -24,6 +24,7 @@ var _ = require('lodash'); var fs = require('fs'); +var joinPath = require('path').join; var internal = require('internal'); var ArangoError = require('@arangodb').ArangoError; var errors = require('@arangodb').errors; @@ -96,9 +97,9 @@ function swaggerPath(path, basePath) { return path; } if (!basePath) { - basePath = fs.join(internal.startupPath, 'server', 'assets', 'swagger'); + basePath = joinPath(internal.startupPath, 'server', 'assets', 'swagger'); } - return fs.safeJoin(basePath, path); + return joinPath(basePath, path); } function resolveFoxx(req, res, appPath) { diff --git a/js/server/modules/@arangodb/foxx/manager.js b/js/server/modules/@arangodb/foxx/manager.js index eca025d828..6280f47042 100644 --- a/js/server/modules/@arangodb/foxx/manager.js +++ b/js/server/modules/@arangodb/foxx/manager.js @@ -1,4 +1,3 @@ -/*jshint esnext: true */ /*global ArangoServerState, ArangoClusterInfo, ArangoClusterComm */ 'use strict'; @@ -32,9 +31,11 @@ const _ = require('lodash'); const fs = require('fs'); +const joinPath = require('path').join; const joi = require('joi'); const util = require('util'); const semver = require('semver'); +const dd = require('dedent'); const il = require('@arangodb/util').inline; const utils = require('@arangodb/foxx/manager-utils'); const store = require('@arangodb/foxx/store'); @@ -69,8 +70,8 @@ const legacyManifestFields = [ ]; const manifestSchema = { - name: joi.string().regex(/^[-_a-z][-_a-z0-9]*$/i).required(), - version: joi.string().required(), + name: joi.string().regex(/^[-_a-z][-_a-z0-9]*$/i).optional(), + version: joi.string().optional(), engines: ( joi.object().optional() .pattern(RE_EMPTY, joi.forbidden()) @@ -93,7 +94,7 @@ const manifestSchema = { ), lib: joi.string().default('.'), - main: joi.string().optional(), + main: joi.string().default('index.js'), configuration: ( joi.object().optional() @@ -126,6 +127,17 @@ const manifestSchema = { )) ), + provides: ( + joi.alternatives().try( + joi.string().optional(), + joi.array().optional() + .items(joi.string().required()), + joi.object().optional() + .pattern(RE_EMPTY, joi.forbidden()) + .pattern(RE_NOT_EMPTY, joi.string().required()) + ) + ), + files: ( joi.object().optional() .pattern(RE_EMPTY, joi.forbidden()) @@ -215,7 +227,10 @@ function lookupService(mount) { } throw new ArangoError({ errorNum: errors.ERROR_APP_NOT_FOUND.code, - errorMessage: 'Service not found at: ' + mount + errorMessage: dd` + ${errors.ERROR_APP_NOT_FOUND.message} + Service not found at "${mount}". + ` }); } return serviceCache[dbname][mount]; @@ -286,88 +301,138 @@ function checkMountedSystemService(dbname) { /// this implements issue #590: Manifest Lint //////////////////////////////////////////////////////////////////////////////// -function checkManifest(filename, manifest) { +function checkManifest(filename, inputManifest, mount) { const serverVersion = plainServerVersion(); - const validationErrors = []; + const errors = []; + const warnings = []; + const notices = []; + const manifest = {}; let legacy = false; Object.keys(manifestSchema).forEach(function (key) { - let schema = manifestSchema[key]; - let value = manifest[key]; - let result = joi.validate(value, schema); - if (result.value !== undefined) { + const schema = manifestSchema[key]; + const value = inputManifest[key]; + const result = joi.validate(value, schema); + if (result.error) { + const error = result.error.message.replace(/^"value"/, `Field "${key}"`); + errors.push(`${error} (was "${util.format(value)}").`); + } else { manifest[key] = result.value; } - if (result.error) { - let error = result.error.message.replace(/^"value"/, `"${key}"`); - let message = `Manifest "${filename}": attribute ${error} (was "${util.format(value)}").`; - validationErrors.push(message); - console.error(message); - } }); - if (!manifest.engines && manifest.engine) { - console.warn(il` - Found unexpected "engine" field in manifest "${filename}" for service "${manifest.name}". - Did you mean "engines"? - `); - } - if (manifest.engines && manifest.engines.arangodb) { if (semver.gtr('3.0.0', manifest.engines.arangodb)) { legacy = true; - console.warn( - `Manifest "${filename}" for service "${manifest.name}":` - + ` Service expects version ${manifest.engines.arangodb}` - + ` and will run in legacy compatibility mode.` - ); + notices.push(il` + Service expects version ${manifest.engines.arangodb} + and will run in legacy compatibility mode. + `); } else if (!semver.satisfies(serverVersion, manifest.engines.arangodb)) { - console.warn( - `Manifest "${filename}" for service "${manifest.name}":` - + ` ArangoDB version ${serverVersion} probably not compatible` - + ` with expected version ${manifest.engines.arangodb}.` - ); + warnings.push(il` + ArangoDB version ${serverVersion} probably not compatible + with expected version ${manifest.engines.arangodb}. + `); } } - Object.keys(manifest).forEach(function (key) { - if (!manifestSchema[key] && (!legacy || legacyManifestFields.indexOf(key) === -1)) { - console.warn(`Manifest "${filename}" for service "${manifest.name}": unknown attribute "${key}"`); + for (const key of Object.keys(inputManifest)) { + if (manifestSchema[key]) { + continue; } - }); + manifest[key] = inputManifest[key]; + if (key === 'engine' && !inputManifest.engines) { + warnings.push('Unknown field "engine". Did you mean "engines"?'); + } else if (!legacy || legacyManifestFields.indexOf(key) === -1) { + warnings.push(`Unknown field "${key}".`); + } + } - if (validationErrors.length) { + if (manifest.version && !semver.valid(manifest.version)) { + warnings.push(`Not a valid version: "${manifest.verison}"`); + } + + if (manifest.provides) { + if (typeof manifest.provides === 'string') { + manifest.provides = [manifest.provides]; + } + if (Array.isArray(manifest.provides)) { + const provides = manifest.provides; + manifest.provides = {}; + for (const provided of provides) { + const tokens = provided.split(':'); + manifest.provides[tokens[0]] = tokens[1] || '*'; + } + } + for (const name of Object.keys(manifest.provides)) { + const version = manifest.provides[name]; + if (!semver.valid(version)) { + errors.push(`Provided "${name}" invalid version: "${version}".`); + } + } + } + + if (manifest.dependencies) { + for (const key of Object.keys(manifest.dependencies)) { + if (typeof manifest.dependencies[key] === 'string') { + const tokens = manifest.dependencies[key].split(':'); + manifest.dependencies[key] = { + name: tokens[0] || '*', + version: tokens[1] || '*', + required: true + }; + } + const version = manifest.dependencies[key].version; + if (!semver.validRange(version)) { + errors.push(`Dependency "${key}" invalid version: "${version}".`); + } + } + } + + if (notices.length) { + console.infoLines(dd` + Manifest for service at "${mount}": + ${notices.join('\n')} + `); + } + + if (warnings.length) { + console.warnLines(dd` + Manifest for service at "${mount}": + ${warnings.join('\n')} + `); + } + + if (errors.length) { + console.errorLines(dd` + Manifest for service at "${mount}": + ${errors.join('\n')} + `); throw new ArangoError({ errorNum: errors.ERROR_INVALID_APPLICATION_MANIFEST.code, - errorMessage: validationErrors.join('\n') + errorMessage: dd` + ${errors.ERROR_INVALID_APPLICATION_MANIFEST.message} + Manifest for service at "${mount}": + ${errors.join('\n')} + ` }); - } else { - if (manifest.dependencies) { - Object.keys(manifest.dependencies).forEach(function (key) { - const dependency = manifest.dependencies[key]; - if (typeof dependency === 'string') { - const tokens = dependency.split(':'); - manifest.dependencies[key] = { - name: tokens[0] || '*', - version: tokens[1] || '*', - required: true - }; - } - }); - } + } - if (legacy && manifest.defaultDocument === undefined) { + if (legacy) { + if (manifest.defaultDocument === undefined) { manifest.defaultDocument = 'index.html'; } if (typeof manifest.controllers === 'string') { manifest.controllers = {'/': manifest.controllers}; } - - if (typeof manifest.tests === 'string') { - manifest.tests = [manifest.tests]; - } } + + if (typeof manifest.tests === 'string') { + manifest.tests = [manifest.tests]; + } + + return manifest; } @@ -377,35 +442,38 @@ function checkManifest(filename, manifest) { /// All errors are handled including file not found. Returns undefined if manifest is invalid //////////////////////////////////////////////////////////////////////////////// -function validateManifestFile(filename) { - var mf, msg; +function validateManifestFile(filename, mount) { + let mf; if (!fs.exists(filename)) { - msg = `Cannot find manifest file "${filename}"`; - throwFileNotFound(msg); + throwFileNotFound(`Cannot find manifest file "${filename}"`); } try { mf = JSON.parse(fs.read(filename)); } catch (e) { - const error = new ArangoError({ - errorNum: errors.ERROR_MALFORMED_MANIFEST_FILE.code, - errorMessage: errors.ERROR_MALFORMED_MANIFEST_FILE.message - + '\nFile: ' + filename - + '\nCause: ' + e.stack - }); - error.cause = e; - throw error; + throw Object.assign( + new ArangoError({ + errorNum: errors.ERROR_MALFORMED_MANIFEST_FILE.code, + errorMessage: dd` + ${errors.ERROR_MALFORMED_MANIFEST_FILE.message} + File: ${filename} + Cause: ${e.stack} + ` + }), {cause: e} + ); } try { - checkManifest(filename, mf); + mf = checkManifest(filename, mf, mount); } catch (e) { - const error = new ArangoError({ - errorNum: errors.ERROR_INVALID_APPLICATION_MANIFEST.code, - errorMessage: errors.ERROR_INVALID_APPLICATION_MANIFEST.message - + '\nFile: ' + filename - + '\nCause: ' + e.stack - }); - error.cause = e; - throw error; + throw Object.assign( + new ArangoError({ + errorNum: errors.ERROR_INVALID_APPLICATION_MANIFEST.code, + errorMessage: dd` + ${errors.ERROR_INVALID_APPLICATION_MANIFEST.message} + File: ${filename} + Cause: ${e.stack} + ` + }), {cause: e} + ); } return mf; } @@ -436,7 +504,7 @@ function computeRootServicePath(mount) { function transformMountToPath(mount) { var list = mount.split('/'); list.push('APP'); - return fs.join.apply(fs, list); + return joinPath(...list); } //////////////////////////////////////////////////////////////////////////////// @@ -456,7 +524,7 @@ function transformPathToMount(path) { function computeServicePath(mount) { var root = computeRootServicePath(mount); var mountPath = transformMountToPath(mount); - return fs.join(root, mountPath); + return joinPath(root, mountPath); } //////////////////////////////////////////////////////////////////////////////// @@ -479,15 +547,15 @@ function executeScript(scriptName, service, argv) { /// @brief returns a valid service config for validation purposes //////////////////////////////////////////////////////////////////////////////// -function fakeServiceConfig(path) { - var file = fs.join(path, 'manifest.json'); +function fakeServiceConfig(path, mount) { + var file = joinPath(path, 'manifest.json'); return { id: '__internal', root: '', path: path, options: {}, mount: '/internal', - manifest: validateManifestFile(file), + manifest: validateManifestFile(file, mount), isSystem: false, isDevelopment: false }; @@ -501,13 +569,13 @@ function serviceConfig(mount, options, activateDevelopment) { var root = computeRootServicePath(mount); var path = transformMountToPath(mount); - var file = fs.join(root, path, 'manifest.json'); + var file = joinPath(root, path, 'manifest.json'); return { id: mount, path: path, options: options || {}, mount: mount, - manifest: validateManifestFile(file), + manifest: validateManifestFile(file, mount), isSystem: isSystemMount(mount), isDevelopment: activateDevelopment || false }; @@ -535,7 +603,7 @@ function uploadToPeerCoordinators(serviceInfo, coordinators) { let coordOptions = { coordTransactionID: ArangoClusterInfo.uniqid() }; - let req = fs.readBuffer(fs.join(fs.getTempPath(), serviceInfo)); + let req = fs.readBuffer(joinPath(fs.getTempPath(), serviceInfo)); let httpOptions = {}; let mapping = {}; for (let i = 0; i < coordinators.length; ++i) { @@ -559,10 +627,6 @@ function uploadToPeerCoordinators(serviceInfo, coordinators) { function installServiceFromGenerator(targetPath, options) { var invalidOptions = []; // Set default values: - options.name = options.name || 'MyService'; - options.author = options.author || 'Author'; - options.description = options.description || ''; - options.license = options.license || 'Apache 2'; options.documentCollections = options.documentCollections || []; options.edgeCollections = options.edgeCollections || []; if (typeof options.name !== 'string') { @@ -586,8 +650,10 @@ function installServiceFromGenerator(targetPath, options) { if (invalidOptions.length > 0) { throw new ArangoError({ errorNum: errors.ERROR_INVALID_FOXX_OPTIONS.code, - errorMessage: errors.ERROR_INVALID_FOXX_OPTIONS.message - + '\nOptions: ' + JSON.stringify(invalidOptions, undefined, 2) + errorMessage: dd` + ${errors.ERROR_INVALID_FOXX_OPTIONS.message} + Options: ${JSON.stringify(invalidOptions, undefined, 2)} + ` }); } var cfg = generator.generate(options); @@ -651,7 +717,7 @@ function extractServiceToPath(archive, targetPath, noDelete) { mp = found.substr(0, found.length - mf.length - 1); } - fs.move(fs.join(tempFile, mp), targetPath); + fs.move(joinPath(tempFile, mp), targetPath); // ............................................................................. // throw away temporary service folder @@ -779,10 +845,10 @@ function readme(mount) { let service = lookupService(mount); let path, readmeText; - path = fs.join(service.root, service.path, 'README.md'); + path = joinPath(service.root, service.path, 'README.md'); readmeText = fs.exists(path) && fs.read(path); if (!readmeText) { - path = fs.join(service.root, service.path, 'README'); + path = joinPath(service.root, service.path, 'README'); readmeText = fs.exists(path) && fs.read(path); } return readmeText || null; @@ -913,7 +979,7 @@ function _buildServiceInPath(serviceInfo, path, options) { } else if (utils.pathRegex.test(serviceInfo)) { installServiceFromLocal(serviceInfo, path); } else if (/^uploads[\/\\]tmp-/.test(serviceInfo)) { - serviceInfo = fs.join(fs.getTempPath(), serviceInfo); + serviceInfo = joinPath(fs.getTempPath(), serviceInfo); installServiceFromLocal(serviceInfo, path); } else { try { @@ -938,11 +1004,11 @@ function _buildServiceInPath(serviceInfo, path, options) { /// Does not check parameters and throws errors. //////////////////////////////////////////////////////////////////////////////// -function _validateService(serviceInfo) { +function _validateService(serviceInfo, mount) { var tempPath = fs.getTempFile('apps', false); try { _buildServiceInPath(serviceInfo, tempPath, {}); - var tmp = new FoxxService(fakeServiceConfig(tempPath)); + var tmp = new FoxxService(fakeServiceConfig(tempPath, mount)); if (!tmp.needsConfiguration()) { routeAndExportService(tmp, true); } @@ -1188,7 +1254,7 @@ function replace(serviceInfo, mount, options) { [ 'Mount path', 'string' ] ], [ serviceInfo, mount ] ); utils.validateMount(mount); - _validateService(serviceInfo); + _validateService(serviceInfo, mount); options = options || {}; let hasToBeDistributed = /^uploads[\/\\]tmp-/.test(serviceInfo); if (ArangoServerState.isCoordinator() && !options.__clusterDistribution) { @@ -1255,7 +1321,7 @@ function upgrade(serviceInfo, mount, options) { [ 'Mount path', 'string' ] ], [ serviceInfo, mount ] ); utils.validateMount(mount); - _validateService(serviceInfo); + _validateService(serviceInfo, mount); options = options || {}; let hasToBeDistributed = /^uploads[\/\\]tmp-/.test(serviceInfo); if (ArangoServerState.isCoordinator() && !options.__clusterDistribution) { diff --git a/js/server/modules/@arangodb/foxx/service.js b/js/server/modules/@arangodb/foxx/service.js index e0af15f78e..62056132b2 100644 --- a/js/server/modules/@arangodb/foxx/service.js +++ b/js/server/modules/@arangodb/foxx/service.js @@ -45,6 +45,17 @@ const APP_PATH = internal.appPath ? path.resolve(internal.appPath) : undefined; const STARTUP_PATH = internal.startupPath ? path.resolve(internal.startupPath) : undefined; const DEV_APP_PATH = internal.devAppPath ? path.resolve(internal.devAppPath) : undefined; +const LEGACY_ALIASES = [ + ['@arangodb/foxx/authentication', '@arangodb/foxx/legacy/authentication'], + ['@arangodb/foxx/controller', '@arangodb/foxx/legacy/controller'], + ['@arangodb/foxx/model', '@arangodb/foxx/legacy/model'], + ['@arangodb/foxx/query', '@arangodb/foxx/legacy/query'], + ['@arangodb/foxx/repository', '@arangodb/foxx/legacy/repository'], + ['@arangodb/foxx/schema', '@arangodb/foxx/legacy/schema'], + ['@arangodb/foxx/sessions', '@arangodb/foxx/legacy/sessions'], + ['@arangodb/foxx/template_middleware', '@arangodb/foxx/legacy/template_middleware'], + ['@arangodb/foxx', '@arangodb/foxx/legacy'] +]; module.exports = class FoxxService { constructor(data) { @@ -97,8 +108,8 @@ module.exports = class FoxxService { this.legacy = range ? semver.gtr('3.0.0', range) : false; if (this.legacy) { console.debugLines(dd` - Running "${this.mount}" in 2.x compatibility mode. - Requested version ${range} is lower than 3.0.0. + Service "${this.mount}" is running in legacy compatibility mode. + Requested version "${range}" is lower than "3.0.0". `); } @@ -261,7 +272,7 @@ module.exports = class FoxxService { } _PRINT(context) { - context.output += `[FoxxService "${this.name}" (${this.version}) on ${this.mount}]`; + context.output += `[FoxxService at "${this.mount}"]`; } toJSON() { @@ -380,17 +391,7 @@ module.exports = class FoxxService { this.main.filename = path.resolve(moduleRoot, '.foxx'); this.main[$_MODULE_ROOT] = moduleRoot; this.main[$_MODULE_CONTEXT].console = foxxConsole; - this.main.require.aliases = new Map(this.legacy ? [ - ['@arangodb/foxx/authentication', '@arangodb/foxx/legacy/authentication'], - ['@arangodb/foxx/controller', '@arangodb/foxx/legacy/controller'], - ['@arangodb/foxx/model', '@arangodb/foxx/legacy/model'], - ['@arangodb/foxx/query', '@arangodb/foxx/legacy/query'], - ['@arangodb/foxx/repository', '@arangodb/foxx/legacy/repository'], - ['@arangodb/foxx/schema', '@arangodb/foxx/legacy/schema'], - ['@arangodb/foxx/sessions', '@arangodb/foxx/legacy/sessions'], - ['@arangodb/foxx/template_middleware', '@arangodb/foxx/legacy/template_middleware'], - ['@arangodb/foxx', '@arangodb/foxx/legacy'] - ] : []); + this.main.require.aliases = new Map(this.legacy ? LEGACY_ALIASES : []); this.main.require.cache = this.requireCache; this.main.context = new FoxxContext(this); this.router = new Router(); @@ -401,7 +402,15 @@ module.exports = class FoxxService { }; if (this.legacy) { + this.main.context.path = this.main.context.fileName; + this.main.context.fileName = (filename) => fs.safeJoin(this.basePath, filename); this.main.context.foxxFilename = this.main.context.fileName; + this.main.context.version = this.version = this.manifest.version; + this.main.context.name = this.name = this.manifest.name; + this.main.context.options = this.options; + this.main.context.use = undefined; + this.main.context.apiDocumentation = undefined; + this.main.context.registerType = undefined; } } @@ -409,14 +418,6 @@ module.exports = class FoxxService { return this.main.exports; } - get name() { - return this.manifest.name; - } - - get version() { - return this.manifest.version; - } - get isSystem() { return this.mount.charAt(1) === '_'; } @@ -464,19 +465,19 @@ module.exports = class FoxxService { function createConfiguration(definitions) { const config = {}; - Object.keys(definitions).forEach(function (name) { + for (const name of Object.keys(definitions)) { const def = definitions[name]; if (def.default !== undefined) { config[name] = def.default; } - }); + } return config; } function createDependencies(definitions, options) { const deps = {}; - Object.keys(definitions).forEach(function (name) { + for (const name of Object.keys(definitions)) { Object.defineProperty(deps, name, { configurable: true, enumerable: true, @@ -489,6 +490,6 @@ function createDependencies(definitions, options) { return FoxxManager.requireService('/' + mount.replace(/(^\/+|\/+$)/, '')); } }); - }); + } return deps; } diff --git a/js/server/modules/@arangodb/foxx/swagger.js b/js/server/modules/@arangodb/foxx/swagger.js index 41865ef4f1..d1569bc353 100644 --- a/js/server/modules/@arangodb/foxx/swagger.js +++ b/js/server/modules/@arangodb/foxx/swagger.js @@ -24,6 +24,7 @@ const NotFound = require('http-errors').NotFound; const fs = require('fs'); +const joinPath = require('path').join; const internal = require('internal'); const errors = require('@arangodb').errors; const FoxxManager = require('@arangodb/foxx/manager'); @@ -98,7 +99,7 @@ module.exports = function createSwaggerRouteHandler(foxxMount, opts) { } else if (path === 'index.html') { path = indexFile; } - const filePath = path.charAt(0) === '/' ? path : fs.safeJoin(swaggerRoot, path); + const filePath = path.charAt(0) === '/' ? path : joinPath(swaggerRoot, path); if (!fs.isFile(filePath)) { throw new NotFound(`unknown path "${req._raw.url}"`); } diff --git a/scripts/run b/scripts/run index edac48ca7e..03303ed092 100755 --- a/scripts/run +++ b/scripts/run @@ -42,7 +42,7 @@ done echo Database has its data in ${DBDIR} echo Logfile is in ${LOGFILE} -$VG bin/arangod \ +$VG build/bin/arangod \ --configuration none \ --cluster.arangod-path bin${PS}arangod \ --cluster.coordinator-config etc${PS}relative${PS}arangod-coordinator.conf \ diff --git a/utils/generateSwagger.py b/utils/generateSwagger.py index 6ff227c634..3d909c18b7 100755 --- a/utils/generateSwagger.py +++ b/utils/generateSwagger.py @@ -149,12 +149,6 @@ restBodyParam = None restReplyBodyParam = None restSubBodyParam = None -################################################################################ -### @brief C_FILE -################################################################################ - -C_FILE = False - ################################################################################ ### @brief DEBUG ################################################################################ @@ -283,10 +277,7 @@ def LIT(txt, wordboundary = ['','']): ################################################################################ def Typography(txt): - if C_FILE: - txt = txt[4:-1] - else: - txt = txt[0:-1] + txt = txt[0:-1] # txt = BackTicks(txt) # txt = AsteriskBold(txt) @@ -376,7 +367,6 @@ class Regexen: self.END_EXAMPLE_ARANGOSH_RUN = re.compile('.*@END_EXAMPLE_ARANGOSH_RUN') self.EXAMPLES = re.compile('.*@EXAMPLES') self.EXAMPLE_ARANGOSH_RUN = re.compile('.*@EXAMPLE_ARANGOSH_RUN{') - self.FILE = re.compile('.*@file') self.RESTBODYPARAM = re.compile('.*@RESTBODYPARAM') self.RESTSTRUCT = re.compile('.*@RESTSTRUCT') self.RESTALLBODYPARAM = re.compile('.*@RESTALLBODYPARAM') @@ -392,17 +382,13 @@ class Regexen: self.RESTRETURNCODES = re.compile('.*@RESTRETURNCODES') self.RESTURLPARAM = re.compile('.*@RESTURLPARAM{') self.RESTURLPARAMETERS = re.compile('.*@RESTURLPARAMETERS') - self.NON_COMMENT = re.compile('^[^/].*') ################################################################################ ### @brief checks for end of comment ################################################################################ def check_end_of_comment(line, r): - if C_FILE: - return r.NON_COMMENT.match(line) - else: - return r.RESTDONE.match(line) + return r.RESTDONE.match(line) ################################################################################ ### @brief next_step @@ -460,7 +446,7 @@ def generic_handler(cargo, r, message): ################################################################################ def generic_handler_desc(cargo, r, message, op, para, name): - global DEBUG, C_FILE, operation + global DEBUG, operation if DEBUG: print >> sys.stderr, message (fp, last) = cargo @@ -483,9 +469,6 @@ def generic_handler_desc(cargo, r, message, op, para, name): raise return next, c - if C_FILE and line[0:4] == "////": - continue - line = Typography(line) para[name] += line + '\n' @@ -495,7 +478,11 @@ def start_docublock(cargo, r=Regexen()): global currentDocuBlock (fp, last) = cargo try: - currentDocuBlock = last.split(' ')[2].rstrip() + # TODO remove when all /// are removed from the docublocks + if last.startswith('/// '): + currentDocuBlock = last.split(' ')[2].rstrip() + else: + currentDocuBlock = last.split(' ')[1].rstrip() except Exception as x: print >> sys.stderr, "failed to fetch docublock in '" + last + "'" raise @@ -768,7 +755,7 @@ def reststruct(cargo, r=Regexen()): try: (name, className, ptype, required, ptype2) = parameters(last).split(',') except Exception as x: - print >> sys.stderr, "RESTSTRUCT: 4 arguments required. You gave me: " + parameters(last) + print >> sys.stderr, "RESTSTRUCT: 5 arguments required. You gave me: " + parameters(last) raise CheckReqOpt(required) @@ -1002,7 +989,7 @@ def examples(cargo, r=Regexen()): def example_arangosh_run(cargo, r=Regexen()): - global currentExample, DEBUG, C_FILE + global currentExample, DEBUG if DEBUG: print >> sys.stderr, "example_arangosh_run" fp, last = cargo @@ -1010,7 +997,12 @@ def example_arangosh_run(cargo, r=Regexen()): exampleHeader = brTrim(operation['x-examples'][currentExample]).strip() # new examples code TODO should include for each example own object in json file - examplefile = open(os.path.join(os.path.dirname(__file__), '../Documentation/Examples/' + parameters(last) + '.generated')) + fn = os.path.join(os.path.dirname(__file__), '../Examples/' + parameters(last) + '.generated') + try: + examplefile = open(fn) + except: + print >> sys.stderr, "Failed to open example file:\n '%s'" % fn + raise operation['x-examples'][currentExample]= '
Example: ' + exampleHeader.strip('\n ') + '

'
 
     for line in examplefile.readlines():
@@ -1035,7 +1027,7 @@ def example_arangosh_run(cargo, r=Regexen()):
 ################################################################################
 
 def eof(cargo):
-    global DEBUG, C_FILE
+    global DEBUG
     if DEBUG: print >> sys.stderr, "eof"
 
 ################################################################################
@@ -1043,7 +1035,7 @@ def eof(cargo):
 ################################################################################
 
 def error(cargo):
-    global DEBUG, C_FILE
+    global DEBUG
     if DEBUG: print >> sys.stderr, "error"
 
     sys.stderr.write('Unidentifiable line:\n' + cargo)
@@ -1053,7 +1045,7 @@ def error(cargo):
 ################################################################################
 
 def comment(cargo, r=Regexen()):
-    global DEBUG, C_FILE
+    global DEBUG
 
     if DEBUG: print >> sys.stderr, "comment"
     (fp, last) = cargo
@@ -1062,8 +1054,6 @@ def comment(cargo, r=Regexen()):
         line = fp.readline()
         if not line: return eof, (fp, line)
 
-        if r.FILE.match(line): C_FILE = True
-
         next, c = next_step(fp, line, r)
 
         if next:
@@ -1076,22 +1066,12 @@ def comment(cargo, r=Regexen()):
 ################################################################################
 
 def skip_code(cargo, r=Regexen()):
-    global DEBUG, C_FILE
+    global DEBUG
 
     if DEBUG: print >> sys.stderr, "skip_code"
     (fp, last) = cargo
     
-    if not C_FILE:
-        return comment((fp, last), r)
-
-    while 1:
-        line = fp.readline()
-
-        if not line:
-            return eof, (fp, line)
-
-        if not r.NON_COMMENT.match(line):
-            return comment((fp, line), r)
+    return comment((fp, last), r)
 
 ################################################################################
 ### @brief main
@@ -1225,15 +1205,25 @@ files = {}
 #  "structure" : [ "js/actions/api-structure.js" ],
 
 for chapter in os.listdir(topdir):
+    if not os.path.isdir(os.path.join(topdir, chapter)) or chapter[0] == ".":
+        continue
     files[chapter] = []
-    for oneFile in os.listdir(topdir + "/" + chapter):
-        files[chapter].append(topdir + "/" + chapter + '/' + oneFile)
+    curPath = os.path.join(topdir, chapter)
+    for oneFile in os.listdir(curPath):
+        curPath2 = os.path.join(curPath, oneFile)
+        if os.path.isfile(curPath2) and oneFile[0] != "." and oneFile.endswith(".md"):
+            files[chapter].append(os.path.join(topdir, chapter, oneFile))
 
 for name, filenames in sorted(files.items(), key=operator.itemgetter(0)):
     currentTag = name
     for fn in filenames:
+        thisfn = fn
         infile = open(fn)
-        getOneApi(infile, name + " - " + ', '.join(filenames))
+        try:
+            getOneApi(infile, name + " - " + ', '.join(filenames))
+        except Exception as x:
+            print >> sys.stderr, "\nwhile parsing file: '%s' error: %s" % (thisfn, x)
+            raise
         infile.close()
         currentDocuBlock = None
         lastDocuBlock = None