]> granicus.if.org Git - icinga2/commitdiff
Minor codestyle and doc changes
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>
Fri, 23 Feb 2018 09:09:28 +0000 (10:09 +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 acebac6e1ca5c5d3fbfa9243146f5ae4fde6cb3d..b2e61765b996ec4653c1a8ebdd0c3c5473d45324 100644 (file)
@@ -201,13 +201,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
@@ -227,8 +226,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 953b2b8f0ddd0a0ad5b8ad18bfeba8a98eb28850..1fda60382cbae6a85bde5880787107635f63ee1c 100644 (file)
@@ -29,7 +29,6 @@
 #endif /* _WIN32 */
 
 #define TLS_TIMEOUT_SECONDS 10
-#define TLS_TIMEOUT_STEP_SECONDS 1
 
 using namespace icinga;
 
index a55e12638dbdb047de5437512123c11f005735f5..9e8f36c27068b30b57508d0d0ccc3c51779ddffd 100644 (file)
@@ -38,7 +38,7 @@ HttpRequest::HttpRequest(const 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 af7ebfbaa7d793b88ef3822f04853ca19670f54e..a17732f4ab245851b9692b2c779b40c35f67f2e4 100644 (file)
@@ -64,7 +64,7 @@ public:
 
        HttpRequest(const 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 ae284df34204fff6f024ca0fead260a61ce4a797..1c236ed5ab8b59e51cd478b3ab01906ff8d018d4 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(void)
 
        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 22b036c2fcd4c9e14ed8e8c43f1e4b5bc41a92d5..3d9b04e2c202f511362df4b393818cb253ca5bf5 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