1
0
Fork 0

updated documentation

This commit is contained in:
Jan Steemann 2016-06-07 15:48:59 +02:00
parent e77a571fc4
commit 0ef15e0fdf
3 changed files with 2 additions and 9 deletions

View File

@ -2,14 +2,13 @@
@startDocuBlock JSF_post_api_index_persistent @startDocuBlock JSF_post_api_index_persistent
@brief creates a persistent index @brief creates a persistent index
@RESTHEADER{POST /_api/index, Create a persistent index) @RESTHEADER{POST /_api/index#persistent, Create a persistent index}
@RESTQUERYPARAMETERS @RESTQUERYPARAMETERS
@RESTQUERYPARAM{collection-name,string,required} @RESTQUERYPARAM{collection-name,string,required}
The collection name. The collection name.
@RESTBODYPARAM{type,string,required,string} @RESTBODYPARAM{type,string,required,string}
must be equal to *"persistent"*. must be equal to *"persistent"*.

View File

@ -2,14 +2,13 @@
@startDocuBlock JSF_post_api_index_skiplist @startDocuBlock JSF_post_api_index_skiplist
@brief creates a skip-list @brief creates a skip-list
@RESTHEADER{POST /_api/index, Create skip list} @RESTHEADER{POST /_api/index#skiplist, Create skip list}
@RESTQUERYPARAMETERS @RESTQUERYPARAMETERS
@RESTQUERYPARAM{collection-name,string,required} @RESTQUERYPARAM{collection-name,string,required}
The collection name. The collection name.
@RESTBODYPARAM{type,string,required,string} @RESTBODYPARAM{type,string,required,string}
must be equal to *"skiplist"*. must be equal to *"skiplist"*.

View File

@ -33,7 +33,6 @@ var actions = require("@arangodb/actions");
var API = "_api/index"; var API = "_api/index";
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief was docuBlock JSF_get_api_index /// @brief was docuBlock JSF_get_api_index
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
@ -111,10 +110,6 @@ function get_api_index (req, res) {
} }
} }
////////////////////////////////////////////////////////////////////////////////
/// @brief was docuBlock JSF_post_api_index_cap
////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////
/// @brief was docuBlock JSF_post_api_index_geo /// @brief was docuBlock JSF_post_api_index_geo
//////////////////////////////////////////////////////////////////////////////// ////////////////////////////////////////////////////////////////////////////////