diff --git a/CHANGELOG b/CHANGELOG index dacde46c25..b11c868eb6 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,10 +1,13 @@ devel ----- +* added options `--encryption.keyfile` and `--encryption.key-generator` to arangodump + and arangorestore + * removed `--recycle-ids` option for arangorestore using that option could have led to problems on the restore, with potential - id conflicts between the originating server (the source dump server) and the + id conflicts between the originating server (the source dump server) and the target server (the restore server) * add readonly mode REST API @@ -19,23 +22,23 @@ devel * potential fix for issue #3562: Document WITHIN_RECTANGLE not found -* introduce `enforceReplicationFactor` attribute for creating collections: - this optional parameter controls if the coordinator should bail out during collection +* introduce `enforceReplicationFactor` attribute for creating collections: + this optional parameter controls if the coordinator should bail out during collection creation if there are not enough DBServers available for the desired `replicationFactor`. * fixed issue #3516: Show execution time in arangosh - + this change adds more dynamic prompt components for arangosh - The following components are now available for dynamic prompts, + The following components are now available for dynamic prompts, settable via the `--console.prompt` option in arangosh: - + - '%t': current time as timestamp - '%p': duration of last command in seconds - '%d': name of current database - '%e': current endpoint - '%E': current endpoint without protocol - '%u': current user - + The time a command takes can be displayed easily by starting arangosh with `--console.prompt "%p> "`. * make the ArangoShell refill its collection cache when a yet-unknown collection @@ -48,8 +51,8 @@ devel * make AQL `DISTINCT` not change the order of the results it is applied on -* incremental transfer of initial collection data now can handle partial - responses for a chunk, allowing the leader/master to send smaller chunks +* incremental transfer of initial collection data now can handle partial + responses for a chunk, allowing the leader/master to send smaller chunks (in terms of HTTP response size) and limit memory usage this optimization is only active if client applications send the "offset" parameter @@ -59,7 +62,7 @@ devel `replicationFactor` values bigger than 1. this is achieved by an optimization for the case when the collection on the leader is still empty -* potential fix for issue #3517: several "filesystem full" errors in logs +* potential fix for issue #3517: several "filesystem full" errors in logs while there's a lot of disk space * added C++ implementations for AQL function `SUBSTRING()`, `LEFT()`, `RIGHT()` and `TRIM()` @@ -101,7 +104,7 @@ devel * added `--rocksdb.encryption-key-generator` for enterprise * removed `--compat28` parameter from arangodump and replication API - + older ArangoDB versions will no longer be supported by these tools. * increase the recommended value for `/proc/sys/vm/max_map_count` to a value @@ -118,7 +121,7 @@ devel v3.2.7 (2017-11-13) ------------------- -* Cluster customers, which have upgraded from 3.1 to 3.2 need to upgrade +* Cluster customers, which have upgraded from 3.1 to 3.2 need to upgrade to 3.2.7. The cluster supervision is otherwise not operational. * Fixed issue #3597: AQL with path filters returns unexpected results @@ -146,24 +149,24 @@ v3.2.7 (2017-11-13) * only users with read/write rights on the "_system" database can now execute "_admin/shutdown" as well as modify properties of the write-ahead log (WAL) - -* increase default maximum number of V8 contexts to at least 16 if not explicitly - configured otherwise. - the procedure for determining the actual maximum value of V8 contexts is unchanged + +* increase default maximum number of V8 contexts to at least 16 if not explicitly + configured otherwise. + the procedure for determining the actual maximum value of V8 contexts is unchanged apart from the value `16` and works as follows: - if explicitly set, the value of the configuration option `--javascript.v8-contexts` is used as the maximum number of V8 contexts - when the option is not set, the maximum number of V8 contexts is determined - by the configuration option `--server.threads` if that option is set. if + by the configuration option `--server.threads` if that option is set. if `--server.threads` is not set, then the maximum number of V8 contexts is the server's reported hardware concurrency (number of processors visible - to the arangod process). if that would result in a maximum value of less than 16 + to the arangod process). if that would result in a maximum value of less than 16 in any of these two cases, then the maximum value will be increased to 16. -* fixed issue #3447: ArangoError 1202: AQL: NotFound: (while executing) when +* fixed issue #3447: ArangoError 1202: AQL: NotFound: (while executing) when updating collection -* potential fix for issue #3581: Unexpected "rocksdb unique constraint +* potential fix for issue #3581: Unexpected "rocksdb unique constraint violated" with unique hash index * fixed geo index optimizer rule for geo indexes with a single (array of coordinates) @@ -177,14 +180,14 @@ v3.2.7 (2017-11-13) * several fixes for agency restart and shutdown -* the cluster-internal representation of planned collection objects is now more +* the cluster-internal representation of planned collection objects is now more lightweight than before, using less memory and not allocating any cache for indexes etc. * fixed issue #3403: How to kill long running AQL queries with the browser console's AQL (display issue) -* fixed issue #3549: server reading ENGINE config file fails on common standard +* fixed issue #3549: server reading ENGINE config file fails on common standard newline character * UI: fixed error notifications for collection modifications @@ -195,18 +198,18 @@ v3.2.7 (2017-11-13) order to prevent too frequent "could not truncate collection" errors * after a truncate operation, collections in MMFiles still used disk space. - to reclaim disk space used by truncated collection, the truncate actions + to reclaim disk space used by truncated collection, the truncate actions in the web interface and from the ArangoShell now issue an extra WAL flush command (in cluster mode, this command is also propagated to all servers). - the WAL flush allows all servers to write out any pending operations into the - datafiles of the truncated collection. afterwards, a final journal rotate - command is sent, which enables the compaction to entirely remove all datafiles + the WAL flush allows all servers to write out any pending operations into the + datafiles of the truncated collection. afterwards, a final journal rotate + command is sent, which enables the compaction to entirely remove all datafiles and journals for the truncated collection, so that all disk space can be reclaimed * for MMFiles a special method will be called after a truncate operation so that all indexes of the collection can free most of their memory. previously some - indexes (hash and skiplist indexes) partially kept already allocated memory + indexes (hash and skiplist indexes) partially kept already allocated memory in order to avoid future memory allocations * after a truncate operation in the RocksDB engine, an additional compaction @@ -220,7 +223,7 @@ v3.2.7 (2017-11-13) * enable JEMalloc background threads for purging and returning unused memory back to the operating system (Linux only) - JEMalloc will create its background threads on demand. The number of background + JEMalloc will create its background threads on demand. The number of background threads is capped by the number of CPUs or active arenas. The background threads run periodically and purge unused memory pages, allowing memory to be returned to the operating system. @@ -231,7 +234,7 @@ v3.2.7 (2017-11-13) * upgraded bundled V8 engine to bugfix version v5.7.492.77 - this upgrade fixes a memory leak in upstream V8 described in + this upgrade fixes a memory leak in upstream V8 described in https://bugs.chromium.org/p/v8/issues/detail?id=5945 that will result in memory chunks only getting uncommitted but not unmapped @@ -246,7 +249,7 @@ v3.2.6 (2017-10-26) * fixed a permission problem that prevented collection contents to be displayed in the web interface -* removed posix_fadvise call from RocksDB's PosixSequentialFile::Read(). This is +* removed posix_fadvise call from RocksDB's PosixSequentialFile::Read(). This is consistent with Facebook PR 2573 (#3505) this fix should improve the performance of the replication with the RocksDB @@ -283,12 +286,12 @@ v3.2.5 (2017-10-16) operations have at least one extra context. This requirement was not enforced anymore. -* fixed issue #3395: AQL: cannot instantiate CollectBlock with undetermined +* fixed issue #3395: AQL: cannot instantiate CollectBlock with undetermined aggregation method * UI: fixed wrong user attribute name validation, issue #3228 -* fix potential overflow in CRC marker check when a corrupted CRC marker +* fix potential overflow in CRC marker check when a corrupted CRC marker is found at the very beginning of an MMFiles datafile * UI: fixed unresponsive events in cluster shards view diff --git a/Documentation/Books/Manual/Administration/Arangodump.md b/Documentation/Books/Manual/Administration/Arangodump.md index 2f6cbfbf54..41a125995c 100644 --- a/Documentation/Books/Manual/Administration/Arangodump.md +++ b/Documentation/Books/Manual/Administration/Arangodump.md @@ -122,3 +122,40 @@ individually. No that in consequence, restoring such a collection without its prototype is affected. [arangorestore](Arangorestore.md) + + +### Encryption + +In the ArangoDB Enterprise Edition there are the additional parameters: + +#### Encryption key stored in file + +*--encryption.keyfile path-of-keyfile* + +The file `path-to-keyfile` must contain the encryption key. This +file must be secured, so that only `arangod` can access it. You should +also ensure that in case some-one steals the hardware, he will not be +able to read the file. For example, by encryption `/mytmpfs` or +creating a in-memory file-system under `/mytmpfs`. + +#### Encryption key generated by a program + +*--encryption.key-generator path-to-my-generator* + +The program `path-to-my-generator` must output the encryption on +standard output and exit. + +#### Creating keys + +The encryption keyfile must contain 32 bytes of random data. + +You can create it with a command line this. + +``` +dd if=/dev/random bs=1 count=32 of=yourSecretKeyFile +``` + +For security, it is best to create these keys offline (away from your +database servers) and directly store them in you secret management +tool. + diff --git a/Documentation/Books/Manual/Administration/Arangorestore.md b/Documentation/Books/Manual/Administration/Arangorestore.md index f52aa36921..e66469be9b 100644 --- a/Documentation/Books/Manual/Administration/Arangorestore.md +++ b/Documentation/Books/Manual/Administration/Arangorestore.md @@ -107,6 +107,10 @@ collections being processed before all [edge collection](../Appendix/Glossary.md data into edge collections will have the document collections linked in edges (*_from* and *_to* attributes) loaded. +### Encryption + +See [arangodump](Arangodump.md) for details. + ### Restoring Revision Ids and Collection Ids _arangorestore_ will reload document and edges data with the exact same *_key*, *_from* and diff --git a/arangosh/Restore/RestoreFeature.cpp b/arangosh/Restore/RestoreFeature.cpp index 0062a7c56b..f950238377 100644 --- a/arangosh/Restore/RestoreFeature.cpp +++ b/arangosh/Restore/RestoreFeature.cpp @@ -386,6 +386,29 @@ static bool SortCollections(VPackBuilder const& l, VPackBuilder const& r) { } int RestoreFeature::processInputDirectory(std::string& errorMsg) { + std::string encryptionType; + try { + std::string const encryptionFilename = FileUtils::buildFilename(_inputDirectory, "ENCRYPTION"); + if (FileUtils::exists(encryptionFilename)) { + encryptionType = StringUtils::trim(FileUtils::slurp(encryptionFilename)); + } else { + encryptionType = "none"; + } + } catch (...) { + // file not found etc. + } + + if (encryptionType != "none") { +#ifdef USE_ENTERPRISE + if (!_encryption->keyOptionSpecified()) { + std::cerr << "the dump data seems to be encrypted with " << encryptionType << ", but no key information was specified to decrypt the dump" << std::endl; + std::cerr << "it is recommended to specify either `--encryption.key-file` or `--encryption.key-generator` when invoking arangorestore with an encrypted dump" << std::endl; + } else { + std::cout << "# using encryption type " << encryptionType << " for reading dump" << std::endl; + } +#endif + } + // create a lookup table for collections std::map restrictList; for (size_t i = 0; i < _collections.size(); ++i) { diff --git a/etc/jenkins/arangod-common.conf b/etc/jenkins/arangod-common.conf index b110f5a714..f0aefe99d1 100644 --- a/etc/jenkins/arangod-common.conf +++ b/etc/jenkins/arangod-common.conf @@ -1,6 +1,7 @@ [log] force-direct = false line-number = true +foreground-tty = false level = info level = replication=warn level = development=debug diff --git a/js/apps/system/_admin/aardvark/APP/api-docs.json b/js/apps/system/_admin/aardvark/APP/api-docs.json index 351f9cdfdd..b7cdbc80ec 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 - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "JSA_put_api_simple_any": { "properties": { @@ -35,7 +35,7 @@ "collection" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_by_example": { "properties": { @@ -68,7 +68,7 @@ "limit" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_first_example": { "properties": { @@ -86,7 +86,7 @@ "example" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_fulltext": { "properties": { @@ -124,7 +124,7 @@ "index" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_near": { "properties": { @@ -167,7 +167,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_range": { "properties": { @@ -211,7 +211,7 @@ "skip" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_remove_by_example": { "properties": { @@ -232,7 +232,7 @@ "example" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_replace_by_example": { "properties": { @@ -258,7 +258,7 @@ "newValue" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_update_by_example": { "properties": { @@ -285,7 +285,7 @@ "newValue" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_within": { "properties": { @@ -333,7 +333,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSA_put_api_simple_within_rectangle": { "properties": { @@ -381,7 +381,7 @@ "geo" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "JSF_HTTP_API_TRAVERSAL": { "properties": { @@ -454,7 +454,7 @@ "startVertex" ], "type": "object", - "x-filename": "Graph Traversal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" + "x-filename": "Graph Traversal - /build/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" }, "JSF_general_graph_create_http_examples": { "properties": { @@ -483,7 +483,7 @@ "name" ], "type": "object", - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "JSF_general_graph_edge_definition_add_http_examples": { "properties": { @@ -512,7 +512,7 @@ "to" ], "type": "object", - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "JSF_general_graph_edge_definition_modify_http_examples": { "properties": { @@ -541,7 +541,7 @@ "to" ], "type": "object", - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "JSF_get_admin_log_rc_200": { "properties": { @@ -586,7 +586,7 @@ "totalAmount" ], "type": "object", - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "JSF_get_api_database_new": { "properties": { @@ -606,7 +606,7 @@ "name" ], "type": "object", - "x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md" + "x-filename": "Database - /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md" }, "JSF_get_api_database_new_USERS": { "description": "", @@ -652,7 +652,7 @@ "version" ], "type": "object", - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "JSF_get_engine_rc_200": { "properties": { @@ -665,7 +665,7 @@ "name" ], "type": "object", - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "JSF_post_api_aqlfunction": { "properties": { @@ -688,7 +688,7 @@ "code" ], "type": "object", - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "JSF_post_api_collection": { "properties": { @@ -753,7 +753,7 @@ "name" ], "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "JSF_post_api_collection_opts": { "description": "additional options for key generation. If specified, then *keyOptions*\nshould be a JSON array containing the following attributes:\n\n", @@ -778,7 +778,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "JSF_post_api_cursor": { "properties": { @@ -827,7 +827,7 @@ "query" ], "type": "object", - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" }, "JSF_post_api_cursor_opts": { "description": "key/value object with extra options for the query.\n\n", @@ -883,7 +883,7 @@ } }, "type": "object", - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" }, "JSF_post_api_cursor_rc_201": { "properties": { @@ -935,7 +935,7 @@ "cached" ], "type": "object", - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" }, "JSF_post_api_cursor_rc_400": { "properties": { @@ -966,7 +966,7 @@ "errorMessage" ], "type": "object", - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" }, "JSF_post_api_explain": { "properties": { @@ -990,7 +990,7 @@ "query" ], "type": "object", - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "JSF_post_api_export": { "properties": { @@ -1037,7 +1037,7 @@ "ttl" ], "type": "object", - "x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" + "x-filename": "Bulk - /build/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md" }, "JSF_post_api_export_restrictions": { "description": "an object containing an array of attribute names that will be \nincluded or excluded when returning result documents.\n\nNot specifying *restrict* will by default return all attributes of each document.\n\n", @@ -1056,7 +1056,7 @@ } }, "type": "object", - "x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" + "x-filename": "Bulk - /build/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md" }, "JSF_post_api_index_fulltext": { "properties": { @@ -1083,7 +1083,7 @@ "minLength" ], "type": "object", - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" }, "JSF_post_api_index_geo": { "properties": { @@ -1109,7 +1109,7 @@ "geoJson" ], "type": "object", - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" }, "JSF_post_api_index_hash": { "properties": { @@ -1147,7 +1147,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" }, "JSF_post_api_index_persistent": { "properties": { @@ -1180,7 +1180,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" }, "JSF_post_api_index_skiplist": { "properties": { @@ -1218,7 +1218,7 @@ "sparse" ], "type": "object", - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" }, "JSF_post_api_new_tasks": { "properties": { @@ -1251,7 +1251,7 @@ "params" ], "type": "object", - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "JSF_post_api_transaction": { "properties": { @@ -1298,7 +1298,7 @@ "action" ], "type": "object", - "x-filename": "Transactions - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" + "x-filename": "Transactions - /build/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" }, "JSF_post_batch_replication": { "properties": { @@ -1312,7 +1312,7 @@ "ttl" ], "type": "object", - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "JSF_put_admin_loglevel": { "properties": { @@ -1474,7 +1474,7 @@ } }, "type": "object", - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "JSF_put_api_new_tasks": { "properties": { @@ -1507,7 +1507,7 @@ "params" ], "type": "object", - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "JSF_put_api_replication_applier_adjust": { "properties": { @@ -1630,7 +1630,7 @@ "restrictType" ], "type": "object", - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "JSF_put_api_replication_makeSlave": { "properties": { @@ -1739,7 +1739,7 @@ "includeSystem" ], "type": "object", - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "JSF_put_api_replication_synchronize": { "properties": { @@ -1791,7 +1791,7 @@ "password" ], "type": "object", - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "JSF_put_batch_replication": { "properties": { @@ -1805,7 +1805,7 @@ "ttl" ], "type": "object", - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "PostApiQueryProperties": { "properties": { @@ -1818,7 +1818,7 @@ "query" ], "type": "object", - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "PutApiQueryCacheProperties": { "properties": { @@ -1837,7 +1837,7 @@ "maxResults" ], "type": "object", - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "PutApiQueryProperties": { "properties": { @@ -1881,7 +1881,7 @@ "maxQueryStringLength" ], "type": "object", - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "REST_DOCUMENT_READ_ALL": { "properties": { @@ -1895,7 +1895,7 @@ } }, "type": "object", - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "RestLookupByKeys": { "properties": { @@ -1916,7 +1916,7 @@ "keys" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "RestRemoveByKeys": { "properties": { @@ -1940,7 +1940,7 @@ "keys" ], "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "UserHandling_create": { "properties": { @@ -1968,7 +1968,7 @@ "passwd" ], "type": "object", - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_grantCollection": { "properties": { @@ -1981,7 +1981,7 @@ "grant" ], "type": "object", - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_grantDatabase": { "properties": { @@ -1994,7 +1994,7 @@ "grant" ], "type": "object", - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_modify": { "properties": { @@ -2017,7 +2017,7 @@ "passwd" ], "type": "object", - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "UserHandling_replace": { "properties": { @@ -2040,7 +2040,7 @@ "passwd" ], "type": "object", - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "collection_figures": { "description": "metrics of the collection\n\n", @@ -2104,7 +2104,7 @@ "indexes" ], "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_alive": { "description": "the currently active figures\n\n", @@ -2121,7 +2121,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_compactors": { "description": "\n", @@ -2138,7 +2138,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_datafiles": { "description": "Metrics regarding the datafiles\n\n", @@ -2155,7 +2155,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_dead": { "description": "the items waiting to be swept away by the cleaner\n\n", @@ -2177,7 +2177,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_indexes": { "description": "", @@ -2194,7 +2194,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_journals": { "description": "Metrics regarding the journal files\n\n", @@ -2211,7 +2211,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_readcache": { "description": "\n", @@ -2228,7 +2228,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "collection_figures_revisions": { "description": "\n", @@ -2245,7 +2245,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "compactionStatus_attributes": { "description": "", @@ -2260,7 +2260,7 @@ } }, "type": "object", - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "explain_options": { "description": "Options for the query\n\n", @@ -2284,7 +2284,7 @@ } }, "type": "object", - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "post_api_gharial_create_opts": { "description": "a JSON object which is only useful in Enterprise version and with isSmart set to true.\nIt can contain the following attributes:\n\n", @@ -2300,7 +2300,7 @@ } }, "type": "object", - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "put_api_simple_remove_by_example_opts": { "description": "a json object which can contains following attributes:\n\n", @@ -2315,7 +2315,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "put_api_simple_remove_by_keys_opts": { "description": "a json object which can contains following attributes:\n\n", @@ -2334,7 +2334,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "put_api_simple_replace_by_example_options": { "description": "a json object which can contain following attributes\n\n", @@ -2349,7 +2349,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" }, "put_api_simple_update_by_example_options": { "description": "a json object which can contains following attributes:\n\n", @@ -2373,7 +2373,7 @@ } }, "type": "object", - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "info": { @@ -2394,7 +2394,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" }, "get": { "description": "\n\n\nExecutes a cluster roundtrip from a coordinator to a DB server and\nback. This call only works in a coordinator node in a cluster.\nOne can and should append an arbitrary path to the URL and the\npart after */_admin/cluster-test* is used as the path of the HTTP\nrequest which is sent from the coordinator to a DB node. Likewise,\nany form data appended to the URL is forwarded in the request to the\nDB node. This handler takes care of all request types (see below)\nand uses the same request type in its request to the DB node.\n\nThe following HTTP headers are interpreted in a special way:\n\n - *X-Shard-ID*: This specifies the ID of the shard to which the\n cluster request is sent and thus tells the system to which DB server\n to send the cluster request. Note that the mapping from the\n shard ID to the responsible server has to be defined in the\n agency under *Current/ShardLocation/*. One has to give\n this header, otherwise the system does not know where to send\n the request.\n - *X-Client-Transaction-ID*: the value of this header is taken\n as the client transaction ID for the request\n - *X-Timeout*: specifies a timeout in seconds for the cluster\n operation. If the answer does not arrive within the specified\n timeout, an corresponding error is returned and any subsequent\n real answer is ignored. The default if not given is 24 hours.\n - *X-Synchronous-Mode*: If set to *true* the test function uses\n synchronous mode, otherwise the default asynchronous operation\n mode is used. This is mainly for debugging purposes.\n - *Host*: This header is ignored and not forwarded to the DB server.\n - *User-Agent*: This header is ignored and not forwarded to the DB\n server.\n\nAll other HTTP headers and the body of the request (if present, see\nother HTTP methods below) are forwarded as given in the original request.\n\nIn asynchronous mode the DB server answers with an HTTP request of its\nown, in synchronous mode it sends a HTTP response. In both cases the\nheaders and the body are used to produce the HTTP response of this\nAPI call.\n\n", @@ -2415,7 +2415,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" }, "head": { "description": "\n\nSee GET method.\n\n\n", @@ -2425,7 +2425,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" }, "patch": { "description": "\n\nSee GET method. The body can be any type and is simply forwarded.\n\n\n", @@ -2447,7 +2447,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" }, "post": { "description": "\n\nSee GET method.\n\n\n", @@ -2469,7 +2469,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" }, "put": { "description": "\n\nSee GET method. The body can be any type and is simply forwarded.\n\n\n", @@ -2491,7 +2491,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" } }, "/_admin/clusterCheckPort": { @@ -2519,7 +2519,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" } }, "/_admin/clusterStatistics": { @@ -2550,7 +2550,7 @@ "Cluster" ], "x-examples": [], - "x-filename": "Cluster - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md" + "x-filename": "Cluster - /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_check_port_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PATCH.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_POST.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_HEAD.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_GET.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_DELETE.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_test_PUT.md, /build/Documentation/DocuBlocks/Rest/Cluster/JSF_cluster_statistics_GET.md" } }, "/_admin/database/target-version": { @@ -2567,7 +2567,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/echo": { @@ -2584,7 +2584,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/execute": { @@ -2608,7 +2608,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/log": { @@ -2688,7 +2688,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/log/level": { @@ -2708,7 +2708,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "put": { "description": "\n\nModifies and returns the server's current loglevel settings.\nThe request body must be a JSON object with the log topics being the object keys\nand the log levels being the object values.\n\nThe result is a JSON object with the adjusted log topics being the object keys, and\nthe adjusted log levels being the object values.\n\nIt can set the loglevel of all facilities by only specifying the loglevel as string without json.\n\nPossible loglevels are:\n - FATAL - There will be no way out of this. ArangoDB will go down after this message.\n - ERROR - This is an error. you should investigate and fix it. It may harm your production.\n - WARNING - This may be serious application-wise, but we don't know.\n - INFO - Something has happened, take notice, but no drama attached.\n - DEBUG - output debug messages\n - TRACE - trace - prepare your log to be flooded - don't use in production.\n\n\n**A JSON object with these properties is required:**\n\n - **audit-service**: One of the possible loglevels.\n - **cache**: One of the possible loglevels.\n - **syscall**: One of the possible loglevels.\n - **communication**: One of the possible loglevels.\n - **audit-authentication**: One of the possible loglevels.\n - **agencycomm**: One of the possible loglevels.\n - **startup**: One of the possible loglevels.\n - **general**: One of the possible loglevels.\n - **cluster**: One of the possible loglevels.\n - **audit-view**: One of the possible loglevels.\n - **collector**: One of the possible loglevels.\n - **audit-documentation**: One of the possible loglevels.\n - **engines**: One of the possible loglevels.\n - **trx**: One of the possible loglevels.\n - **mmap**: One of the possible loglevels.\n - **agency**: One of the possible loglevels.\n - **authentication**: One of the possible loglevels.\n - **memory**: One of the possible loglevels.\n - **performance**: One of the possible loglevels.\n - **config**: One of the possible loglevels.\n - **authorization**: One of the possible loglevels.\n - **development**: One of the possible loglevels.\n - **datafiles**: One of the possible loglevels.\n - **views**: One of the possible loglevels.\n - **ldap**: One of the possible loglevels.\n - **replication**: One of the possible loglevels.\n - **threads**: One of the possible loglevels.\n - **audit-database**: One of the possible loglevels.\n - **v8**: One of the possible loglevels.\n - **ssl**: One of the possible loglevels.\n - **pregel**: One of the possible loglevels.\n - **audit-collection**: One of the possible loglevels.\n - **rocksdb**: One of the possible loglevels.\n - **supervision**: One of the possible loglevels.\n - **graphs**: One of the possible loglevels.\n - **compactor**: One of the possible loglevels.\n - **queries**: One of the possible loglevels.\n - **heartbeat**: One of the possible loglevels.\n - **requests**: One of the possible loglevels.\n\n\n", @@ -2742,7 +2742,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/long_echo": { @@ -2759,7 +2759,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/routing/reload": { @@ -2776,7 +2776,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/server/id": { @@ -2793,7 +2793,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/server/role": { @@ -2810,12 +2810,12 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/shutdown": { "delete": { - "description": "\n\nThis call initiates a clean shutdown sequence.\n\n", + "description": "\n\nThis call initiates a clean shutdown sequence. Requires administrive privileges\n\n", "parameters": [], "responses": { "200": { @@ -2827,33 +2827,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" - } - }, - "/_admin/sleep": { - "get": { - "description": "\n\n\nThe call returns an object with the attribute *duration*. This takes\nas many seconds as the duration argument says.\n\n", - "parameters": [ - { - "description": "wait `duration` seconds until the reply is sent.\n\n", - "format": "integer", - "in": "path", - "name": "duration", - "required": true, - "type": "integer" - } - ], - "responses": { - "200": { - "description": "Sleep was conducted successfully.\n\n\n" - } - }, - "summary": " Sleep for a specified amount of seconds", - "tags": [ - "Administration" - ], - "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/statistics": { @@ -2870,7 +2844,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/statistics-description": { @@ -2887,7 +2861,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/test": { @@ -2911,7 +2885,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/time": { @@ -2928,7 +2902,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_admin/wal/flush": { @@ -2963,7 +2937,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md" + "x-filename": "wal - /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" } }, "/_admin/wal/properties": { @@ -2983,7 +2957,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md" + "x-filename": "wal - /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" }, "put": { "description": "\n\n\nConfigures the behavior of the write-ahead log. The body of the request\nmust be a JSON object with the following attributes:\n- *allowOversizeEntries*: whether or not operations that are bigger than a\n single logfile can be executed and stored\n- *logfileSize*: the size of each write-ahead logfile\n- *historicLogfiles*: the maximum number of historic logfiles to keep\n- *reserveLogfiles*: the maximum number of reserve logfiles that ArangoDB\n allocates in the background\n- *throttleWait*: the maximum wait time that operations will wait before\n they get aborted if case of write-throttling (in milliseconds)\n- *throttleWhenPending*: the number of unprocessed garbage-collection\n operations that, when reached, will activate write-throttling. A value of\n *0* means that write-throttling will not be triggered.\n\nSpecifying any of the above attributes is optional. Not specified attributes\nwill be ignored and the configuration for them will not be modified.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_admin/wal/properties <<EOF\n{ \n  \"logfileSize\" : 33554432, \n  \"allowOversizeEntries\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"allowOversizeEntries\" : true, \n  \"logfileSize\" : 33554432, \n  \"historicLogfiles\" : 10, \n  \"reserveLogfiles\" : 3, \n  \"syncInterval\" : 100, \n  \"throttleWait\" : 15000, \n  \"throttleWhenPending\" : 0 \n}\n
\n\n\n\n\n", @@ -3001,7 +2975,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md" + "x-filename": "wal - /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" } }, "/_admin/wal/transactions": { @@ -3021,7 +2995,7 @@ "wal" ], "x-examples": [], - "x-filename": "wal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md" + "x-filename": "wal - /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_transactions.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_get_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_properties.md, /build/Documentation/DocuBlocks/Rest/wal/JSF_put_admin_wal_flush.md" } }, "/_api/aqlfunction": { @@ -3046,7 +3020,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "post": { "description": "\n**A JSON object with these properties is required:**\n\n - **isDeterministic**: an optional boolean value to indicate that the function\n results are fully deterministic (function return value solely depends on\n the input value and return value is the same for repeated calls with same\n input). The *isDeterministic* attribute is currently not used but may be\n used later for optimisations.\n - **code**: a string representation of the function body.\n - **name**: the fully qualified name of the user functions.\n\n\n\n\n\nIn case of success, the returned JSON object has the following properties:\n\n- *error*: boolean flag to indicate that an error occurred (*false*\n in this case)\n\n- *code*: the HTTP status code\n\nThe body of the response will contain a JSON object with additional error\ndetails. The object has the following attributes:\n\n- *error*: boolean flag to indicate that an error occurred (*true* in this case)\n\n- *code*: the HTTP status code\n\n- *errorNum*: the server error number\n\n- *errorMessage*: a descriptive error message\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/aqlfunction <<EOF\n{ \n  \"name\" : \"myfunctions::temperature::celsiustofahrenheit\", \n  \"code\" : \"function (celsius) { return celsius * 1.8 + 32; }\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201 \n}\n
\n\n\n\n\n", @@ -3077,7 +3051,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/aqlfunction/{name}": { @@ -3116,7 +3090,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/batch": { @@ -3151,7 +3125,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" + "x-filename": "Bulk - /build/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md" } }, "/_api/cluster/endpoints": { @@ -3171,7 +3145,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_api/collection": { @@ -3196,7 +3170,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "post": { "description": "\n**A JSON object with these properties is required:**\n\n - **journalSize**: The maximal size of a journal or datafile in bytes. The value \n must be at least `1048576` (1 MiB). (The default is a configuration parameter)\n This option is meaningful for the MMFiles storage engine only.\n - **replicationFactor**: (The default is *1*): in a cluster, this attribute determines how many copies \n of each shard are kept on different DBServers. The value 1 means that only one \n copy (no synchronous replication) is kept. A value of k means that k-1 replicas \n are kept. Any two copies reside on different DBServers. Replication between them is \n synchronous, that is, every write operation to the \"leader\" copy will be replicated \n to all \"follower\" replicas, before the write operation is reported successful.\n If a server fails, this is detected automatically and one of the servers holding \n copies take over, usually without an error being reported.\n - **keyOptions**:\n - **allowUserKeys**: if set to *true*, then it is allowed to supply own key values in the\n *_key* attribute of a document. If set to *false*, then the key generator\n will solely be responsible for generating keys and supplying own key values\n in the *_key* attribute of documents is considered an error.\n - **type**: specifies the type of the key generator. The currently available generators are\n *traditional* and *autoincrement*.\n - **increment**: increment value for *autoincrement* key generator. Not used for other key\n generator types.\n - **offset**: Initial offset value for *autoincrement* key generator.\n Not used for other key generator types.\n - **name**: The name of the collection.\n - **waitForSync**: If *true* then the data is synchronized to disk before returning from a\n document create, update, replace or removal operation. (default: false)\n - **doCompact**: whether or not the collection will be compacted (default is *true*)\n This option is meaningful for the MMFiles storage engine only.\n - **isVolatile**: If *true* then the collection data is kept in-memory only and not made persistent.\n Unloading the collection will cause the collection data to be discarded. Stopping\n or re-starting the server will also cause full loss of data in the\n collection. Setting this option will make the resulting collection be\n slightly faster than regular collections because ArangoDB does not\n enforce any synchronization to disk and does not calculate any CRC\n checksums for datafiles (as there are no datafiles). This option \n should therefore be used for cache-type collections only, and not \n for data that cannot be re-created otherwise.\n (The default is *false*)\n This option is meaningful for the MMFiles storage engine only.\n - **shardKeys**: (The default is *[ \"_key\" ]*): in a cluster, this attribute determines\n which document attributes are used to determine the target shard for documents.\n Documents are sent to shards based on the values of their shard key attributes.\n The values of all shard key attributes in a document are hashed,\n and the hash value is used to determine the target shard.\n **Note**: Values of shard key attributes cannot be changed once set.\n This option is meaningless in a single server setup.\n - **numberOfShards**: (The default is *1*): in a cluster, this value determines the\n number of shards to create for the collection. In a single\n server setup, this option is meaningless.\n - **isSystem**: If *true*, create a system collection. In this case *collection-name*\n should start with an underscore. End users should normally create non-system\n collections only. API implementors may be required to create system\n collections in very special occasions, but normally a regular collection will do.\n (The default is *false*)\n - **type**: (The default is *2*): the type of the collection to create.\n The following values for *type* are valid:\n - *2*: document collection\n - *3*: edges collection\n - **indexBuckets**: The number of buckets into which indexes using a hash\n table are split. The default is 16 and this number has to be a\n power of 2 and less than or equal to 1024. \n For very large collections one should increase this to avoid long pauses \n when the hash table has to be initially built or resized, since buckets \n are resized individually and can be initially built in parallel. For \n example, 64 might be a sensible value for a collection with 100\n 000 000 documents. Currently, only the edge index respects this\n value, but other index types might follow in future ArangoDB versions. \n Changes (see below) are applied when the collection is loaded the next \n time.\n This option is meaningful for the MMFiles storage engine only.\n\n\n\n\nCreates a new collection with a given name. The request must contain an\nobject with the following attributes.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionBasics\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/collection/testCollectionBasics\n\n{ \n  \"id\" : \"9794\", \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\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/collection/testCollectionEdges\n\n{ \n  \"id\" : \"9796\", \n  \"name\" : \"testCollectionEdges\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 3, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \"testCollectionUsers\", \n  \"keyOptions\" : { \n    \"type\" : \"autoincrement\", \n    \"increment\" : 5, \n    \"allowUserKeys\" : true \n  } \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/collection/testCollectionUsers\n\n{ \n  \"id\" : \"9806\", \n  \"name\" : \"testCollectionUsers\", \n  \"waitForSync\" : false, \n  \"isVolatile\" : false, \n  \"isSystem\" : false, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -3216,6 +3190,13 @@ "name": "waitForSyncReplication", "required": false, "type": "integer" + }, + { + "description": "Default is *1* which means the server will check if there are enough replicas\navailable at creation time and bail out otherwise. Set to *0* to disable this\nextra check.\n\n", + "in": "query", + "name": "enforceReplicationFactor", + "required": false, + "type": "integer" } ], "responses": { @@ -3231,7 +3212,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}": { @@ -3267,7 +3248,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "get": { "description": "\n\nThe result is an object describing the collection with the following\nattributes:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *status*: The status of the collection as number.\n - 1: new born collection\n - 2: unloaded\n - 3: loaded\n - 4: in the process of being unloaded\n - 5: deleted\n - 6: loading\n\nEvery other status indicates a corrupted collection.\n\n- *type*: The type of the collection as number.\n - 2: document collection (normal case)\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n", @@ -3291,7 +3272,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/checksum": { @@ -3334,7 +3315,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/count": { @@ -3363,7 +3344,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/figures": { @@ -3402,7 +3383,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/load": { @@ -3431,7 +3412,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/loadIndexesIntoMemory": { @@ -3463,7 +3444,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/properties": { @@ -3492,7 +3473,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" }, "put": { "description": "\n\nChanges the properties of a collection. Expects an object with the\nattribute(s)\n\n- *waitForSync*: If *true* then creating or changing a\n document will wait until the data has been synchronized to disk.\n\n- *journalSize*: The maximal size of a journal or datafile in bytes. \n The value must be at least `1048576` (1 MB). Note that when\n changing the journalSize value, it will only have an effect for\n additional journals or datafiles that are created. Already\n existing journals or datafiles will not be affected.\n\nOn success an object with the following attributes is returned:\n\n- *id*: The identifier of the collection.\n\n- *name*: The name of the collection.\n\n- *waitForSync*: The new value.\n\n- *journalSize*: The new value.\n\n- *status*: The status of the collection as number.\n\n- *type*: The collection type. Valid types are:\n - 2: document collection\n - 3: edges collection\n\n- *isSystem*: If *true* then the collection is a system collection.\n\n- *isVolatile*: If *true* then the collection data will be\n kept in memory only and ArangoDB will not write or sync the data\n to disk.\n\n- *doCompact*: Whether or not the collection will be compacted.\n\n- *keyOptions*: JSON object which contains key generation options:\n - *type*: specifies the type of the key generator. The currently\n available generators are *traditional* and *autoincrement*.\n - *allowUserKeys*: if set to *true*, then it is allowed to supply\n own key values in the *_key* attribute of a document. If set to\n *false*, then the key generator is solely responsible for\n generating keys and supplying own key values in the *_key* attribute\n of documents is considered an error.\n\n**Note**: except for *waitForSync*, *journalSize* and *name*, collection\nproperties **cannot be changed** once a collection is created. To rename\na collection, the rename endpoint must be used.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/collection/products/properties <<EOF\n{ \n  \"waitForSync\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"10226\", \n  \"name\" : \"products\", \n  \"isSystem\" : false, \n  \"doCompact\" : true, \n  \"isVolatile\" : false, \n  \"journalSize\" : 33554432, \n  \"keyOptions\" : { \n    \"type\" : \"traditional\", \n    \"allowUserKeys\" : true, \n    \"lastValue\" : 0 \n  }, \n  \"waitForSync\" : true, \n  \"indexBuckets\" : 8, \n  \"status\" : 3, \n  \"type\" : 2, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -3519,7 +3500,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/rename": { @@ -3548,7 +3529,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/revision": { @@ -3577,7 +3558,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/rotate": { @@ -3606,7 +3587,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/truncate": { @@ -3635,7 +3616,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/collection/{collection-name}/unload": { @@ -3664,7 +3645,7 @@ "Collections" ], "x-examples": [], - "x-filename": "Collections - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md" + "x-filename": "Collections - /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_checksum.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_properties.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_count.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rename.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_post_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_unload.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_delete_api_collection.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_get_api_collections.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_name.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_revision.md, /build/Documentation/DocuBlocks/Rest/Collections/JSA_get_api_collection_figures.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_truncate.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_load_indexes_in_memory.md, /build/Documentation/DocuBlocks/Rest/Collections/JSF_put_api_collection_rotate.md" } }, "/_api/cursor": { @@ -3711,7 +3692,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" } }, "/_api/cursor/{cursor-identifier}": { @@ -3740,7 +3721,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" }, "put": { "description": "\n\n\nIf the cursor is still alive, returns an object with the following\nattributes:\n\n- *id*: the *cursor-identifier*\n- *result*: a list of documents for the current batch\n- *hasMore*: *false* if this was the last batch\n- *count*: if present the total number of elements\n\nNote that even if *hasMore* returns *true*, the next call might\nstill return no documents. If, however, *hasMore* is *false*, then\nthe cursor is exhausted. Once the *hasMore* attribute has a value of\n*false*, the client can stop.\n\n\n\n\n#Example:\n Valid request for next batch\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/cursor <<EOF\n{ \n  \"query\" : \"FOR p IN products LIMIT 5 RETURN p\", \n  \"count\" : true, \n  \"batchSize\" : 2 \n}\nEOF\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/cursor/10406\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 200, \n  \"result\" : [ \n    { \n      \"_key\" : \"10403\", \n      \"_id\" : \"products/10403\", \n      \"_rev\" : \"_VvTRmi6--B\", \n      \"hello5\" : \"world1\" \n    }, \n    { \n      \"_key\" : \"10400\", \n      \"_id\" : \"products/10400\", \n      \"_rev\" : \"_VvTRmi6--A\", \n      \"hello4\" : \"world1\" \n    } \n  ], \n  \"hasMore\" : true, \n  \"id\" : \"10406\", \n  \"count\" : 5, \n  \"extra\" : { \n    \"stats\" : { \n      \"writesExecuted\" : 0, \n      \"writesIgnored\" : 0, \n      \"scannedFull\" : 5, \n      \"scannedIndex\" : 0, \n      \"filtered\" : 0, \n      \"httpRequests\" : 0, \n      \"executionTime\" : 0.00012946128845214844 \n    }, \n    \"warnings\" : [ ] \n  }, \n  \"cached\" : false \n}\n
\n\n\n\n\n#Example:\n Missing identifier\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/cursor\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"expecting PUT /_api/cursor/<cursor-id>\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n#Example:\n Unknown identifier\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/cursor/123123\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"cursor not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1600 \n}\n
\n\n\n\n\n", @@ -3770,7 +3751,7 @@ "Cursors" ], "x-examples": [], - "x-filename": "Cursors - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md" + "x-filename": "Cursors - /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_identifier.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor_delete.md, /build/Documentation/DocuBlocks/Rest/Cursors/JSF_post_api_cursor.md" } }, "/_api/database": { @@ -3793,7 +3774,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md" + "x-filename": "Database - /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md" }, "post": { "description": "\n**A JSON object with these properties is required:**\n\n - **name**: Has to contain a valid database name.\n - **users**: Has to be an array of user objects to initially create for the new database.\n User information will not be changed for users that already exist.\n If *users* is not specified or does not contain any users, a default user\n *root* will be created with an empty string password. This ensures that the\n new database will be accessible after it is created.\n Each user object can contain the following attributes:\n - **username**: Loginname of the user to be created\n - **passwd**: The user password as a string. If not specified, it will default to an empty string.\n - **active**: A flag indicating whether the user account should be activated or not.\n The default value is *true*. If set to *false*, the user won't be able to\n log into the database.\n - **extra**: A JSON object with extra user information. The data contained in *extra*\n will be stored for the user but not be interpreted further by ArangoDB.\n\n\n\n\nCreates a new database\n\nThe response is a JSON object with the attribute *result* set to *true*.\n\n**Note**: creating a new database is only possible from within the *_system* database.\n\n\n\n\n#Example:\n Creating a database named *example*.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database <<EOF\n{ \n  \"name\" : \"example\" \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : true \n}\n
\n\n\n\n\n#Example:\n Creating a database named *mydb* with two users.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/database <<EOF\n{ \n  \"name\" : \"mydb\", \n  \"users\" : [ \n    { \n      \"username\" : \"admin\", \n      \"passwd\" : \"secret\", \n      \"active\" : true \n    }, \n    { \n      \"username\" : \"tester\", \n      \"passwd\" : \"test001\", \n      \"active\" : false \n    } \n  ] \n}\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"code\" : 201, \n  \"result\" : true \n}\n
\n\n\n\n\n", @@ -3827,7 +3808,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md" + "x-filename": "Database - /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md" } }, "/_api/database/current": { @@ -3850,7 +3831,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md" + "x-filename": "Database - /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md" } }, "/_api/database/user": { @@ -3870,7 +3851,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md" + "x-filename": "Database - /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md" } }, "/_api/database/{database-name}": { @@ -3905,7 +3886,7 @@ "Database" ], "x-examples": [], - "x-filename": "Database - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md" + "x-filename": "Database - /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_new.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_list.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_current.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_delete.md, /build/Documentation/DocuBlocks/Rest/Database/JSF_get_api_database_user.md" } }, "/_api/document/{collection}": { @@ -3969,7 +3950,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "patch": { "description": "\n\nPartially updates documents, the documents to update are specified\nby the *_key* attributes in the body objects. The body of the\nrequest must contain a JSON array of document updates with the\nattributes to patch (the patch documents). All attributes from the\npatch documents will be added to the existing documents if they do\nnot yet exist, and overwritten in the existing documents if they do\nexist there.\n\nSetting an attribute value to *null* in the patch documents will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a\ndocument in the body and its value does not match the revision of\nthe corresponding document in the database, the precondition is\nviolated.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nThe body of the response contains a JSON array of the same length\nas the input array with the information about the handle and the\nrevision of the updated documents. In each entry, the attribute\n*_id* contains the known *document-handle* of each updated document,\n*_key* contains the key which uniquely identifies a document in a\ngiven collection, and the attribute *_rev* contains the new document\nrevision. In case of an error or violated precondition, an error\nobject with the attribute *error* set to *true* and the attribute\n*errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each\ngenerated document, the complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 201 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n", @@ -4055,7 +4036,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "post": { "description": "\n\nCreates a new document from the document given in the body, unless there\nis already a document with the *_key* given. If no *_key* is given, a new\nunique *_key* is generated automatically.\n\nThe body can be an array of documents, in which case all\ndocuments in the array are inserted with the same semantics as for a\nsingle document. The result body will contain a JSON array of the\nsame length as the input array, and each entry contains the result\nof the operation for the corresponding input. In case of an error\nthe entry is a document with attributes *error* set to *true* and\nerrorCode set to the error code that has happened.\n\nPossibly given *_id* and *_rev* attributes in the body are always ignored,\nthe URL part or the query parameter collection respectively counts.\n\nIf the document was created successfully, then the *Location* header\ncontains the path to the newly created document. The *ETag* header field\ncontains the revision of the document. Both are only set in the single\ndocument case.\n\nIf *silent* is not set to *true*, the body of the response contains a \nJSON object (single document case) with the following attributes:\n\n - *_id* contains the document handle of the newly created document\n - *_key* contains the document key\n - *_rev* contains the document revision\n\nIn the multi case the body is an array of such objects.\n\nIf the collection parameter *waitForSync* is *false*, then the call\nreturns as soon as the document has been accepted. It will not wait\nuntil the documents have been synced to disk.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document creation operation to disk even in\ncase that the *waitForSync* flag had been disabled for the entire\ncollection. Thus, the *waitForSync* query parameter can be used to\nforce synchronization of just this specific operations. To use this,\nset the *waitForSync* parameter to *true*. If the *waitForSync*\nparameter is not specified or set to *false*, then the collection's\ndefault *waitForSync* behavior is applied. The *waitForSync* query\nparameter cannot be used to disable synchronization for collections\nthat have a default *waitForSync* value of *true*.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\n\n\n\n#Example:\n Create a document in a collection named *products*. Note that the\nrevision identifier might or might not by equal to the auto-generated\nkey.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRpCq---\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10714\n\n{ \n  \"_id\" : \"products/10714\", \n  \"_key\" : \"10714\", \n  \"_rev\" : \"_VvTRpCq---\" \n}\n
\n\n\n\n\n#Example:\n Create a document in a collection named *products* with a collection-level\n*waitForSync* value of *false*.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRoze---\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10690\n\n{ \n  \"_id\" : \"products/10690\", \n  \"_key\" : \"10690\", \n  \"_rev\" : \"_VvTRoze---\" \n}\n
\n\n\n\n\n#Example:\n Create a document in a collection with a collection-level *waitForSync*\nvalue of *false*, but using the *waitForSync* query parameter.\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?waitForSync=true <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 201 Created\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRpWi---\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10762\n\n{ \n  \"_id\" : \"products/10762\", \n  \"_key\" : \"10762\", \n  \"_rev\" : \"_VvTRpWi---\" \n}\n
\n\n\n\n\n#Example:\n Unknown collection name\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ \"Hello\": \"World\" }\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n#Example:\n Illegal document\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n{ 1: \"World\" }\nEOF\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"VPackError error: Expecting '\\\"' or '}'\", \n  \"code\" : 400, \n  \"errorNum\" : 600 \n}\n
\n\n\n\n\n#Example:\n Insert multiple documents:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products <<EOF\n[{\"Hello\":\"Earth\"}, {\"Hello\":\"Venus\"}, {\"Hello\":\"Mars\"}]\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  { \n    \"_id\" : \"products/10728\", \n    \"_key\" : \"10728\", \n    \"_rev\" : \"_VvTRpLC---\" \n  }, \n  { \n    \"_id\" : \"products/10732\", \n    \"_key\" : \"10732\", \n    \"_rev\" : \"_VvTRpLC--_\" \n  }, \n  { \n    \"_id\" : \"products/10734\", \n    \"_key\" : \"10734\", \n    \"_rev\" : \"_VvTRpLC--A\" \n  } \n]\n
\n\n\n\n\n#Example:\n Use of returnNew:\n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/document/products?returnNew=true <<EOF\n{\"Hello\":\"World\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRpQy---\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10748\n\n{ \n  \"_id\" : \"products/10748\", \n  \"_key\" : \"10748\", \n  \"_rev\" : \"_VvTRpQy---\", \n  \"new\" : { \n    \"_key\" : \"10748\", \n    \"_id\" : \"products/10748\", \n    \"_rev\" : \"_VvTRpQy---\", \n    \"Hello\" : \"World\" \n  } \n}\n
\n\n\n\n\n", @@ -4130,7 +4111,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "put": { "description": "\n\nReplaces multiple documents in the specified collection with the\nones in the body, the replaced documents are specified by the *_key*\nattributes in the body documents.\n\nIf *ignoreRevs* is *false* and there is a *_rev* attribute in a\ndocument in the body and its value does not match the revision of\nthe corresponding document in the database, the precondition is\nviolated.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below).\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nThe body of the response contains a JSON array of the same length\nas the input array with the information about the handle and the\nrevision of the replaced documents. In each entry, the attribute\n*_id* contains the known *document-handle* of each updated document,\n*_key* contains the key which uniquely identifies a document in a\ngiven collection, and the attribute *_rev* contains the new document\nrevision. In case of an error or violated precondition, an error\nobject with the attribute *error* set to *true* and the attribute\n*errorCode* set to the error code is built.\n\nIf the query parameter *returnOld* is *true*, then, for each\ngenerated document, the complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then, for each\ngenerated document, the complete new document is returned under\nthe *new* attribute in the result.\n\nNote that if any precondition is violated or an error occurred with\nsome of the documents, the return code is still 201 or 202, but\nthe additional HTTP header *X-Arango-Error-Codes* is set, which\ncontains a map of the error codes that occurred together with their\nmultiplicities, as in: *1200:17,1205:10* which means that in 17\ncases the error 1200 \"revision conflict\" and in 10 cases the error\n1205 \"illegal document handle\" has happened.\n\n", @@ -4202,7 +4183,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" } }, "/_api/document/{document-handle}": { @@ -4264,7 +4245,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "get": { "description": "\n\nReturns the document identified by *document-handle*. The returned\ndocument contains three special attributes: *_id* containing the document\nhandle, *_key* containing key which uniquely identifies a document\nin a given collection and *_rev* containing the revision.\n\n\n\n\n#Example:\n Use a document handle:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/10776\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRpdW---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"10776\", \n  \"_id\" : \"products/10776\", \n  \"_rev\" : \"_VvTRpdW---\", \n  \"hello\" : \"world\" \n}\n
\n\n\n\n\n#Example:\n Use a document handle and an etag:\n\n
shell> curl --header 'If-None-Match: \"_VvTRp2----\"' --dump - http://localhost:8529/_api/document/products/10848\n\n
\n\n\n\n\n#Example:\n Unknown document handle:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/unknownhandle\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"collection not found: products\", \n  \"code\" : 404, \n  \"errorNum\" : 1203 \n}\n
\n\n\n\n\n", @@ -4309,7 +4290,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "head": { "description": "\n\nLike *GET*, but only returns the header fields and not the body. You\ncan use this call to get the current revision of a document or check if\nthe document was deleted.\n\n\n\n\n#Example:\n \n\n
shell> curl -X HEAD --dump - http://localhost:8529/_api/document/products/10833\n\n
\n\n\n\n\n\n", @@ -4354,7 +4335,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "patch": { "description": "\n\nPartially updates the document identified by *document-handle*.\nThe body of the request must contain a JSON document with the\nattributes to patch (the patch document). All attributes from the\npatch document will be added to the existing document if they do not\nyet exist, and overwritten in the existing document if they do exist\nthere.\n\nSetting an attribute value to *null* in the patch document will cause a\nvalue of *null* to be saved for the attribute by default.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *ETag* header field contains the new revision of the document\nand the *Location* header contains a complete URL under which the\ndocument can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the updated document operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n#Example:\n Patches an existing document with new content.\n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10647 <<EOF\n{ \n  \"hello\" : \"world\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRoj2--_\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10647\n\n{ \n  \"_id\" : \"products/10647\", \n  \"_key\" : \"10647\", \n  \"_rev\" : \"_VvTRoj2--_\", \n  \"_oldRev\" : \"_VvTRojy---\" \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10647 <<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: \"_VvTRoj6--_\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10647\n\n{ \n  \"_id\" : \"products/10647\", \n  \"_key\" : \"10647\", \n  \"_rev\" : \"_VvTRoj6--_\", \n  \"_oldRev\" : \"_VvTRoj2--_\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10647\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRoj6--_\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"10647\", \n  \"_id\" : \"products/10647\", \n  \"_rev\" : \"_VvTRoj6--_\", \n  \"one\" : \"world\", \n  \"hello\" : \"world\", \n  \"numbers\" : { \n    \"one\" : 1, \n    \"two\" : 2, \n    \"three\" : 3, \n    \"empty\" : null \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10647?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: \"_VvTRokC--_\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10647\n\n{ \n  \"_id\" : \"products/10647\", \n  \"_key\" : \"10647\", \n  \"_rev\" : \"_VvTRokC--_\", \n  \"_oldRev\" : \"_VvTRoj6--_\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10647\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRokC--_\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"10647\", \n  \"_id\" : \"products/10647\", \n  \"_rev\" : \"_VvTRokC--_\", \n  \"one\" : \"world\", \n  \"numbers\" : { \n    \"empty\" : null, \n    \"one\" : 1, \n    \"three\" : 3, \n    \"two\" : 2, \n    \"four\" : 4 \n  } \n}\n
\n\n\n\n\n#Example:\n Merging attributes of an object using `mergeObjects`:\n\n
shell> curl --dump - http://localhost:8529/_api/document/products/10669\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRoqC---\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"10669\", \n  \"_id\" : \"products/10669\", \n  \"_rev\" : \"_VvTRoqC---\", \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000 \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10669?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/10669\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRoqK--_\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"10669\", \n  \"_id\" : \"products/10669\", \n  \"_rev\" : \"_VvTRoqK--_\", \n  \"inhabitants\" : { \n    \"china\" : 1366980000, \n    \"india\" : 1263590000, \n    \"usa\" : 319220000, \n    \"indonesia\" : 252164800, \n    \"brazil\" : 203553000 \n  } \n}\nshell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/document/products/10669?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: \"_VvTRoqO--_\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10669\n\n{ \n  \"_id\" : \"products/10669\", \n  \"_key\" : \"10669\", \n  \"_rev\" : \"_VvTRoqO--_\", \n  \"_oldRev\" : \"_VvTRoqK--_\" \n}\nshell> curl --dump - http://localhost:8529/_api/document/products/10669\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRoqO--_\"\nx-content-type-options: nosniff\n\n{ \n  \"_key\" : \"10669\", \n  \"_id\" : \"products/10669\", \n  \"_rev\" : \"_VvTRoqO--_\", \n  \"inhabitants\" : { \n    \"pakistan\" : 188346000 \n  } \n}\n
\n\n\n\n\n", @@ -4456,7 +4437,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" }, "put": { "description": "\n\nReplaces the document with handle with the one in\nthe body, provided there is such a document and no precondition is\nviolated.\n\nIf the *If-Match* header is specified and the revision of the\ndocument in the database is unequal to the given revision, the\nprecondition is violated.\n\nIf *If-Match* is not given and *ignoreRevs* is *false* and there\nis a *_rev* attribute in the body and its value does not match\nthe revision of the document in the database, the precondition is\nviolated.\n\nIf a precondition is violated, an *HTTP 412* is returned.\n\nIf the document exists and can be updated, then an *HTTP 201* or\nan *HTTP 202* is returned (depending on *waitForSync*, see below),\nthe *ETag* header field contains the new revision of the document\nand the *Location* header contains a complete URL under which the\ndocument can be queried.\n\nOptionally, the query parameter *waitForSync* can be used to force\nsynchronization of the document replacement operation to disk even in case\nthat the *waitForSync* flag had been disabled for the entire collection.\nThus, the *waitForSync* query parameter can be used to force synchronization\nof just specific operations. To use this, set the *waitForSync* parameter\nto *true*. If the *waitForSync* parameter is not specified or set to\n*false*, then the collection's default *waitForSync* behavior is\napplied. The *waitForSync* query parameter cannot be used to disable\nsynchronization for collections that have a default *waitForSync* value\nof *true*.\n\nIf *silent* is not set to *true*, the body of the response contains a JSON \nobject with the information about the handle and the revision. The attribute \n*_id* contains the known *document-handle* of the updated document, *_key* \ncontains the key which uniquely identifies a document in a given collection, \nand the attribute *_rev* contains the new document revision.\n\nIf the query parameter *returnOld* is *true*, then\nthe complete previous revision of the document\nis returned under the *old* attribute in the result.\n\nIf the query parameter *returnNew* is *true*, then\nthe complete new document is returned under\nthe *new* attribute in the result.\n\nIf the document does not exist, then a *HTTP 404* is returned and the\nbody of the response contains an error document.\n\n\n\n\n#Example:\n Using a document handle\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/10863 <<EOF\n{\"Hello\": \"you\"}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRp6y--_\"\nx-content-type-options: nosniff\nlocation: /_db/_system/_api/document/products/10863\n\n{ \n  \"_id\" : \"products/10863\", \n  \"_key\" : \"10863\", \n  \"_rev\" : \"_VvTRp6y--_\", \n  \"_oldRev\" : \"_VvTRp6u---\" \n}\n
\n\n\n\n\n#Example:\n Unknown document handle\n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/document/products/10897 <<EOF\n{}\nEOF\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"document not found\", \n  \"code\" : 404, \n  \"errorNum\" : 1202 \n}\n
\n\n\n\n\n#Example:\n Produce a revision conflict\n\n
shell> curl -X PUT --header 'If-Match: \"_VvTRqCG---\"' --data-binary @- --dump - http://localhost:8529/_api/document/products/10879 <<EOF\n{\"other\":\"content\"}\nEOF\n\nHTTP/1.1 412 Precondition Failed\ncontent-type: application/json; charset=utf-8\netag: \"_VvTRqCC---\"\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 412, \n  \"errorNum\" : 1200, \n  \"errorMessage\" : \"precondition failed\", \n  \"_id\" : \"products/10879\", \n  \"_key\" : \"10879\", \n  \"_rev\" : \"_VvTRqCC---\" \n}\n
\n\n\n\n\n", @@ -4544,7 +4525,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" } }, "/_api/edges/{collection-id}": { @@ -4590,7 +4571,7 @@ "Graph Edges" ], "x-examples": [], - "x-filename": "Graph Edges - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READINOUTBOUND.md" + "x-filename": "Graph Edges - /build/Documentation/DocuBlocks/Rest/Graph Edges/API_EDGE_READINOUTBOUND.md" } }, "/_api/endpoint": { @@ -4613,7 +4594,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_api/engine": { @@ -4637,7 +4618,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_api/explain": { @@ -4670,7 +4651,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/export": { @@ -4716,7 +4697,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" + "x-filename": "Bulk - /build/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md" } }, "/_api/foxx": { @@ -4733,7 +4714,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "post": { "description": "\n\nInstalls the given new service at the given mount path.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n", @@ -4777,7 +4758,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/commit": { @@ -4802,7 +4783,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/configuration": { @@ -4827,7 +4808,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "patch": { "description": "\n\nReplaces the given service's configuration.\n\nReturns an object mapping all configuration option names to their new values.\n\n", @@ -4856,7 +4837,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "put": { "description": "\n\nReplaces the given service's configuration completely.\n\nReturns an object mapping all configuration option names to their new values.\n\n", @@ -4885,7 +4866,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/dependencies": { @@ -4910,7 +4891,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "patch": { "description": "\n\nReplaces the given service's dependencies.\n\nReturns an object mapping all dependency names to their new mount paths.\n\n", @@ -4939,7 +4920,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "put": { "description": "\n\nReplaces the given service's dependencies completely.\n\nReturns an object mapping all dependency names to their new mount paths.\n\n", @@ -4968,7 +4949,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/development": { @@ -4993,7 +4974,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "post": { "description": "\n\nPuts the service into development mode.\n\nWhile the service is running in development mode the service will be reloaded\nfrom the filesystem and its setup script (if any) will be re-executed every\ntime the service handles a request.\n\nWhen running ArangoDB in a cluster with multiple coordinators note that changes\nto the filesystem on one coordinator will not be reflected across the other\ncoordinators. This means you should treat your coordinators as inconsistent\nas long as any service is running in development mode.\n\n", @@ -5016,7 +4997,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/download": { @@ -5044,7 +5025,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/readme": { @@ -5072,7 +5053,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/scripts": { @@ -5097,7 +5078,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/scripts/{name}": { @@ -5133,7 +5114,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/service": { @@ -5165,7 +5146,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "get": { "description": "\n\nFetches detailed information for the service at the given mount path.\n\nReturns an object with the following attributes:\n\n- *mount*: the mount path of the service\n- *path*: the local file system path of the service\n- *development*: *true* if the service is running in development mode\n- *legacy*: *true* if the service is running in 2.8 legacy compatibility mode\n- *manifest*: the normalized JSON manifest of the service\n\nAdditionally the object may contain the following attributes if they have been set on the manifest:\n\n- *name*: a string identifying the service type\n- *version*: a semver-compatible version string\n\n", @@ -5191,7 +5172,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "patch": { "description": "\n\nInstalls the given new service on top of the service currently installed at the given mount path.\nThis is only recommended for switching between different versions of the same service.\n\nUnlike replacing a service, upgrading a service retains the old service's configuration\nand dependencies (if any) and should therefore only be used to migrate an existing service\nto a newer or equivalent service.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n", @@ -5235,7 +5216,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" }, "put": { "description": "\n\nRemoves the service at the given mount path from the database and file system.\nThen installs the given new service at the same mount path.\n\nThis is a slightly safer equivalent to performing an uninstall of the old service\nfollowed by installing the new service. The new service's main and script files\n(if any) will be checked for basic syntax errors before the old service is removed.\n\nThe request body can be any of the following formats:\n\n- `application/zip`: a raw zip bundle containing a service\n- `application/javascript`: a standalone JavaScript file\n- `application/json`: a service definition as JSON\n- `multipart/form-data`: a service definition as a multipart form\n\nA service definition is an object or form with the following properties or fields:\n\n- *configuration*: a JSON object describing configuration values\n- *dependencies*: a JSON object describing dependency settings\n- *source*: a fully qualified URL or an absolute path on the server's file system\n\nWhen using multipart data, the *source* field can also alternatively be a file field\ncontaining either a zip bundle or a standalone JavaScript file.\n\nWhen using a standalone JavaScript file the given file will be executed\nto define our service's HTTP endpoints. It is the same which would be defined\nin the field `main` of the service manifest.\n\nIf *source* is a URL, the URL must be reachable from the server.\nIf *source* is a file system path, the path will be resolved on the server.\nIn either case the path or URL is expected to resolve to a zip bundle.\n\nNote that when using file system paths in a cluster with multiple coordinators\nthe file system path must resolve to equivalent files on every coordinator.\n\n", @@ -5279,7 +5260,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/swagger": { @@ -5304,12 +5285,12 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/foxx/tests": { "post": { - "description": "\n\nRuns the tests for the service at the given mount path and returns the results.\n\nSupported test reporters are:\n\n- *default*: a simple list of test cases\n- *suite*: a object of test cases nested in suites\n- *stream*: a raw stream of test results\n- *xunit*: an XUnit/JUnit compatible structure\n- *tap*: a raw TAP compatible stream\n\nThe *Accept* request header can be used to further control the response format:\n\nWhen using the *stream* reporter `application/x-ldjson` will result\nin the response body being formatted as a newline-delimited JSON stream.\n\nWhen using the *tap* reporter `text/plain` or `text/*` will result\nin the response body being formatted as a plain text TAP report.\n\nWhen using the *xunit* reporter `application/xml` or `text/xml` will result\nin the response body being formatted as XML instead of JSONML.\n\nOtherwise the response body will be formatted as non-prettyprinted JSON.\n\n", + "description": "\n\nRuns the tests for the service at the given mount path and returns the results.\n\nSupported test reporters are:\n\n- *default*: a simple list of test cases\n- *suite*: an object of test cases nested in suites\n- *stream*: a raw stream of test results\n- *xunit*: an XUnit/JUnit compatible structure\n- *tap*: a raw TAP compatible stream\n\nThe *Accept* request header can be used to further control the response format:\n\nWhen using the *stream* reporter `application/x-ldjson` will result\nin the response body being formatted as a newline-delimited JSON stream.\n\nWhen using the *tap* reporter `text/plain` or `text/*` will result\nin the response body being formatted as a plain text TAP report.\n\nWhen using the *xunit* reporter `application/xml` or `text/xml` will result\nin the response body being formatted as XML instead of JSONML.\n\nOtherwise the response body will be formatted as non-prettyprinted JSON.\n\n", "parameters": [ { "description": "Mount path of the installed service.\n\n", @@ -5343,7 +5324,7 @@ "Foxx" ], "x-examples": [], - "x-filename": "Foxx - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md" + "x-filename": "Foxx - /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_details.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_list.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_scripts_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_enable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_bundle.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_swagger.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_commit.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_install.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_tests_run.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_uninstall.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_readme.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_dependencies_get.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_development_disable.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_configuration_update.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_replace.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_upgrade.md, /build/Documentation/DocuBlocks/Rest/Foxx/api_foxx_service_list.md" } }, "/_api/gharial": { @@ -5360,7 +5341,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "post": { "description": "\n\nThe creation of a graph requires the name of the graph and a\ndefinition of its edges.\n[See also edge definitions](../../Manual/Graphs/GeneralGraphs/Management.html#edge-definitions).\n\n\n**A JSON object with these properties is required:**\n\n - **orphanCollections**: An array of additional vertex collections.\n - **edgeDefinitions**: An array of definitions for the edge\n - **name**: Name of the graph.\n - **isSmart**: Define if the created graph should be smart.\n This only has effect in Enterprise version.\n - **options**:\n - **smartGraphAttribute**: The attribute name that is used to smartly shard the vertices of a graph.\n Every vertex in this Graph has to have this attribute.\n Cannot be modified later.\n - **numberOfShards**: The number of shards that is used for every collection within this graph.\n Cannot be modified later.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial <<EOF\n{ \n  \"name\" : \"myGraph\", \n  \"edgeDefinitions\" : [ \n    { \n      \"collection\" : \"edges\", \n      \"from\" : [ \n        \"startVertices\" \n      ], \n      \"to\" : [ \n        \"endVertices\" \n      ] \n    } \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQmtu---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_VvTQmtu---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial <<EOF\n{ \n  \"name\" : \"myGraph\", \n  \"edgeDefinitions\" : [ \n    { \n      \"collection\" : \"edges\", \n      \"from\" : [ \n        \"startVertices\" \n      ], \n      \"to\" : [ \n        \"endVertices\" \n      ] \n    } \n  ], \n  \"isSmart\" : true, \n  \"options\" : { \n    \"numberOfShards\" : 9, \n    \"smartGraphAttribute\" : \"region\" \n  } \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQnBG---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 0, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_VvTQnBG---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", @@ -5391,7 +5372,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}": { @@ -5414,7 +5395,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "get": { "description": "\n\nGets a graph from the collection *_graphs*.\nReturns the definition content of this graph.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/myGraph\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: _VvTQose---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"myGraph\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"edges\", \n        \"from\" : [ \n          \"startVertices\" \n        ], \n        \"to\" : [ \n          \"endVertices\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/myGraph\", \n    \"_rev\" : \"_VvTQose---\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -5432,7 +5413,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/edge": { @@ -5452,7 +5433,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "post": { "description": "\n\nAdds an additional edge definition to the graph.\n\nThis edge definition has to contain a *collection* and an array of\neach *from* and *to* vertex collections. An edge definition can only\nbe added if this definition is either not used in any other graph, or\nit is used with exactly the same definition. It is not possible to\nstore a definition \"e\" from \"v1\" to \"v2\" in the one graph, and \"e\"\nfrom \"v2\" to \"v1\" in the other graph.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge <<EOF\n{ \n  \"collection\" : \"works_in\", \n  \"from\" : [ \n    \"female\", \n    \"male\" \n  ], \n  \"to\" : [ \n    \"city\" \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQlm----\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      }, \n      { \n        \"collection\" : \"works_in\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"city\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_VvTQlm----\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", @@ -5486,7 +5467,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}": { @@ -5521,7 +5502,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{collection-name}/{edge-key}": { @@ -5547,7 +5528,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "get": { "description": "\n\nGets an edge from the given collection.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/social/edge/relation/8492\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: _VvTQoa2--B\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_key\" : \"8492\", \n    \"_id\" : \"relation/8492\", \n    \"_from\" : \"male/charly\", \n    \"_to\" : \"female/diana\", \n    \"_rev\" : \"_VvTQoa2--B\", \n    \"type\" : \"married\", \n    \"vertex\" : \"charly\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -5568,7 +5549,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "patch": { "description": "\n\nUpdates the data of the specific edge in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/9065 <<EOF\n{ \n  \"since\" : \"01.01.2001\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQq7a--_\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/9065\", \n    \"_key\" : \"9065\", \n    \"_rev\" : \"_VvTQq7a--_\", \n    \"_oldRev\" : \"_VvTQq7K--C\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", @@ -5601,7 +5582,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "put": { "description": "\n\nReplaces the data of an edge in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/9141 <<EOF\n{ \n  \"type\" : \"divorced\", \n  \"_from\" : \"female/alice\", \n  \"_to\" : \"male/bob\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQrNu--_\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"edge\" : { \n    \"_id\" : \"relation/9141\", \n    \"_key\" : \"9141\", \n    \"_rev\" : \"_VvTQrNu--_\", \n    \"_oldRev\" : \"_VvTQrNi--B\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", @@ -5637,7 +5618,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/edge/{definition-name}": { @@ -5663,7 +5644,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "put": { "description": "\n\nChange one specific edge definition.\nThis will modify all occurrences of this definition in all graphs known to your database.\n\n\n**A JSON object with these properties is required:**\n\n - **to** (string): One or many vertex collections that can contain target vertices.\n - **from** (string): One or many vertex collections that can contain source vertices.\n - **collection**: The name of the edge collection to be used.\n\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF\n{ \n  \"collection\" : \"relation\", \n  \"from\" : [ \n    \"female\", \n    \"male\", \n    \"animal\" \n  ], \n  \"to\" : [ \n    \"female\", \n    \"male\", \n    \"animal\" \n  ] \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQsFC---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"animal\", \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"animal\", \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_VvTQsFC---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", @@ -5697,7 +5678,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex": { @@ -5717,7 +5698,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "post": { "description": "\n\nAdds a vertex collection to the set of collections of the graph. If\nthe collection does not exist, it will be created.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex <<EOF\n{ \n  \"collection\" : \"otherVertices\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQmTm---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"graph\" : { \n    \"name\" : \"social\", \n    \"edgeDefinitions\" : [ \n      { \n        \"collection\" : \"relation\", \n        \"from\" : [ \n          \"female\", \n          \"male\" \n        ], \n        \"to\" : [ \n          \"female\", \n          \"male\" \n        ] \n      } \n    ], \n    \"orphanCollections\" : [ \n      \"otherVertices\" \n    ], \n    \"isSmart\" : false, \n    \"numberOfShards\" : 1, \n    \"replicationFactor\" : 1, \n    \"smartGraphAttribute\" : \"\", \n    \"_id\" : \"_graphs/social\", \n    \"_rev\" : \"_VvTQmTm---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n", @@ -5738,7 +5719,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}": { @@ -5764,7 +5745,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "post": { "description": "\n\nAdds a vertex to the given collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/male <<EOF\n{ \n  \"name\" : \"Francis\" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQmAa---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"male/7993\", \n    \"_key\" : \"7993\", \n    \"_rev\" : \"_VvTQmAa---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", @@ -5797,7 +5778,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/gharial/{graph-name}/vertex/{collection-name}/{vertex-key}": { @@ -5823,7 +5804,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "get": { "description": "\n\nGets a vertex from the given collection.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\netag: _VvTQo8e---\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_key\" : \"alice\", \n    \"_id\" : \"female/alice\", \n    \"_rev\" : \"_VvTQo8e---\", \n    \"name\" : \"Alice\" \n  }, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -5844,7 +5825,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "patch": { "description": "\n\nUpdates the data of the specific vertex in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice <<EOF\n{ \n  \"age\" : 26 \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTQqqK--_\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_VvTQqqK--_\", \n    \"_oldRev\" : \"_VvTQqp2--_\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", @@ -5880,7 +5861,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" }, "put": { "description": "\n\nReplaces the data of a vertex in the collection.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/gharial/social/vertex/female/alice <<EOF\n{ \n  \"name\" : \"Alice Cooper\", \n  \"age\" : 26 \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: application/json; charset=utf-8\netag: _VvTRDbm--_\nx-content-type-options: nosniff\n\n{ \n  \"error\" : false, \n  \"vertex\" : { \n    \"_id\" : \"female/alice\", \n    \"_key\" : \"alice\", \n    \"_rev\" : \"_VvTRDbm--_\", \n    \"_oldRev\" : \"_VvTRDbS---\" \n  }, \n  \"code\" : 202 \n}\n
\n\n\n\n\n", @@ -5916,7 +5897,7 @@ "Graph" ], "x-examples": [], - "x-filename": "Graph - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md" + "x-filename": "Graph - /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_vertex_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_get_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_modify_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_edge_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_collection_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_delete_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_remove_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_definition_add_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_list_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_vertex_replace_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_drop_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_create_http_examples.md, /build/Documentation/DocuBlocks/Rest/Graph/JSF_general_graph_edge_modify_http_examples.md" } }, "/_api/import#document": { @@ -6013,7 +5994,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" + "x-filename": "Bulk - /build/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md" } }, "/_api/import#json": { @@ -6117,7 +6098,7 @@ "Bulk" ], "x-examples": [], - "x-filename": "Bulk - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md" + "x-filename": "Bulk - /build/Documentation/DocuBlocks/Rest/Bulk/JSF_batch_processing.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_json.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_post_api_export.md, /build/Documentation/DocuBlocks/Rest/Bulk/JSF_import_document.md" } }, "/_api/index": { @@ -6142,7 +6123,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index#fulltext": { @@ -6182,7 +6163,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index#general": { @@ -6227,7 +6208,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index#geo": { @@ -6267,7 +6248,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index#hash": { @@ -6310,7 +6291,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index#persistent": { @@ -6353,7 +6334,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index#skiplist": { @@ -6396,7 +6377,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/index/{index-handle}": { @@ -6425,7 +6406,7 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" }, "get": { "description": "\n\n\nThe result is an object describing the index. It has at least the following\nattributes:\n\n- *id*: the identifier of the index\n\n- *type*: the index type\n\nAll other attributes are type-dependent. For example, some indexes provide\n*unique* or *sparse* flags, whereas others don't. Some indexes also provide \na selectivity estimate in the *selectivityEstimate* attribute of the result.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/index/products/0\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"fields\" : [ \n    \"_key\" \n  ], \n  \"id\" : \"products/0\", \n  \"selectivityEstimate\" : 1, \n  \"sparse\" : false, \n  \"type\" : \"primary\", \n  \"unique\" : true, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -6452,12 +6433,12 @@ "Indexes" ], "x-examples": [], - "x-filename": "Indexes - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md" + "x-filename": "Indexes - /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_reads_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_get_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_delete.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_skiplist.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_hash.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_persistent.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_geo.md, /build/Documentation/DocuBlocks/Rest/Indexes/JSF_post_api_index_fulltext.md" } }, "/_api/job/{job-id}": { "get": { - "description": "\n\nReturns the processing status of the specified job. The processing status\ncan be\ndetermined by peeking into the HTTP response code of the response.\n\n\n\n\n#Example:\n Querying the status of a done job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763757\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/150789124763757\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763757\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.3.milestone1\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n#Example:\n Querying the status of a pending job:\n(we create a sleep job therefore...)\n\n
shell> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763762\n\nshell> curl --dump - http://localhost:8529/_api/job/150789124763762\n\nHTTP/1.1 204 No Content\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\n\n
\n\n\n\n\n", + "description": "\n\nReturns the processing status of the specified job. The processing status\ncan be\ndetermined by peeking into the HTTP response code of the response.\n\n\n\n\n#Example:\n Querying the status of a done job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763757\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/150789124763757\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763757\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.3.milestone1\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n#Example:\n Querying the status of a pending job:\n(therefore we create a long runnging job...)\n\n
shell> curl --header 'x-arango-async: store' --dump - http://localhost:8529/_admin/sleep?duration=30\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763762\n\nshell> curl --dump - http://localhost:8529/_api/job/150789124763762\n\nHTTP/1.1 204 No Content\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\n\n
\n\n\n\n\n", "parameters": [ { "description": "The async job id.\n\n", @@ -6484,7 +6465,7 @@ "job" ], "x-examples": [], - "x-filename": "job - /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md" + "x-filename": "job - /build/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" }, "put": { "description": "\n\nReturns the result of an async job identified by job-id. If the async job\nresult is present on the server, the result will be removed from the list of\nresult. That means this method can be called for each job-id once.\nThe method will return the original job result's headers and body, plus the\nadditional HTTP header x-arango-async-job-id. If this header is present,\nthen\nthe job was found and the response contains the original job's result. If\nthe header is not present, the job was not found and the response contains\nstatus information from the job manager.\n\n\n\n\n#Example:\n Not providing a job-id:\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/job\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"bad parameter\", \n  \"code\" : 400, \n  \"errorNum\" : 400 \n}\n
\n\n\n\n\n#Example:\n Providing a job-id for a non-existing job:\n\n
shell> curl -X PUT --dump - http://localhost:8529/_api/job/notthere\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"errorMessage\" : \"not found\", \n  \"code\" : 404, \n  \"errorNum\" : 404 \n}\n
\n\n\n\n\n#Example:\n Fetching the result of an HTTP GET job:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763730\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/150789124763730\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763730\n\n{ \n  \"server\" : \"arango\", \n  \"version\" : \"3.3.milestone1\", \n  \"license\" : \"community\" \n}\n
\n\n\n\n\n#Example:\n Fetching the result of an HTTP POST job that failed:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --data-binary @- --dump - http://localhost:8529/_api/collection <<EOF\n{ \n  \"name\" : \" this name is invalid \" \n}\nEOF\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763735\n\nshell> curl -X PUT --dump - http://localhost:8529/_api/job/150789124763735\n\nHTTP/1.1 400 Bad Request\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763735\n\n{ \n  \"error\" : true, \n  \"code\" : 400, \n  \"errorNum\" : 400, \n  \"errorMessage\" : \"expected PUT /_api/collection/<collection-name>/<action>\" \n}\n
\n\n\n\n\n", @@ -6514,7 +6495,7 @@ "job" ], "x-examples": [], - "x-filename": "job - /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md" + "x-filename": "job - /build/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" } }, "/_api/job/{job-id}/cancel": { @@ -6546,7 +6527,7 @@ "job" ], "x-examples": [], - "x-filename": "job - /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md" + "x-filename": "job - /build/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" } }, "/_api/job/{type}": { @@ -6578,7 +6559,7 @@ "job" ], "x-examples": [], - "x-filename": "job - /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md" + "x-filename": "job - /build/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" }, "get": { "description": "\n\nReturns the list of ids of async jobs with a specific status (either done or\npending).\nThe list can be used by the client to get an overview of the job system\nstatus and\nto retrieve completed job results later.\n\n\n\n\n#Example:\n Fetching the list of done jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763740\n\nshell> curl --dump - http://localhost:8529/_api/job/done\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"150789124763740\" \n]\n
\n\n\n\n\n#Example:\n Fetching the list of pending jobs:\n\n
shell> curl -X PUT --header 'x-arango-async: store' --dump - http://localhost:8529/_api/version\n\nHTTP/1.1 202 Accepted\ncontent-type: text/plain; charset=utf-8\nx-content-type-options: nosniff\nx-arango-async-id: 150789124763745\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ ]\n
\n\n\n\n\n#Example:\n Querying the status of a pending job:\n(we create a sleep job therefore...)\n\n
shell> curl --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-content-type-options: nosniff\nx-arango-async-id: 150789124763750\n\nshell> curl --dump - http://localhost:8529/_api/job/pending\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n[ \n  \"150789124763750\" \n]\nshell> curl -X DELETE --dump - http://localhost:8529/_api/job/150789124763750\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"result\" : true \n}\n
\n\n\n\n\n", @@ -6605,7 +6586,7 @@ "job" ], "x-examples": [], - "x-filename": "job - /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md" + "x-filename": "job - /build/Documentation/DocuBlocks/Rest/job/JSF_job_delete.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_cancel.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getByType.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_getStatusById.md, /build/Documentation/DocuBlocks/Rest/job/JSF_job_fetch_result.md" } }, "/_api/query": { @@ -6635,7 +6616,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/query-cache": { @@ -6655,7 +6636,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/query-cache/properties": { @@ -6675,7 +6656,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "put": { "description": "\n\nAfter the properties have been changed, the current set of properties will\nbe returned in the HTTP response.\n\nNote: changing the properties may invalidate all results in the cache.\nThe global properties for AQL query cache.\nThe properties need to be passed in the attribute *properties* in the body\nof the HTTP request. *properties* needs to be a JSON object with the following\nproperties:\n\n\n**A JSON object with these properties is required:**\n\n - **mode**: the mode the AQL query cache should operate in. Possible values are *off*, *on* or *demand*.\n - **maxResults**: the maximum number of query results that will be stored per database-specific cache.\n\n\n", @@ -6703,7 +6684,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/query/current": { @@ -6723,7 +6704,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/query/properties": { @@ -6743,7 +6724,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **maxSlowQueries**: The maximum number of slow queries to keep in the list\n of slow queries. If the list of slow queries is full, the oldest entry in\n it will be discarded when additional slow queries occur.\n - **slowQueryThreshold**: The threshold value for treating a query as slow. A\n query with a runtime greater or equal to this threshold value will be\n put into the list of slow queries when slow query tracking is enabled.\n The value for *slowQueryThreshold* is specified in seconds.\n - **enabled**: If set to *true*, then queries will be tracked. If set to\n *false*, neither queries nor slow queries will be tracked.\n - **maxQueryStringLength**: The maximum query string length to keep in the list of queries.\n Query strings can have arbitrary lengths, and this property\n can be used to save memory in case very long query strings are used. The\n value is specified in bytes.\n - **trackSlowQueries**: If set to *true*, then slow queries will be tracked\n in the list of slow queries if their runtime exceeds the value set in\n *slowQueryThreshold*. In order for slow queries to be tracked, the *enabled*\n property must also be set to *true*.\n - **trackBindVars**: If set to *true*, then the bind variables used in queries will be tracked \n along with queries.\n\n\n\n\nThe properties need to be passed in the attribute *properties* in the body\nof the HTTP request. *properties* needs to be a JSON object.\n\nAfter the properties have been changed, the current set of properties will\nbe returned in the HTTP response.\n\n", @@ -6771,7 +6752,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/query/slow": { @@ -6791,7 +6772,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" }, "get": { "description": "\n\nReturns an array containing the last AQL queries that are finished and\nhave exceeded the slow query threshold in the selected database.\nThe maximum amount of queries in the list can be controlled by setting\nthe query tracking property `maxSlowQueries`. The threshold for treating\na query as *slow* can be adjusted by setting the query tracking property\n`slowQueryThreshold`.\n\nEach query is a JSON object with the following attributes:\n\n- *id*: the query's id\n\n- *query*: the query string (potentially truncated)\n\n- *bindVars*: the bind parameter values used by the query\n\n- *started*: the date and time when the query was started\n\n- *runTime*: the query's total run time \n\n- *state*: the query's current execution state (will always be \"finished\"\n for the list of slow queries)\n\n", @@ -6809,7 +6790,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/query/{query-id}": { @@ -6841,7 +6822,7 @@ "AQL" ], "x-examples": [], - "x-filename": "AQL - /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md" + "x-filename": "AQL - /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_delete_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryCurrent.md, /build/Documentation/DocuBlocks/Rest/AQL/PostApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryKill.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_explain.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_get_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQueryCache.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/JSF_post_api_aqlfunction.md, /build/Documentation/DocuBlocks/Rest/AQL/PutApiQueryCacheProperties.md, /build/Documentation/DocuBlocks/Rest/AQL/DeleteApiQuerySlow.md, /build/Documentation/DocuBlocks/Rest/AQL/GetApiQueryProperties.md" } }, "/_api/replication/applier-config": { @@ -6864,7 +6845,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **username**: an optional ArangoDB username to use when connecting to the endpoint.\n - **includeSystem**: whether or not system collection operations will be applied\n - **endpoint**: the logger server to connect to (e.g. \"tcp://192.168.173.13:8529\"). The endpoint must be specified.\n - **verbose**: if set to *true*, then a log line will be emitted for all operations \n performed by the replication applier. This should be used for debugging replication\n problems only.\n - **connectTimeout**: the timeout (in seconds) when attempting to connect to the\n endpoint. This value is used for each connection attempt.\n - **autoResync**: whether or not the slave should perform a full automatic resynchronization\n with the master in case the master cannot serve log data requested by the\n slave,\n or when the replication is started and no tick value can be found.\n - **database**: the name of the database on the endpoint. If not specified, defaults to the current local database name.\n - **idleMinWaitTime**: the minimum wait time (in seconds) that the applier will intentionally idle\n before fetching more log data from the master in case the master has\n already sent all its log data. This wait time can be used to control the\n frequency with which the replication applier sends HTTP log fetch requests\n to the master in case there is no write activity on the master.\n This value will be ignored if set to *0*.\n - **requestTimeout**: the timeout (in seconds) for individual requests to the endpoint.\n - **requireFromPresent**: if set to *true*, then the replication applier will check\n at start whether the start tick from which it starts or resumes replication is\n still present on the master. If not, then there would be data loss. If \n *requireFromPresent* is *true*, the replication applier will abort with an\n appropriate error message. If set to *false*, then the replication applier will\n still start, and ignore the data loss.\n - **idleMaxWaitTime**: the maximum wait time (in seconds) that the applier will intentionally idle \n before fetching more log data from the master in case the master has \n already sent all its log data and there have been previous log fetch attempts\n that resulted in no more log data. This wait time can be used to control the\n maximum frequency with which the replication applier sends HTTP log fetch\n requests to the master in case there is no write activity on the master for\n longer periods. This configuration value will only be used if the option\n *adaptivePolling* is set to *true*.\n This value will be ignored if set to *0*.\n - **restrictCollections** (string): the array of collections to include or exclude,\n based on the setting of *restrictType*\n - **restrictType**: the configuration for *restrictCollections*; Has to be either *include* or *exclude*\n - **initialSyncMaxWaitTime**: the maximum wait time (in seconds) that the initial synchronization will\n wait for a response from the master when fetching initial collection data.\n This wait time can be used to control after what time the initial\n synchronization\n will give up waiting for a response and fail. This value is relevant even\n for continuous replication when *autoResync* is set to *true* because this\n may re-start the initial synchronization when the master cannot provide\n log data the slave requires.\n This value will be ignored if set to *0*.\n - **maxConnectRetries**: the maximum number of connection attempts the applier\n will make in a row. If the applier cannot establish a connection to the\n endpoint in this number of attempts, it will stop itself.\n - **autoStart**: whether or not to auto-start the replication applier on\n (next and following) server starts\n - **adaptivePolling**: if set to *true*, the replication applier will fall\n to sleep for an increasingly long period in case the logger server at the\n endpoint does not have any more replication events to apply. Using\n adaptive polling is thus useful to reduce the amount of work for both the\n applier and the logger server for cases when there are only infrequent\n changes. The downside is that when using adaptive polling, it might take\n longer for the replication applier to detect that there are new replication\n events on the logger server.\n Setting *adaptivePolling* to false will make the replication applier\n contact the logger server in a constant interval, regardless of whether\n the logger server provides updates frequently or seldom.\n - **password**: the password to use when connecting to the endpoint.\n - **connectionRetryWaitTime**: the time (in seconds) that the applier will intentionally idle before\n it retries connecting to the master in case of connection problems.\n This value will be ignored if set to *0*.\n - **autoResyncRetries**: number of resynchronization retries that will be performed in a row when\n automatic resynchronization is enabled and kicks in. Setting this to *0*\n will\n effectively disable *autoResync*. Setting it to some other value will limit\n the number of retries that are performed. This helps preventing endless\n retries\n in case resynchronizations always fail.\n - **chunkSize**: the requested maximum size for log transfer packets that\n is used when the endpoint is contacted.\n\n\n\n\nSets the configuration of the replication applier. The configuration can\nonly be changed while the applier is not running. The updated configuration\nwill be saved immediately but only become active with the next start of the\napplier.\n\nIn case of success, the body of the response is a JSON object with the updated\nconfiguration.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/replication/applier-config <<EOF\n{ \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"username\" : \"replicationApplier\", \n  \"password\" : \"applier1234@foxx\", \n  \"chunkSize\" : 4194304, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"endpoint\" : \"tcp://127.0.0.1:8529\", \n  \"database\" : \"_system\", \n  \"username\" : \"replicationApplier\", \n  \"requestTimeout\" : 600, \n  \"connectTimeout\" : 10, \n  \"ignoreErrors\" : 0, \n  \"maxConnectRetries\" : 100, \n  \"lockTimeoutRetries\" : 0, \n  \"sslProtocol\" : 0, \n  \"chunkSize\" : 4194304, \n  \"autoStart\" : false, \n  \"adaptivePolling\" : true, \n  \"autoResync\" : false, \n  \"autoResyncRetries\" : 2, \n  \"includeSystem\" : true, \n  \"requireFromPresent\" : false, \n  \"verbose\" : false, \n  \"incremental\" : false, \n  \"useCollectionId\" : true, \n  \"restrictType\" : \"\", \n  \"restrictCollections\" : [ ], \n  \"connectionRetryWaitTime\" : 15, \n  \"initialSyncMaxWaitTime\" : 300, \n  \"idleMinWaitTime\" : 1, \n  \"idleMaxWaitTime\" : 2.5 \n}\n
\n\n\n\n\n", @@ -6898,7 +6879,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/applier-start": { @@ -6932,7 +6913,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/applier-state": { @@ -6955,7 +6936,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/applier-stop": { @@ -6978,7 +6959,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/batch": { @@ -7011,7 +6992,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/batch/{id}": { @@ -7043,7 +7024,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **ttl**: the time-to-live for the new batch (in seconds)\n\n\n\n\nExtends the ttl of an existing dump batch, using the batch's id and\nthe provided ttl value.\n\nIf the batch's ttl can be extended successfully, the response is empty.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n", @@ -7082,7 +7063,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/clusterInventory": { @@ -7113,7 +7094,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/dump": { @@ -7202,12 +7183,12 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/inventory": { "get": { - "description": "\n\nReturns the array of collections and indexes available on the server. This\narray can be used by replication clients to initiate an initial sync with the\nserver.\n\nThe response will contain a JSON object with the *collection* and *state* and\n*tick* attributes.\n\n*collections* is a array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: a array of the indexes of a the collection. Primary indexes and edges indexes\n are not included in this array.\n\nThe *state* attribute contains the current state of the replication logger. It\ncontains the following sub-attributes:\n\n- *running*: whether or not the replication logger is currently active. Note:\n since ArangoDB 2.2, the value will always be *true*\n\n- *lastLogTick*: the value of the last tick the replication logger has written\n\n- *time*: the current time on the server\n\nReplication clients should note the *lastLogTick* value returned. They can then\nfetch collections' data using the dump method up to the value of lastLogTick, and\nquery the continuous replication log for log events after this tick value.\n\nTo create a full copy of the collections on the server, a replication client\ncan execute these steps:\n\n- call the */inventory* API method. This returns the *lastLogTick* value and the\n array of collections and indexes from the server.\n\n- for each collection returned by */inventory*, create the collection locally and\n call */dump* to stream the collection data to the client, up to the value of\n *lastLogTick*.\n After that, the client can create the indexes on the collections as they were\n reported by */inventory*.\n\nIf the clients wants to continuously stream replication log events from the logger\nserver, the following additional steps need to be carried out:\n\n- the client should call */logger-follow* initially to fetch the first batch of\n replication events that were logged after the client's call to */inventory*.\n\n The call to */logger-follow* should use a *from* parameter with the value of the\n *lastLogTick* as reported by */inventory*. The call to */logger-follow* will return the\n *x-arango-replication-lastincluded* which will contain the last tick value included\n in the response.\n\n- the client can then continuously call */logger-follow* to incrementally fetch new\n replication events that occurred after the last transfer.\n\n Calls should use a *from* parameter with the value of the *x-arango-replication-lastincluded*\n header of the previous response. If there are no more replication events, the\n response will be empty and clients can go to sleep for a while and try again\n later.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"76\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"76\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_appbundles\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"76\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"28\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"28\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_aqlfunctions\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"28\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"45\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"45\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_frontend\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"45\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"4\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"4\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_graphs\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"4\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"12\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"12\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_modules\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"12\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"14\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"14\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_routing\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"14\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"7\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"7\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"user\" \n            ], \n            \"id\" : \"10\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : true, \n            \"type\" : \"hash\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_users\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"7\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"user\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"10\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"98\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"98\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"animals\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"98\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"93\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"93\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"demo\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"93\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11700\", \n    \"lastUncommittedLogTick\" : \"11711\", \n    \"totalEvents\" : 4132, \n    \"time\" : \"2017-10-13T10:42:14Z\" \n  }, \n  \"tick\" : \"11711\" \n}\n
\n\n\n\n\n#Example:\n With some additional indexes:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"76\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"76\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_appbundles\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"76\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"28\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"28\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_aqlfunctions\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"28\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"45\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"45\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_frontend\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"45\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"4\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"4\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_graphs\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"4\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"12\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"12\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_modules\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"12\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"14\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"14\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_routing\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"14\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"7\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"7\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"user\" \n            ], \n            \"id\" : \"10\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : true, \n            \"type\" : \"hash\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_users\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"7\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"user\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"10\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"98\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"98\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"animals\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"98\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"93\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"93\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"demo\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"93\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"11712\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"11712\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"name\" \n            ], \n            \"id\" : \"11715\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"hash\", \n            \"unique\" : false \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"a\", \n              \"b\" \n            ], \n            \"id\" : \"11718\", \n            \"sparse\" : false, \n            \"type\" : \"skiplist\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"IndexedCollection1\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"11712\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"name\" \n          ], \n          \"id\" : \"11715\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : false, \n          \"type\" : \"hash\", \n          \"unique\" : false \n        }, \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"a\", \n            \"b\" \n          ], \n          \"id\" : \"11718\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"11720\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"11720\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"fields\" : [ \n              \"text\" \n            ], \n            \"id\" : \"11723\", \n            \"minLength\" : 10, \n            \"sparse\" : true, \n            \"type\" : \"fulltext\", \n            \"unique\" : false \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"a\" \n            ], \n            \"id\" : \"11726\", \n            \"sparse\" : false, \n            \"type\" : \"skiplist\", \n            \"unique\" : false \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"IndexedCollection2\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"11720\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"text\" \n          ], \n          \"id\" : \"11723\", \n          \"minLength\" : 10, \n          \"sparse\" : true, \n          \"type\" : \"fulltext\", \n          \"unique\" : false \n        }, \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"a\" \n          ], \n          \"id\" : \"11726\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : false \n        } \n      ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11721\", \n    \"lastUncommittedLogTick\" : \"11727\", \n    \"totalEvents\" : 4138, \n    \"time\" : \"2017-10-13T10:42:15Z\" \n  }, \n  \"tick\" : \"11727\" \n}\n
\n\n\n\n\n", + "description": "\n\nReturns the array of collections and indexes available on the server. This\narray can be used by replication clients to initiate an initial sync with the\nserver.\n\nThe response will contain a JSON object with the *collection* and *state* and\n*tick* attributes.\n\n*collections* is an array of collections with the following sub-attributes:\n\n- *parameters*: the collection properties\n\n- *indexes*: an array of the indexes of a the collection. Primary indexes and edge indexes\n are not included in this array.\n\nThe *state* attribute contains the current state of the replication logger. It\ncontains the following sub-attributes:\n\n- *running*: whether or not the replication logger is currently active. Note:\n since ArangoDB 2.2, the value will always be *true*\n\n- *lastLogTick*: the value of the last tick the replication logger has written\n\n- *time*: the current time on the server\n\nReplication clients should note the *lastLogTick* value returned. They can then\nfetch collections' data using the dump method up to the value of lastLogTick, and\nquery the continuous replication log for log events after this tick value.\n\nTo create a full copy of the collections on the server, a replication client\ncan execute these steps:\n\n- call the */inventory* API method. This returns the *lastLogTick* value and the\n array of collections and indexes from the server.\n\n- for each collection returned by */inventory*, create the collection locally and\n call */dump* to stream the collection data to the client, up to the value of\n *lastLogTick*.\n After that, the client can create the indexes on the collections as they were\n reported by */inventory*.\n\nIf the clients wants to continuously stream replication log events from the logger\nserver, the following additional steps need to be carried out:\n\n- the client should call */logger-follow* initially to fetch the first batch of\n replication events that were logged after the client's call to */inventory*.\n\n The call to */logger-follow* should use a *from* parameter with the value of the\n *lastLogTick* as reported by */inventory*. The call to */logger-follow* will return the\n *x-arango-replication-lastincluded* which will contain the last tick value included\n in the response.\n\n- the client can then continuously call */logger-follow* to incrementally fetch new\n replication events that occurred after the last transfer.\n\n Calls should use a *from* parameter with the value of the *x-arango-replication-lastincluded*\n header of the previous response. If there are no more replication events, the\n response will be empty and clients can go to sleep for a while and try again\n later.\n\n**Note**: on a coordinator, this request must have the query parameter\n*DBserver* which must be an ID of a DBserver.\nThe very same request is forwarded synchronously to that DBserver.\nIt is an error if this attribute is not bound in the coordinator case.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"76\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"76\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_appbundles\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"76\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"28\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"28\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_aqlfunctions\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"28\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"45\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"45\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_frontend\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"45\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"4\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"4\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_graphs\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"4\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"12\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"12\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_modules\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"12\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"14\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"14\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_routing\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"14\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"7\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"7\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"user\" \n            ], \n            \"id\" : \"10\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : true, \n            \"type\" : \"hash\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_users\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"7\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"user\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"10\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"98\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"98\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"animals\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"98\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"93\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"93\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"demo\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"93\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11700\", \n    \"lastUncommittedLogTick\" : \"11711\", \n    \"totalEvents\" : 4132, \n    \"time\" : \"2017-10-13T10:42:14Z\" \n  }, \n  \"tick\" : \"11711\" \n}\n
\n\n\n\n\n#Example:\n With some additional indexes:\n\n
shell> curl --dump - http://localhost:8529/_api/replication/inventory\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"collections\" : [ \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"76\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"76\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_appbundles\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"76\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"28\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"28\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_aqlfunctions\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"28\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"45\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"45\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_frontend\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"45\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"4\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"4\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_graphs\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"4\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"12\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"12\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 1048576, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_modules\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"12\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"14\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"14\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_routing\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"14\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"7\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"7\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"user\" \n            ], \n            \"id\" : \"10\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : true, \n            \"type\" : \"hash\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : true, \n        \"isVolatile\" : false, \n        \"journalSize\" : 4194304, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"_users\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"7\", \n        \"replicationFactor\" : 2, \n        \"shardKeys\" : [ \n          \"user\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"user\" \n          ], \n          \"id\" : \"10\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : true, \n          \"type\" : \"hash\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"98\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"98\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"animals\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"98\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"93\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"93\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"demo\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"93\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"11712\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"11712\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"name\" \n            ], \n            \"id\" : \"11715\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"hash\", \n            \"unique\" : false \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"a\", \n              \"b\" \n            ], \n            \"id\" : \"11718\", \n            \"sparse\" : false, \n            \"type\" : \"skiplist\", \n            \"unique\" : true \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"IndexedCollection1\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"11712\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"name\" \n          ], \n          \"id\" : \"11715\", \n          \"selectivityEstimate\" : 1, \n          \"sparse\" : false, \n          \"type\" : \"hash\", \n          \"unique\" : false \n        }, \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"a\", \n            \"b\" \n          ], \n          \"id\" : \"11718\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : true \n        } \n      ] \n    }, \n    { \n      \"parameters\" : { \n        \"allowUserKeys\" : true, \n        \"cid\" : \"11720\", \n        \"count\" : 0, \n        \"deleted\" : false, \n        \"doCompact\" : true, \n        \"id\" : \"11720\", \n        \"indexBuckets\" : 8, \n        \"indexes\" : [ \n          { \n            \"fields\" : [ \n              \"_key\" \n            ], \n            \"id\" : \"0\", \n            \"selectivityEstimate\" : 1, \n            \"sparse\" : false, \n            \"type\" : \"primary\", \n            \"unique\" : true \n          }, \n          { \n            \"fields\" : [ \n              \"text\" \n            ], \n            \"id\" : \"11723\", \n            \"minLength\" : 10, \n            \"sparse\" : true, \n            \"type\" : \"fulltext\", \n            \"unique\" : false \n          }, \n          { \n            \"deduplicate\" : true, \n            \"fields\" : [ \n              \"a\" \n            ], \n            \"id\" : \"11726\", \n            \"sparse\" : false, \n            \"type\" : \"skiplist\", \n            \"unique\" : false \n          } \n        ], \n        \"isSmart\" : false, \n        \"isSystem\" : false, \n        \"isVolatile\" : false, \n        \"journalSize\" : 33554432, \n        \"keyOptions\" : { \n          \"allowUserKeys\" : true, \n          \"lastValue\" : 0, \n          \"type\" : \"traditional\" \n        }, \n        \"name\" : \"IndexedCollection2\", \n        \"numberOfShards\" : 1, \n        \"planId\" : \"11720\", \n        \"replicationFactor\" : 1, \n        \"shardKeys\" : [ \n          \"_key\" \n        ], \n        \"shards\" : { \n        }, \n        \"status\" : 3, \n        \"type\" : 2, \n        \"version\" : 6, \n        \"waitForSync\" : false \n      }, \n      \"indexes\" : [ \n        { \n          \"fields\" : [ \n            \"text\" \n          ], \n          \"id\" : \"11723\", \n          \"minLength\" : 10, \n          \"sparse\" : true, \n          \"type\" : \"fulltext\", \n          \"unique\" : false \n        }, \n        { \n          \"deduplicate\" : true, \n          \"fields\" : [ \n            \"a\" \n          ], \n          \"id\" : \"11726\", \n          \"sparse\" : false, \n          \"type\" : \"skiplist\", \n          \"unique\" : false \n        } \n      ] \n    } \n  ], \n  \"state\" : { \n    \"running\" : true, \n    \"lastLogTick\" : \"11721\", \n    \"lastUncommittedLogTick\" : \"11727\", \n    \"totalEvents\" : 4138, \n    \"time\" : \"2017-10-13T10:42:15Z\" \n  }, \n  \"tick\" : \"11727\" \n}\n
\n\n\n\n\n", "parameters": [ { "description": "Include system collections in the result. The default value is *true*.\n\n", @@ -7233,7 +7214,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/logger-first-tick": { @@ -7259,7 +7240,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/logger-follow": { @@ -7320,7 +7301,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/logger-state": { @@ -7343,7 +7324,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/logger-tick-ranges": { @@ -7369,7 +7350,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/make-slave": { @@ -7408,7 +7389,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/server-id": { @@ -7431,7 +7412,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/replication/sync": { @@ -7470,7 +7451,7 @@ "Replication" ], "x-examples": [], - "x-filename": "Replication - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md" + "x-filename": "Replication - /build/Documentation/DocuBlocks/Rest/Replication/JSF_post_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_synchronize.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_applier_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_adjust.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_returns.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_makeSlave.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_dump.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_delete_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_return_state.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_serverID.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_first_tick.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_start.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_logger_tick_ranges.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_get_api_replication_cluster_inventory.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_batch_replication.md, /build/Documentation/DocuBlocks/Rest/Replication/JSF_put_api_replication_applier_stop.md" } }, "/_api/simple/all": { @@ -7505,7 +7486,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/all-keys": { @@ -7535,7 +7516,7 @@ "Documents" ], "x-examples": [], - "x-filename": "Documents - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md" + "x-filename": "Documents - /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_CREATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE_MULTI.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_REPLACE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_DELETE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_UPDATE.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_HEAD.md, /build/Documentation/DocuBlocks/Rest/Documents/REST_DOCUMENT_READ_ALL.md" } }, "/_api/simple/any": { @@ -7568,7 +7549,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/by-example": { @@ -7601,7 +7582,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/first-example": { @@ -7634,7 +7615,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/fulltext": { @@ -7667,7 +7648,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/lookup-by-keys": { @@ -7700,7 +7681,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/near": { @@ -7733,7 +7714,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/range": { @@ -7766,7 +7747,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/remove-by-example": { @@ -7799,7 +7780,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/remove-by-keys": { @@ -7832,7 +7813,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/replace-by-example": { @@ -7865,7 +7846,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/update-by-example": { @@ -7898,7 +7879,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/within": { @@ -7931,7 +7912,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/simple/within-rectangle": { @@ -7964,7 +7945,7 @@ "Simple Queries" ], "x-examples": [], - "x-filename": "Simple Queries - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md" + "x-filename": "Simple Queries - /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_fulltext.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_range.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestLookupByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_any.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_remove_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_first_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within_rectangle.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/RestRemoveByKeys.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_update_by_example.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_within.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_near.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_all.md, /build/Documentation/DocuBlocks/Rest/Simple Queries/JSA_put_api_simple_replace_by_example.md" } }, "/_api/tasks": { @@ -7991,7 +7972,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_api/tasks/": { @@ -8008,7 +7989,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_api/tasks/{id}": { @@ -8034,7 +8015,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "get": { "description": "\n\nfetches one existing tasks on the server specified by *id*\n\n\n\n\n#Example:\n Fetching a single task by its id\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/statistics-average-collector\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"statistics-average-collector\", \n  \"name\" : \"statistics-average-collector\", \n  \"created\" : 1507891260.4653926, \n  \"type\" : \"periodic\", \n  \"period\" : 900, \n  \"offset\" : 20, \n  \"command\" : \"(function (params) { require('@arangodb/statistics').historianAverage(); } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n#Example:\n trying to fetch a non-existing task\n\n
shell> curl --dump - http://localhost:8529/_api/tasks/non-existing-task\n\nHTTP/1.1 404 Not Found\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"error\" : true, \n  \"code\" : 404, \n  \"errorNum\" : 1852, \n  \"errorMessage\" : \"task not found\" \n}\n
\n\n\n\n\n", @@ -8058,7 +8039,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **params**: The parameters to be passed into command\n - **offset**: Number of seconds initial delay \n - **command**: The JavaScript code to be executed\n - **name**: The name of the task\n - **period**: number of seconds between the executions\n\n\n\n\nregisters a new task with the specified id\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/tasks/sampleTask <<EOF\n{ \n  \"id\" : \"SampleTask\", \n  \"name\" : \"SampleTask\", \n  \"command\" : \"(function(params) { require('@arangodb').print(params); })(params)\", \n  \"params\" : { \n    \"foo\" : \"bar\", \n    \"bar\" : \"foo\" \n  }, \n  \"period\" : 2 \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"id\" : \"sampleTask\", \n  \"name\" : \"SampleTask\", \n  \"created\" : 1507891341.488794, \n  \"type\" : \"periodic\", \n  \"period\" : 2, \n  \"offset\" : 0, \n  \"command\" : \"(function (params) { (function(params) { require('@arangodb').print(params); })(params) } )(params);\", \n  \"database\" : \"_system\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n", @@ -8091,7 +8072,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } }, "/_api/transaction": { @@ -8127,7 +8108,7 @@ "Transactions" ], "x-examples": [], - "x-filename": "Transactions - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" + "x-filename": "Transactions - /build/Documentation/DocuBlocks/Rest/Transactions/JSF_post_api_transaction.md" } }, "/_api/traversal": { @@ -8163,7 +8144,7 @@ "Graph Traversal" ], "x-examples": [], - "x-filename": "Graph Traversal - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" + "x-filename": "Graph Traversal - /build/Documentation/DocuBlocks/Rest/Graph Traversal/JSF_HTTP_API_TRAVERSAL.md" } }, "/_api/user": { @@ -8202,7 +8183,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/": { @@ -8225,7 +8206,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}": { @@ -8260,7 +8241,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "get": { "description": "\n\n\nFetches data about the specified user. You can fetch information about\nyourself or you need the *Administrate* server access level in order to\nexecute this REST call.\n\n\n\n\n#Example:\n \n\n
shell> curl --dump - http://localhost:8529/_api/user/admin@myapp\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -8293,7 +8274,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "patch": { "description": "\n**A JSON object with these properties is required:**\n\n - **passwd**: The user password as a string. Specifying a password is mandatory, but\n the empty string is allowed for passwords\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\n\nPartially updates the data of an existing user. The name of an existing user\nmust be specified in *user*. You need server access level *Administrate* in\norder to execute this REST call. Additionally, a user can change his/her own\ndata.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PATCH --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp <<EOF\n{ \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n\n\n", @@ -8338,7 +8319,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **passwd**: The user password as a string. Specifying a password is mandatory, but\n the empty string is allowed for passwords\n - **active**: An optional flag that specifies whether the user is active. If not\n specified, this will default to true\n - **extra**: An optional JSON object with arbitrary extra data about the user.\n\n\n\n\n\nReplaces the data of an existing user. The name of an existing user must be\nspecified in *user*. You need server access level *Administrate* in order to\nexecute this REST call. Additionally, a user can change his/her own data.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp <<EOF\n{ \n  \"passwd\" : \"secure\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"user\" : \"admin@myapp\", \n  \"active\" : true, \n  \"extra\" : { \n  }, \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -8383,7 +8364,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/": { @@ -8425,7 +8406,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{database}": { @@ -8468,7 +8449,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{database}/{collection}": { @@ -8519,7 +8500,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{dbname}": { @@ -8556,7 +8537,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **grant**: Use \"rw\" to set the database access level to *Administrate* .\n Use \"ro\" to set the database access level to *Access*.\n Use \"none\" to set the database access level to *No access*.\n\n\n\n\n\nSets the database access levels for the database *dbname* of user *user*. You\nneed the *Administrate* server access level in order to execute this REST\ncall.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp/database/_system <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"_system\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -8606,7 +8587,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/user/{user}/database/{dbname}/{collection}": { @@ -8651,7 +8632,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" }, "put": { "description": "\n**A JSON object with these properties is required:**\n\n - **grant**: Use \"rw\" to set the collection level access to *Read/Write*.\n Use \"ro\" to set the collection level access to *Read Only*.\n Use \"none\" to set the collection level access to *No access*.\n\n\n\n\n\nSets the collection access level for the *collection* in the database *dbname*\nfor user *user*. You need the *Administrate* server access level in order to\nexecute this REST call.\n\n\n\n\n#Example:\n \n\n
shell> curl -X PUT --data-binary @- --dump - http://localhost:8529/_api/user/admin@myapp/database/_system/reports <<EOF\n{ \n  \"grant\" : \"rw\" \n}\nEOF\n\nHTTP/1.1 200 OK\ncontent-type: application/json; charset=utf-8\nx-content-type-options: nosniff\n\n{ \n  \"_system/reports\" : \"rw\", \n  \"error\" : false, \n  \"code\" : 200 \n}\n
\n\n\n\n\n\n\n\n", @@ -8709,7 +8690,7 @@ "User Management" ], "x-examples": [], - "x-filename": "User Management - /home/willi/src/devel/Documentation/DocuBlocks/Rest/User Management/README.md" + "x-filename": "User Management - /build/Documentation/DocuBlocks/Rest/User Management/README.md" } }, "/_api/version": { @@ -8741,7 +8722,7 @@ "Administration" ], "x-examples": [], - "x-filename": "Administration - /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_sleep.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /home/willi/src/devel/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md" + "x-filename": "Administration - /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_database_version.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_id.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks_all.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_endpoint.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics_description.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_cluster_endpoints.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_execute.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_return.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_time.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_delete_api_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_modules_flush.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_statistics.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_routing_reloads.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_engine.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_server_role.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_api_initiate.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_get_admin_long_echo.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_put_api_new_tasks.md, /build/Documentation/DocuBlocks/Rest/Administration/JSF_post_admin_test.md" } } },