Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

updated documentation

This commit is contained in:
Jan Steemann 2014-01-27 12:15:56 +01:00
parent 5ca6bc159d
commit 945031cfb5
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
arangod/RestHandler/RestDocumentHandler.cpp
View File

@ -744,6 +744,12 @@ bool RestDocumentHandler::readAllDocuments () {
/// ///
/// @RESTHEADERPARAMETERS /// @RESTHEADERPARAMETERS
/// ///
/// @RESTHEADERPARAM{If-None-Match,string,optional}
/// If the "If-None-Match" header is given, then it must contain exactly one
/// etag. If the current document revision is different to the specified etag,
/// an `HTTP 200` response is returned. If the current document revision is
/// identical to the specified etag, then an `HTTP 304` is returned.
///
/// @RESTHEADERPARAM{If-Match,string,optional} /// @RESTHEADERPARAM{If-Match,string,optional}
/// You can conditionally fetch a document based on a target revision id by /// You can conditionally fetch a document based on a target revision id by
/// using the `if-match` HTTP header. /// using the `if-match` HTTP header.
@ -758,13 +764,13 @@ bool RestDocumentHandler::readAllDocuments () {
/// @RESTRETURNCODE{200} /// @RESTRETURNCODE{200}
/// is returned if the document was found /// is returned if the document was found
/// ///
/// @RESTRETURNCODE{404}
/// is returned if the document or collection was not found
///
/// @RESTRETURNCODE{304} /// @RESTRETURNCODE{304}
/// is returned if the "If-None-Match" header is given and the document has /// is returned if the "If-None-Match" header is given and the document has
/// same version /// same version
/// ///
/// @RESTRETURNCODE{404}
/// is returned if the document or collection was not found
///
/// @RESTRETURNCODE{412} /// @RESTRETURNCODE{412}
/// is returned if a "If-Match" header or `rev` is given and the found /// is returned if a "If-Match" header or `rev` is given and the found
/// document has a different version /// document has a different version