mirror of https://gitee.com/bigwinds/arangodb
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:
parent
34c31a0980
commit
8d4de5b22f
|
@ -478,6 +478,15 @@ function get_api_collections (req, res) {
|
||||||
/// - *journalSize*: The maximal size setting for journals / datafiles
|
/// - *journalSize*: The maximal size setting for journals / datafiles
|
||||||
/// in bytes.
|
/// 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
|
/// - *isVolatile*: If *true* then the collection data will be
|
||||||
/// kept in memory only and ArangoDB will not write or sync the data
|
/// kept in memory only and ArangoDB will not write or sync the data
|
||||||
/// to disk.
|
/// to disk.
|
||||||
|
@ -487,6 +496,7 @@ function get_api_collections (req, res) {
|
||||||
///
|
///
|
||||||
/// - *shardKeys*: contains the names of document attributes that are used to
|
/// - *shardKeys*: contains the names of document attributes that are used to
|
||||||
/// determine the target shard for documents.
|
/// determine the target shard for documents.
|
||||||
|
///
|
||||||
/// @RESTRETURNCODES
|
/// @RESTRETURNCODES
|
||||||
///
|
///
|
||||||
/// @RESTRETURNCODE{400}
|
/// @RESTRETURNCODE{400}
|
||||||
|
|
Loading…
Reference in New Issue