Adding built-in plugin descriptigons.

alexdlaird · Sep 20, 2020 · 31eb00e · 31eb00e
1 parent a1b4c7b
commit 31eb00e
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 1 deletion.
diff --git a/hookee/plugins/blueprint_default.py b/hookee/plugins/blueprint_default.py
@@ -8,8 +8,10 @@
 __version__ = "1.2.2"
 
 blueprint = Blueprint("default", __name__)
-
 plugin_type = BLUEPRINT_PLUGIN
+description = "Mount required management endpoints along with the default `/webhook` endpoint that processes incoming " \
+              "requests with enabled plugins."
+
 plugin_manager = None  # type: PluginManager
 print_util = None  # type: PrintUtil
 

diff --git a/hookee/plugins/request_body.py b/hookee/plugins/request_body.py
@@ -6,6 +6,8 @@
 __version__ = "1.2.2"
 
 plugin_type = REQUEST_PLUGIN
+description = "Print the `request`'s body, if defined, and attempt to identify the body type."
+
 print_util = None  # type: PrintUtil
 
 

diff --git a/hookee/plugins/request_files.py b/hookee/plugins/request_files.py
@@ -6,6 +6,8 @@
 __version__ = "1.2.2"
 
 plugin_type = REQUEST_PLUGIN
+description = "Print the `request`'s files, if defined."
+
 print_util = None  # type: PrintUtil
 
 

diff --git a/hookee/plugins/request_headers.py b/hookee/plugins/request_headers.py
@@ -6,6 +6,8 @@
 __version__ = "1.2.2"
 
 plugin_type = REQUEST_PLUGIN
+description = "Print the `request`'s headers, if defined."
+
 print_util = None  # type: PrintUtil
 
 

diff --git a/hookee/plugins/request_query_params.py b/hookee/plugins/request_query_params.py
@@ -6,6 +6,8 @@
 __version__ = "1.2.2"
 
 plugin_type = REQUEST_PLUGIN
+description = "Print the `request`'s query parameters, if defined."
+
 print_util = None  # type: PrintUtil
 
 

diff --git a/hookee/plugins/request_url_info.py b/hookee/plugins/request_url_info.py
@@ -8,6 +8,8 @@
 __version__ = "1.2.2"
 
 plugin_type = REQUEST_PLUGIN
+description = "Print the timestamp along with the request URL and method being invoked."
+
 print_util = None  # type: PrintUtil
 
 

diff --git a/hookee/plugins/response_echo.py b/hookee/plugins/response_echo.py
@@ -10,6 +10,8 @@
 __version__ = "1.2.2"
 
 plugin_type = RESPONSE_PLUGIN
+description = "If the `response` object has not been initialized, create a response that echo's back the request data."
+
 print_util = None  # type: PrintUtil
 
 

diff --git a/hookee/plugins/response_info.py b/hookee/plugins/response_info.py
@@ -6,6 +6,8 @@
 __version__ = "1.2.2"
 
 plugin_type = RESPONSE_PLUGIN
+description = "Print the `response`'s status code, headers, and body, if defined."
+
 print_util = None  # type: PrintUtil