1
0
Fork 0

Improve collection API docs

- add keyOptions attribute description which is also part of the result
- add empty line before return codes header
This commit is contained in:
Tomas Bosak 2014-12-03 17:20:34 +01:00
parent 34c31a0980
commit 8d4de5b22f
1 changed files with 10 additions and 0 deletions

View File

@ -478,6 +478,15 @@ function get_api_collections (req, res) {
/// - *journalSize*: The maximal size setting for journals / datafiles
/// in bytes.
///
/// - *keyOptions*: JSON object which contains key generation options:
/// - *type*: specifies the type of the key generator. The currently
/// available generators are *traditional* and *autoincrement*.
/// - *allowUserKeys*: if set to *true*, then it is allowed to supply
/// own key values in the *_key* attribute of a document. If set to
/// *false*, then the key generator is solely responsible for
/// generating keys and supplying own key values in the *_key* attribute
/// of documents is considered an error.
///
/// - *isVolatile*: If *true* then the collection data will be
/// kept in memory only and ArangoDB will not write or sync the data
/// to disk.
@ -487,6 +496,7 @@ function get_api_collections (req, res) {
///
/// - *shardKeys*: contains the names of document attributes that are used to
/// determine the target shard for documents.
///
/// @RESTRETURNCODES
///
/// @RESTRETURNCODE{400}