]> granicus.if.org Git - icinga2/commitdiff
Minor codestyle and doc changes 6103/head
authorJean Flach <jean-marcel.flach@icinga.com>
Wed, 21 Feb 2018 12:22:17 +0000 (13:22 +0100)
committerJean Flach <jean-marcel.flach@icinga.com>
Wed, 21 Feb 2018 13:52:44 +0000 (14:52 +0100)
doc/12-icinga2-api.md
lib/base/tlsstream.cpp
lib/remote/httprequest.cpp
lib/remote/httprequest.hpp
lib/remote/httpserverconnection.cpp
lib/remote/httpserverconnection.hpp

index 676bc978421d409104e5a3f6c2918efa1c7d5e56..0f44bbfdaac04e7256a773cd2aaa4c2c555e2166 100644 (file)
@@ -208,13 +208,12 @@ The [regex function](18-library-reference.md#global-functions-regex) is availabl
 
 More information about filters can be found in the [filters](12-icinga2-api.md#icinga2-api-filters) chapter.
 
-Note that the permissions a API user has also specify the max body size of their requests.
-A API user with `*` permissions is allowed to send 512 MB.
-
+Permissions are tied to a maximum HTTP request size to prevent abuse, responses sent by Icinga are not limited.
+An API user with all permissions ("\*") may send up to 512 MB regardless of the endpoint.
 
 Available permissions for specific URL endpoints:
 
-  Permissions                   | URL Endpoint  | Supports Filters  | Max Body Size in MB
+  Permissions                   | URL Endpoint  | Supports filters  | Max body size in MB
   ------------------------------|---------------|-------------------|---------------------
   actions/&lt;action&gt;        | /v1/actions   | Yes               | 1
   config/query                  | /v1/config    | No                | 1
@@ -234,8 +233,7 @@ The required actions or types can be replaced by using a wildcard match ("\*").
 
 ### Parameters <a id="icinga2-api-parameters"></a>
 
-Depending on the request method there are two ways of
-passing parameters to the request:
+Depending on the request method there are two ways of passing parameters to the request:
 
 * JSON object as request body (all request methods other than `GET`)
 * Query string as URL parameter (all request methods)
index e97f68b605c046e7869f7cee9f27d138a2fa82ac..2846e8962744a486c3496dc38aa4e1800527df13 100644 (file)
@@ -28,7 +28,6 @@
 #endif /* _WIN32 */
 
 #define TLS_TIMEOUT_SECONDS 10
-#define TLS_TIMEOUT_STEP_SECONDS 1
 
 using namespace icinga;
 
index c5382d25412484fbb99123f572a6a65fdbfe890c..a50cd378341776a4680c4462e95b2ba1b0703849 100644 (file)
@@ -34,7 +34,7 @@ HttpRequest::HttpRequest(Stream::Ptr stream)
        m_State(HttpRequestStart)
 { }
 
-bool HttpRequest::ParseHeader(StreamReadContext& src, bool may_wait)
+bool HttpRequest::ParseHeaders(StreamReadContext& src, bool may_wait)
 {
        if (!m_Stream)
                return false;
index b456d72294414138ff0a25538babdc29ae20008e..14e0677cdf59e005b964421798e831654ef287b4 100644 (file)
@@ -64,7 +64,7 @@ public:
 
        HttpRequest(Stream::Ptr stream);
 
-       bool ParseHeader(StreamReadContext& src, bool may_wait);
+       bool ParseHeaders(StreamReadContext& src, bool may_wait);
        bool ParseBody(StreamReadContext& src, bool may_wait);
        size_t ReadBody(char *data, size_t count);
 
index c9cdf5a3c96a75fe4a1afad7abf16d38a4f9dac9..e54653f22b361f9d744b83be67a7d4740165c34c 100644 (file)
 #include "remote/apifunction.hpp"
 #include "remote/jsonrpc.hpp"
 #include "base/base64.hpp"
+#include "base/convert.hpp"
 #include "base/configtype.hpp"
+#include "base/exception.hpp"
+#include "base/logger.hpp"
 #include "base/objectlock.hpp"
+#include "base/timer.hpp"
 #include "base/utility.hpp"
-#include "base/logger.hpp"
-#include "base/exception.hpp"
-#include "base/convert.hpp"
 #include <boost/thread/once.hpp>
 
 using namespace icinga;
@@ -101,7 +102,7 @@ bool HttpServerConnection::ProcessMessage()
 
        if (!m_CurrentRequest.CompleteHeaders) {
                try {
-                       res = m_CurrentRequest.ParseHeader(m_Context, false);
+                       res = m_CurrentRequest.ParseHeaders(m_Context, false);
                } catch (const std::invalid_argument& ex) {
                        response.SetStatus(400, "Bad Request");
                        String msg = String("<h1>Bad Request</h1><p><pre>") + ex.what() + "</pre></p>";
index 104df75093e3c4c0a32fb096d29cf672d9614d57..5f959b8a01313158c0364db6cd4772953960951f 100644 (file)
@@ -24,7 +24,6 @@
 #include "remote/httpresponse.hpp"
 #include "remote/apiuser.hpp"
 #include "base/tlsstream.hpp"
-#include "base/timer.hpp"
 #include "base/workqueue.hpp"
 
 namespace icinga