mirror of https://gitee.com/bigwinds/arangodb
URL parameter -> {query,path} parameter
This commit is contained in:
parent
7b595ad16d
commit
7538d71333
|
@ -390,7 +390,7 @@ clear or disable the browser cache in some cases to see your changes in effect.
|
|||
!SUBSECTION Data types
|
||||
|
||||
When processing the request data in an action, please be aware that the data
|
||||
type of all URL parameters is *string*. This is because the whole URL is a
|
||||
type of all query parameters is *string*. This is because the whole URL is a
|
||||
string and when the individual parts are extracted, they will also be strings.
|
||||
|
||||
For example, when calling the URL http:// localhost:8529/hello/world?value=5
|
||||
|
|
|
@ -11,7 +11,7 @@ Example input data:
|
|||
{ "_key": "key2", ... }
|
||||
...
|
||||
|
||||
To use this method, the *type* URL parameter should be set to *documents*.
|
||||
To use this method, the *type* query parameter should be set to *documents*.
|
||||
|
||||
It is also possible to upload self-contained JSON documents that are embedded
|
||||
into a JSON array. Each element from the array will be treated as a document and
|
||||
|
@ -34,9 +34,9 @@ format requires ArangoDB to parse the complete array and keep it in memory for
|
|||
the duration of the import. This might be more resource-intensive than the
|
||||
line-wise processing.
|
||||
|
||||
To use this method, the *type* URL parameter should be set to *array*.
|
||||
To use this method, the *type* query parameter should be set to *array*.
|
||||
|
||||
Setting the *type* URL parameter to *auto* will make the server auto-detect whether
|
||||
Setting the *type* query parameter to *auto* will make the server auto-detect whether
|
||||
the data are line-wise JSON documents (type = documents) or a JSON array (type = array).
|
||||
|
||||
*Examples*
|
||||
|
|
|
@ -18,16 +18,16 @@ The endpoint address is */_api/import* for both input mechanisms. Data must be
|
|||
sent to this URL using an HTTP POST request. The data to import must be
|
||||
contained in the body of the POST request.
|
||||
|
||||
The *collection* URL parameter must be used to specify the target collection for
|
||||
the import. The optional URL parameter *createCollection* can be used to create
|
||||
The *collection* query parameter must be used to specify the target collection for
|
||||
the import. The optional query parameter *createCollection* can be used to create
|
||||
a non-existing collection during the import. If not used, importing data into a
|
||||
non-existing collection will produce an error. Please note that the *createCollection*
|
||||
flag can only be used to create document collections, not [edge collections](../Glossary/index.html#edge_collection).
|
||||
|
||||
The *waitForSync* URL parameter can be set to *true* to make the import only
|
||||
The *waitForSync* query parameter can be set to *true* to make the import only
|
||||
return if all documents have been synced to disk.
|
||||
|
||||
The *complete* URL parameter can be set to *true* to make the entire import fail if
|
||||
The *complete* query parameter can be set to *true* to make the entire import fail if
|
||||
any of the uploaded documents is invalid and cannot be imported. In this case,
|
||||
no documents will be imported by the import run, even if a failure happens at the
|
||||
end of the import.
|
||||
|
@ -36,7 +36,7 @@ If *complete* has a value other than *true*, valid documents will be imported wh
|
|||
invalid documents will be rejected, meaning only some of the uploaded documents
|
||||
might have been imported.
|
||||
|
||||
The *details* URL parameter can be set to *true* to make the import API return
|
||||
The *details* query parameter can be set to *true* to make the import API return
|
||||
details about documents that could not be imported. If *details* is *true*, then
|
||||
the result will also contain a *details* attribute which is an array of detailed
|
||||
error messages. If the *details* is set to *false* or omitted, no details will be
|
||||
|
|
|
@ -111,13 +111,13 @@ def getRestReplyBodyParam(param):
|
|||
|
||||
SIMPL_REPL_DICT = {
|
||||
"@RESTDESCRIPTION" : "",
|
||||
"@RESTURLPARAMETERS" : "\n**URL Parameters**\n",
|
||||
"@RESTURLPARAMETERS" : "\n**Path Parameters**\n",
|
||||
"@RESTQUERYPARAMETERS" : "\n**Query Parameters**\n",
|
||||
"@RESTHEADERPARAMETERS" : "\n**Header Parameters**\n",
|
||||
"@RESTRETURNCODES" : "\n**Return Codes**\n",
|
||||
"@PARAMS" : "\n**Parameters**\n",
|
||||
"@RESTPARAMS" : "",
|
||||
"@RESTURLPARAMS" : "\n**URL Parameters**\n",
|
||||
"@RESTURLPARAMS" : "\n**Path Parameters**\n",
|
||||
"@RESTQUERYPARAMS" : "\n**Query Parameters**\n",
|
||||
"@RESTBODYPARAM" : getRestBodyParam,
|
||||
"@RESTREPLYBODY" : getRestReplyBodyParam,
|
||||
|
@ -131,7 +131,7 @@ SIMPL_REPL_DICT = {
|
|||
SIMPLE_RX = re.compile(
|
||||
r'''
|
||||
@RESTDESCRIPTION| # -> <empty>
|
||||
@RESTURLPARAMETERS| # -> \n**URL Parameters**\n
|
||||
@RESTURLPARAMETERS| # -> \n**Path Parameters**\n
|
||||
@RESTQUERYPARAMETERS| # -> \n**Query Parameters**\n
|
||||
@RESTHEADERPARAMETERS| # -> \n**Header Parameters**\n
|
||||
@RESTBODYPARAM| # -> call post body param
|
||||
|
|
|
@ -72,7 +72,7 @@ describe ArangoDB do
|
|||
doc.parsed_response['requestType'].should eq("GET")
|
||||
end
|
||||
|
||||
it "using GET, with URL parameter" do
|
||||
it "using GET, with query parameter" do
|
||||
cmd = "/_admin/echo?a=1"
|
||||
doc = ArangoDB.log_get("#{prefix}-echo", cmd)
|
||||
|
||||
|
@ -83,7 +83,7 @@ describe ArangoDB do
|
|||
doc.parsed_response['requestType'].should eq("GET")
|
||||
end
|
||||
|
||||
it "using POST, with URL parameters" do
|
||||
it "using POST, with query parameters" do
|
||||
cmd = "/_admin/echo?a=1&b=2&foo[]=bar&foo[]=baz"
|
||||
body = "{\"foo\": \"bar\", \"baz\": { \"bump\": true, \"moo\": [ ] } }"
|
||||
doc = ArangoDB.log_post("#{prefix}-echo", cmd, :body => body)
|
||||
|
|
|
@ -1319,7 +1319,7 @@ AgencyCommResult AgencyComm::uniqid (std::string const& key,
|
|||
// -----------------------------------------------------------------------------
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief creates a ttl URL parameter
|
||||
/// @brief creates a ttl query parameter
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
std::string AgencyComm::ttlParam (double ttl,
|
||||
|
|
|
@ -588,7 +588,7 @@ namespace triagens {
|
|||
private:
|
||||
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
/// @brief create a URL parameter for a TTL value
|
||||
/// @brief create a query parameter for a TTL value
|
||||
////////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
std::string ttlParam (double,
|
||||
|
|
|
@ -107,7 +107,7 @@ bool RestAdminLogHandler::isDirect () const {
|
|||
/// The default value is *info*.
|
||||
///
|
||||
/// @RESTQUERYPARAM{level,string,optional}
|
||||
/// Returns all log entries of log level *level*. Note that the URL parameters
|
||||
/// Returns all log entries of log level *level*. Note that the query parameters
|
||||
/// *upto* and *level* are mutually exclusive.
|
||||
///
|
||||
/// @RESTQUERYPARAM{start,number,optional}
|
||||
|
|
|
@ -140,14 +140,14 @@ HttpHandler::status_t RestDocumentHandler::execute () {
|
|||
/// as soon as the document has been accepted. It will not wait until the
|
||||
/// document has been synced to disk.
|
||||
///
|
||||
/// Optionally, the URL parameter *waitForSync* can be used to force
|
||||
/// Optionally, the query parameter *waitForSync* can be used to force
|
||||
/// synchronization of the document creation operation to disk even in case that
|
||||
/// the *waitForSync* flag had been disabled for the entire collection. Thus,
|
||||
/// the *waitForSync* URL parameter can be used to force synchronization of just
|
||||
/// the *waitForSync* query parameter can be used to force synchronization of just
|
||||
/// this specific operations. To use this, set the *waitForSync* parameter to
|
||||
/// *true*. If the *waitForSync* parameter is not specified or set to *false*,
|
||||
/// then the collection's default *waitForSync* behavior is applied. The
|
||||
/// *waitForSync* URL parameter cannot be used to disable synchronization for
|
||||
/// *waitForSync* query parameter cannot be used to disable synchronization for
|
||||
/// collections that have a default *waitForSync* value of *true*.
|
||||
///
|
||||
/// @RESTRETURNCODES
|
||||
|
@ -210,7 +210,7 @@ HttpHandler::status_t RestDocumentHandler::execute () {
|
|||
/// @END_EXAMPLE_ARANGOSH_RUN
|
||||
///
|
||||
/// Create a document in a collection with a collection-level *waitForSync*
|
||||
/// value of *false*, but using the *waitForSync* URL parameter.
|
||||
/// value of *false*, but using the *waitForSync* query parameter.
|
||||
///
|
||||
/// @EXAMPLE_ARANGOSH_RUN{RestDocumentHandlerPostWait1}
|
||||
/// var cn = "products";
|
||||
|
@ -889,7 +889,7 @@ bool RestDocumentHandler::getAllDocumentsCoordinator (string const& collname,
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally fetch a document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTHEADERPARAMETERS
|
||||
///
|
||||
|
@ -978,7 +978,7 @@ bool RestDocumentHandler::checkDocument () {
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally replace a document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -1001,14 +1001,14 @@ bool RestDocumentHandler::checkDocument () {
|
|||
/// relevant in order to avoid confusion when using proxies.
|
||||
///
|
||||
///
|
||||
/// Optionally, the URL parameter *waitForSync* can be used to force
|
||||
/// Optionally, the query parameter *waitForSync* can be used to force
|
||||
/// synchronization of the document replacement operation to disk even in case
|
||||
/// that the *waitForSync* flag had been disabled for the entire collection.
|
||||
/// Thus, the *waitForSync* URL parameter can be used to force synchronization
|
||||
/// Thus, the *waitForSync* query parameter can be used to force synchronization
|
||||
/// of just specific operations. To use this, set the *waitForSync* parameter
|
||||
/// to *true*. If the *waitForSync* parameter is not specified or set to
|
||||
/// *false*, then the collection's default *waitForSync* behavior is
|
||||
/// applied. The *waitForSync* URL parameter cannot be used to disable
|
||||
/// applied. The *waitForSync* query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default *waitForSync* value
|
||||
/// of *true*.
|
||||
///
|
||||
|
@ -1031,7 +1031,7 @@ bool RestDocumentHandler::checkDocument () {
|
|||
///
|
||||
///
|
||||
/// Specifying a target revision is optional, however, if done, only one of the
|
||||
/// described mechanisms must be used (either the *rev* URL parameter or the
|
||||
/// described mechanisms must be used (either the *rev* query parameter or the
|
||||
/// *if-match* HTTP header).
|
||||
/// Regardless which mechanism is used, the parameter needs to contain the target
|
||||
/// document revision id as returned in the *_rev* attribute of a document or
|
||||
|
@ -1226,7 +1226,7 @@ bool RestDocumentHandler::replaceDocument () {
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally patch a document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -1248,14 +1248,14 @@ bool RestDocumentHandler::replaceDocument () {
|
|||
/// Setting an attribute value to *null* in the patch document will cause a
|
||||
/// value of *null* be saved for the attribute by default.
|
||||
///
|
||||
/// Optionally, the URL parameter *waitForSync* can be used to force
|
||||
/// Optionally, the query parameter *waitForSync* can be used to force
|
||||
/// synchronization of the document update operation to disk even in case
|
||||
/// that the *waitForSync* flag had been disabled for the entire collection.
|
||||
/// Thus, the *waitForSync* URL parameter can be used to force synchronization
|
||||
/// Thus, the *waitForSync* query parameter can be used to force synchronization
|
||||
/// of just specific operations. To use this, set the *waitForSync* parameter
|
||||
/// to *true*. If the *waitForSync* parameter is not specified or set to
|
||||
/// *false*, then the collection's default *waitForSync* behavior is
|
||||
/// applied. The *waitForSync* URL parameter cannot be used to disable
|
||||
/// applied. The *waitForSync* query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default *waitForSync* value
|
||||
/// of *true*.
|
||||
///
|
||||
|
@ -1269,7 +1269,7 @@ bool RestDocumentHandler::replaceDocument () {
|
|||
/// body of the response contains an error document.
|
||||
///
|
||||
/// You can conditionally update a document based on a target revision id by
|
||||
/// using either the *rev* URL parameter or the *if-match* HTTP header.
|
||||
/// using either the *rev* query parameter or the *if-match* HTTP header.
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
/// can use the *policy* parameter. This is the same as when replacing
|
||||
/// documents (see replacing documents for details).
|
||||
|
@ -1676,7 +1676,7 @@ bool RestDocumentHandler::modifyDocumentCoordinator (
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally remove a document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -1701,7 +1701,7 @@ bool RestDocumentHandler::modifyDocumentCoordinator (
|
|||
///
|
||||
/// If the *waitForSync* parameter is not specified or set to
|
||||
/// *false*, then the collection's default *waitForSync* behavior is
|
||||
/// applied. The *waitForSync* URL parameter cannot be used to disable
|
||||
/// applied. The *waitForSync* query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default *waitForSync* value
|
||||
/// of *true*.
|
||||
///
|
||||
|
|
|
@ -439,7 +439,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally fetch an edge document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTHEADERPARAMETERS
|
||||
///
|
||||
|
@ -498,7 +498,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally replace an edge document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -522,14 +522,14 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
/// **Note**: The attributes
|
||||
/// *_from* and *_to* of an edge are immutable and cannot be updated either.
|
||||
///
|
||||
/// Optionally, the URL parameter *waitForSync* can be used to force
|
||||
/// Optionally, the query parameter *waitForSync* can be used to force
|
||||
/// synchronization of the edge document replacement operation to disk even in case
|
||||
/// that the *waitForSync* flag had been disabled for the entire collection.
|
||||
/// Thus, the *waitForSync* URL parameter can be used to force synchronization
|
||||
/// Thus, the *waitForSync* query parameter can be used to force synchronization
|
||||
/// of just specific operations. To use this, set the *waitForSync* parameter
|
||||
/// to *true*. If the *waitForSync* parameter is not specified or set to
|
||||
/// *false*, then the collection's default *waitForSync* behavior is
|
||||
/// applied. The *waitForSync* URL parameter cannot be used to disable
|
||||
/// applied. The *waitForSync* query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default *waitForSync* value
|
||||
/// of *true*.
|
||||
///
|
||||
|
@ -550,7 +550,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
/// - specifying the target revision in the *if-match* HTTP header
|
||||
///
|
||||
/// Specifying a target revision is optional, however, if done, only one of the
|
||||
/// described mechanisms must be used (either the *rev* URL parameter or the
|
||||
/// described mechanisms must be used (either the *rev* query parameter or the
|
||||
/// *if-match* HTTP header).
|
||||
/// Regardless which mechanism is used, the parameter needs to contain the target
|
||||
/// revision id as returned in the *_rev* attribute of an edge document or
|
||||
|
@ -640,7 +640,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally patch an edge document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -665,14 +665,14 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
/// **Note**: Internal attributes such as *_key*, *_from* and *_to* are immutable
|
||||
/// once set and cannot be updated.
|
||||
///
|
||||
/// Optionally, the URL parameter *waitForSync* can be used to force
|
||||
/// Optionally, the query parameter *waitForSync* can be used to force
|
||||
/// synchronization of the edge document update operation to disk even in case
|
||||
/// that the *waitForSync* flag had been disabled for the entire collection.
|
||||
/// Thus, the *waitForSync* URL parameter can be used to force synchronization
|
||||
/// Thus, the *waitForSync* query parameter can be used to force synchronization
|
||||
/// of just specific operations. To use this, set the *waitForSync* parameter
|
||||
/// to *true*. If the *waitForSync* parameter is not specified or set to
|
||||
/// *false*, then the collection's default *waitForSync* behavior is
|
||||
/// applied. The *waitForSync* URL parameter cannot be used to disable
|
||||
/// applied. The *waitForSync* query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default *waitForSync* value
|
||||
/// of *true*.
|
||||
///
|
||||
|
@ -686,7 +686,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
/// body of the response contains an error document.
|
||||
///
|
||||
/// You can conditionally update an edge document based on a target revision id by
|
||||
/// using either the *rev* URL parameter or the *if-match* HTTP header.
|
||||
/// using either the *rev* query parameter or the *if-match* HTTP header.
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
/// can use the *policy* parameter. This is the same as when replacing
|
||||
/// edge documents (see replacing documents for details).
|
||||
|
@ -732,7 +732,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally delete an edge document based on a target revision id by
|
||||
/// using the *rev* URL parameter.
|
||||
/// using the *rev* query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -757,7 +757,7 @@ bool RestEdgeHandler::createDocumentCoordinator (string const& collname,
|
|||
///
|
||||
/// If the *waitForSync* parameter is not specified or set to
|
||||
/// *false*, then the collection's default *waitForSync* behavior is
|
||||
/// applied. The *waitForSync* URL parameter cannot be used to disable
|
||||
/// applied. The *waitForSync* query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default *waitForSync* value
|
||||
/// of *true*.
|
||||
///
|
||||
|
|
|
@ -451,7 +451,7 @@ int RestImportHandler::handleSingleDocument (RestImportTransaction& trx,
|
|||
/// - `ignored`: number of failed but ignored insert operations (in case
|
||||
/// `onDuplicate` was set to `ignore`).
|
||||
///
|
||||
/// - `details`: if URL parameter `details` is set to true, the result will
|
||||
/// - `details`: if query parameter `details` is set to true, the result will
|
||||
/// contain a `details` attribute which is an array with more detailed
|
||||
/// information about which documents could not be inserted.
|
||||
///
|
||||
|
@ -1012,7 +1012,7 @@ bool RestImportHandler::createFromJson (string const& type) {
|
|||
/// - `ignored`: number of failed but ignored insert operations (in case
|
||||
/// `onDuplicate` was set to `ignore`).
|
||||
///
|
||||
/// - `details`: if URL parameter `details` is set to true, the result will
|
||||
/// - `details`: if query parameter `details` is set to true, the result will
|
||||
/// contain a `details` attribute which is an array with more detailed
|
||||
/// information about which documents could not be inserted.
|
||||
///
|
||||
|
|
|
@ -595,7 +595,7 @@ void RestJobHandler::getJobByType (std::string const& type) {
|
|||
/// * *all*: Deletes all jobs results. Currently executing or queued async
|
||||
/// jobs will not be stopped by this call.
|
||||
/// * *expired*: Deletes expired results. To determine the expiration status of a
|
||||
/// result, pass the stamp URL parameter. stamp needs to be a UNIX timestamp,
|
||||
/// result, pass the stamp query parameter. stamp needs to be a UNIX timestamp,
|
||||
/// and all async job results created at a lower timestamp will be deleted.
|
||||
/// * *an actual job-id*: In this case, the call will remove the result of the
|
||||
/// specified async job. If the job is currently executing or queued, it will not be aborted.
|
||||
|
|
|
@ -436,7 +436,7 @@ uint64_t RestReplicationHandler::determineChunkSize () const {
|
|||
const char* value = _request->value("chunkSize", found);
|
||||
|
||||
if (found) {
|
||||
// url parameter "chunkSize" was specified
|
||||
// query parameter "chunkSize" was specified
|
||||
chunkSize = StringUtils::uint64(value);
|
||||
|
||||
// don't allow overly big allocations
|
||||
|
@ -787,7 +787,7 @@ void RestReplicationHandler::handleCommandLoggerFirstTick () {
|
|||
///
|
||||
/// - *id*: the id of the batch
|
||||
///
|
||||
/// **Note**: on a coordinator, this request must have the URL parameter
|
||||
/// **Note**: on a coordinator, this request must have the query parameter
|
||||
/// *DBserver* which must be an ID of a DBserver.
|
||||
/// The very same request is forwarded synchronously to that DBserver.
|
||||
/// It is an error if this attribute is not bound in the coordinator case.
|
||||
|
@ -828,7 +828,7 @@ void RestReplicationHandler::handleCommandLoggerFirstTick () {
|
|||
///
|
||||
/// If the batch's ttl can be extended successfully, the response is empty.
|
||||
///
|
||||
/// **Note**: on a coordinator, this request must have the URL parameter
|
||||
/// **Note**: on a coordinator, this request must have the query parameter
|
||||
/// *DBserver* which must be an ID of a DBserver.
|
||||
/// The very same request is forwarded synchronously to that DBserver.
|
||||
/// It is an error if this attribute is not bound in the coordinator case.
|
||||
|
@ -862,7 +862,7 @@ void RestReplicationHandler::handleCommandLoggerFirstTick () {
|
|||
/// @RESTDESCRIPTION
|
||||
/// Deletes the existing dump batch, allowing compaction and cleanup to resume.
|
||||
///
|
||||
/// **Note**: on a coordinator, this request must have the URL parameter
|
||||
/// **Note**: on a coordinator, this request must have the query parameter
|
||||
/// *DBserver* which must be an ID of a DBserver.
|
||||
/// The very same request is forwarded synchronously to that DBserver.
|
||||
/// It is an error if this attribute is not bound in the coordinator case.
|
||||
|
@ -1081,20 +1081,20 @@ void RestReplicationHandler::handleTrampolineCoordinator () {
|
|||
/// from the logger server. In this case, they should provide the *from* value so
|
||||
/// they will only get returned the log events since their last fetch.
|
||||
///
|
||||
/// When the *from* URL parameter is not used, the logger server will return log
|
||||
/// When the *from* query parameter is not used, the logger server will return log
|
||||
/// entries starting at the beginning of its replication log. When the *from*
|
||||
/// parameter is used, the logger server will only return log entries which have
|
||||
/// higher tick values than the specified *from* value (note: the log entry with a
|
||||
/// tick value equal to *from* will be excluded). Use the *from* value when
|
||||
/// incrementally fetching log data.
|
||||
///
|
||||
/// The *to* URL parameter can be used to optionally restrict the upper bound of
|
||||
/// The *to* query parameter can be used to optionally restrict the upper bound of
|
||||
/// the result to a certain tick value. If used, the result will contain only log events
|
||||
/// with tick values up to (including) *to*. In incremental fetching, there is no
|
||||
/// need to use the *to* parameter. It only makes sense in special situations,
|
||||
/// when only parts of the change log are required.
|
||||
///
|
||||
/// The *chunkSize* URL parameter can be used to control the size of the result.
|
||||
/// The *chunkSize* query parameter can be used to control the size of the result.
|
||||
/// It must be specified in bytes. The *chunkSize* value will only be honored
|
||||
/// approximately. Otherwise a too low *chunkSize* value could cause the server
|
||||
/// to not be able to put just one log entry into the result and return it.
|
||||
|
@ -1539,7 +1539,7 @@ void RestReplicationHandler::handleCommandDetermineOpenTransactions () {
|
|||
/// response will be empty and clients can go to sleep for a while and try again
|
||||
/// later.
|
||||
///
|
||||
/// **Note**: on a coordinator, this request must have the URL parameter
|
||||
/// **Note**: on a coordinator, this request must have the query parameter
|
||||
/// *DBserver* which must be an ID of a DBserver.
|
||||
/// The very same request is forwarded synchronously to that DBserver.
|
||||
/// It is an error if this attribute is not bound in the coordinator case.
|
||||
|
@ -3421,16 +3421,16 @@ void RestReplicationHandler::handleCommandRemoveKeys () {
|
|||
/// @RESTDESCRIPTION
|
||||
/// Returns the data from the collection for the requested range.
|
||||
///
|
||||
/// When the *from* URL parameter is not used, collection events are returned from
|
||||
/// When the *from* query parameter is not used, collection events are returned from
|
||||
/// the beginning. When the *from* parameter is used, the result will only contain
|
||||
/// collection entries which have higher tick values than the specified *from* value
|
||||
/// (note: the log entry with a tick value equal to *from* will be excluded).
|
||||
///
|
||||
/// The *to* URL parameter can be used to optionally restrict the upper bound of
|
||||
/// The *to* query parameter can be used to optionally restrict the upper bound of
|
||||
/// the result to a certain tick value. If used, the result will only contain
|
||||
/// collection entries with tick values up to (including) *to*.
|
||||
///
|
||||
/// The *chunkSize* URL parameter can be used to control the size of the result.
|
||||
/// The *chunkSize* query parameter can be used to control the size of the result.
|
||||
/// It must be specified in bytes. The *chunkSize* value will only be honored
|
||||
/// approximately. Otherwise a too low *chunkSize* value could cause the server
|
||||
/// to not be able to put just one entry into the result and return it.
|
||||
|
@ -4624,7 +4624,7 @@ void RestReplicationHandler::handleCommandApplierStart () {
|
|||
|
||||
TRI_voc_tick_t initialTick = 0;
|
||||
if (found) {
|
||||
// url parameter "from" specified
|
||||
// query parameter "from" specified
|
||||
initialTick = (TRI_voc_tick_t) StringUtils::uint64(value);
|
||||
}
|
||||
|
||||
|
|
|
@ -102,7 +102,7 @@ bool RestVersionHandler::isDirect () const {
|
|||
///
|
||||
/// @RESTREPLYBODY{details,object,optional,}
|
||||
/// an optional JSON object with additional details. This is
|
||||
/// returned only if the *details* URL parameter is set to *true* in the
|
||||
/// returned only if the *details* query parameter is set to *true* in the
|
||||
/// request.
|
||||
///
|
||||
/// @EXAMPLES
|
||||
|
|
|
@ -122,7 +122,7 @@ actions.defineHttp({
|
|||
///
|
||||
/// - *requestType*: the HTTP request method (e.g. GET)
|
||||
///
|
||||
/// - *parameters*: object with URL parameters received
|
||||
/// - *parameters*: object with query parameters received
|
||||
///
|
||||
/// @RESTRETURNCODES
|
||||
///
|
||||
|
@ -157,7 +157,7 @@ actions.defineHttp({
|
|||
///
|
||||
/// - *requestType*: the HTTP request method (e.g. GET)
|
||||
///
|
||||
/// - *parameters*: object with URL parameters received
|
||||
/// - *parameters*: object with query parameters received
|
||||
///
|
||||
/// @RESTRETURNCODES
|
||||
///
|
||||
|
|
|
@ -93,7 +93,7 @@ actions.defineHttp({
|
|||
return body[name];
|
||||
}
|
||||
|
||||
// need to handle strings because URL parameter values are strings
|
||||
// need to handle strings because parameter values are strings
|
||||
return (req.parameters.hasOwnProperty(name) &&
|
||||
(req.parameters[name] === "true" || req.parameters[name] === true));
|
||||
};
|
||||
|
|
|
@ -399,7 +399,7 @@ function post_api_collection (req, res) {
|
|||
/// available in the *names* as an object with the collection names
|
||||
/// as keys.
|
||||
///
|
||||
/// By providing the optional URL parameter *excludeSystem* with a value of
|
||||
/// By providing the optional query parameter *excludeSystem* with a value of
|
||||
/// *true*, all system collections will be excluded from the response.
|
||||
///
|
||||
/// @RESTRETURNCODES
|
||||
|
@ -903,10 +903,10 @@ function get_api_collections (req, res) {
|
|||
/// of the documents contained in the collection. For edge collections, the system
|
||||
/// attributes *_from* and *_to* will also be included in the calculation.
|
||||
///
|
||||
/// By setting the optional URL parameter *withRevisions* to *true*, then revision
|
||||
/// By setting the optional query parameter *withRevisions* to *true*, then revision
|
||||
/// ids (*_rev* system attributes) are included in the checksumming.
|
||||
///
|
||||
/// By providing the optional URL parameter *withData* with a value of *true*,
|
||||
/// By providing the optional query parameter *withData* with a value of *true*,
|
||||
/// the user-defined document attributes will be included in the calculation too.
|
||||
/// **Note**: Including user-defined attributes will make the checksumming slower.
|
||||
///
|
||||
|
|
|
@ -913,7 +913,7 @@ actions.defineHttp({
|
|||
///
|
||||
/// @ RESTRETURNCODE{200} is returned when everything went well.
|
||||
///
|
||||
/// @ RESTRETURNCODE{400} the primary was not given as URL parameter.
|
||||
/// @ RESTRETURNCODE{400} the primary was not given as query parameter.
|
||||
///
|
||||
/// @ RESTRETURNCODE{403} server is not a coordinator or method was not GET.
|
||||
///
|
||||
|
|
|
@ -1208,7 +1208,7 @@ function patchDocumentByStructure(req, res, collection, structure, oldDocument,
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally select a document based on a target revision id by
|
||||
/// using the `rev` URL parameter.
|
||||
/// using the `rev` query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{lang,string,optional}
|
||||
/// Language of the data.
|
||||
|
@ -1300,7 +1300,7 @@ function get_api_structure(req, res) {
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally select a document based on a target revision id by
|
||||
/// using the `rev` URL parameter.
|
||||
/// using the `rev` query parameter.
|
||||
///
|
||||
/// @RESTHEADERPARAMETERS
|
||||
///
|
||||
|
@ -1368,7 +1368,7 @@ function head_api_structure(req, res) {
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally delete a document based on a target revision id by
|
||||
/// using the `rev` URL parameter.
|
||||
/// using the `rev` query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -1392,7 +1392,7 @@ function head_api_structure(req, res) {
|
|||
///
|
||||
/// If the `waitForSync` parameter is not specified or set to
|
||||
/// `false`, then the collection's default `waitForSync` behavior is
|
||||
/// applied. The `waitForSync` URL parameter cannot be used to disable
|
||||
/// applied. The `waitForSync` query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default `waitForSync` value
|
||||
/// of `true`.
|
||||
///
|
||||
|
@ -1473,7 +1473,7 @@ function delete_api_structure (req, res) {
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally patch a document based on a target revision id by
|
||||
/// using the `rev` URL parameter.
|
||||
/// using the `rev` query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -1501,14 +1501,14 @@ function delete_api_structure (req, res) {
|
|||
/// Setting an attribute value to `null` in the patch document will cause a
|
||||
/// value of `null` be saved for the attribute by default.
|
||||
///
|
||||
/// Optionally, the URL parameter `waitForSync` can be used to force
|
||||
/// Optionally, the query parameter `waitForSync` can be used to force
|
||||
/// synchronization of the document update operation to disk even in case
|
||||
/// that the `waitForSync` flag had been disabled for the entire collection.
|
||||
/// Thus, the `waitForSync` URL parameter can be used to force synchronization
|
||||
/// Thus, the `waitForSync` query parameter can be used to force synchronization
|
||||
/// of just specific operations. To use this, set the `waitForSync` parameter
|
||||
/// to `true`. If the `waitForSync` parameter is not specified or set to
|
||||
/// `false`, then the collection's default `waitForSync` behavior is
|
||||
/// applied. The `waitForSync` URL parameter cannot be used to disable
|
||||
/// applied. The `waitForSync` query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default `waitForSync` value
|
||||
/// of `true`.
|
||||
///
|
||||
|
@ -1521,7 +1521,7 @@ function delete_api_structure (req, res) {
|
|||
/// body of the response contains an error document.
|
||||
///
|
||||
/// You can conditionally update a document based on a target revision id by
|
||||
/// using either the `rev` URL parameter or the `if-match` HTTP header.
|
||||
/// using either the `rev` query parameter or the `if-match` HTTP header.
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
/// can use the `policy` parameter. This is the same as when replacing
|
||||
/// documents (see replacing documents for details).
|
||||
|
@ -1602,7 +1602,7 @@ function patch_api_structure (req, res) {
|
|||
///
|
||||
/// @RESTQUERYPARAM{rev,string,optional}
|
||||
/// You can conditionally replace a document based on a target revision id by
|
||||
/// using the `rev` URL parameter.
|
||||
/// using the `rev` query parameter.
|
||||
///
|
||||
/// @RESTQUERYPARAM{policy,string,optional}
|
||||
/// To control the update behavior in case there is a revision mismatch, you
|
||||
|
@ -1631,14 +1631,14 @@ function patch_api_structure (req, res) {
|
|||
/// these attributes will be ignored. Only the URI and the "ETag" header are
|
||||
/// relevant in order to avoid confusion when using proxies.
|
||||
///
|
||||
/// Optionally, the URL parameter `waitForSync` can be used to force
|
||||
/// Optionally, the query parameter `waitForSync` can be used to force
|
||||
/// synchronization of the document replacement operation to disk even in case
|
||||
/// that the `waitForSync` flag had been disabled for the entire collection.
|
||||
/// Thus, the `waitForSync` URL parameter can be used to force synchronization
|
||||
/// Thus, the `waitForSync` query parameter can be used to force synchronization
|
||||
/// of just specific operations. To use this, set the `waitForSync` parameter
|
||||
/// to `true`. If the `waitForSync` parameter is not specified or set to
|
||||
/// `false`, then the collection's default `waitForSync` behavior is
|
||||
/// applied. The `waitForSync` URL parameter cannot be used to disable
|
||||
/// applied. The `waitForSync` query parameter cannot be used to disable
|
||||
/// synchronization for collections that have a default `waitForSync` value
|
||||
/// of `true`.
|
||||
///
|
||||
|
@ -1658,7 +1658,7 @@ function patch_api_structure (req, res) {
|
|||
/// - specifying the target revision in the `if-match` HTTP header
|
||||
///
|
||||
/// Specifying a target revision is optional, however, if done, only one of the
|
||||
/// described mechanisms must be used (either the `rev` URL parameter or the
|
||||
/// described mechanisms must be used (either the `rev` query parameter or the
|
||||
/// `if-match` HTTP header).
|
||||
/// Regardless which mechanism is used, the parameter needs to contain the target
|
||||
/// document revision id as returned in the `_rev` attribute of a document or
|
||||
|
@ -1794,14 +1794,14 @@ function put_api_structure (req, res) {
|
|||
/// as soon as the document has been accepted. It will not wait, until the
|
||||
/// documents has been sync to disk.
|
||||
///
|
||||
/// Optionally, the URL parameter `waitForSync` can be used to force
|
||||
/// Optionally, the query parameter `waitForSync` can be used to force
|
||||
/// synchronization of the document creation operation to disk even in case that
|
||||
/// the `waitForSync` flag had been disabled for the entire collection. Thus,
|
||||
/// the `waitForSync` URL parameter can be used to force synchronization of just
|
||||
/// the `waitForSync` query parameter can be used to force synchronization of just
|
||||
/// this specific operations. To use this, set the `waitForSync` parameter to
|
||||
/// `true`. If the `waitForSync` parameter is not specified or set to `false`,
|
||||
/// then the collection's default `waitForSync` behavior is applied. The
|
||||
/// `waitForSync` URL parameter cannot be used to disable synchronization for
|
||||
/// `waitForSync` query parameter cannot be used to disable synchronization for
|
||||
/// collections that have a default `waitForSync` value of `true`.
|
||||
///
|
||||
/// @RESTRETURNCODES
|
||||
|
|
|
@ -14909,7 +14909,7 @@ jQuery.extend({
|
|||
// Remove hash character (#7531: and string promotion)
|
||||
// Add protocol if not provided (prefilters might expect it)
|
||||
// Handle falsy url in the settings object (#10093: consistency with old signature)
|
||||
// We also use the url parameter if available
|
||||
// We also use the query parameter if available
|
||||
s.url = ( ( url || s.url || ajaxLocation ) + "" ).replace( rhash, "" )
|
||||
.replace( rprotocol, ajaxLocParts[ 1 ] + "//" );
|
||||
|
||||
|
|
|
@ -751,7 +751,7 @@ class Controller {
|
|||
///
|
||||
/// Mounts the API documentation (Swagger) at the given `path`.
|
||||
///
|
||||
/// Note that the `path` can use URL parameters as usual but must not use any
|
||||
/// Note that the `path` can use path parameters as usual but must not use any
|
||||
/// wildcard (`*`) or optional (`:name?`) parameters.
|
||||
///
|
||||
/// The optional **opts** can be an object with any of the following properties:
|
||||
|
|
|
@ -943,7 +943,7 @@ void HttpRequest::parseHeader (char* ptr, size_t length) {
|
|||
++paramEnd;
|
||||
}
|
||||
|
||||
// set full url = complete path + url parameters
|
||||
// set full url = complete path + query parameters
|
||||
setFullUrl(pathBegin, paramEnd);
|
||||
|
||||
// now that the full url was saved, we can insert the null bytes
|
||||
|
|
Loading…
Reference in New Issue