summaryrefslogtreecommitdiff
path: root/doc/source/api.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2015-08-26 17:19:12 +0000
committerDavanum Srinivas <davanum@gmail.com>2015-08-27 06:06:44 -0400
commitea893e8ba417aeb13455acfda30b8337159b8536 (patch)
treeeef50b9ca615b8f7e79d0ec40cbe54cacc41b014 /doc/source/api.rst
parent95b735d1f009c7339a664364a553a866f40f1039 (diff)
downloadoslo-middleware-ea893e8ba417aeb13455acfda30b8337159b8536.tar.gz
Split option discovery function by middleware
Create separate option discovery functions for each piece of middleware, so an application that only uses one piece can include only those options in its sample configuration file. Test the results with some unit tests that simply ensure the functions do not raise exceptions, and by adding configuration options to the documentation for the library, using the new integration of oslo.config with sphinx. Change-Id: I4c777cd70c063441f430c48ab1f9c9cac2c1fc75
Diffstat (limited to 'doc/source/api.rst')
-rw-r--r--doc/source/api.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/source/api.rst b/doc/source/api.rst
index 38cd96c..50ad06d 100644
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@@ -4,3 +4,16 @@
.. automodule:: oslo_middleware
:members:
+
+Configuration Options
+=====================
+
+RequestBodySizeLimiter
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. show-options:: oslo.middleware.sizelimit
+
+SSLMiddleware
+~~~~~~~~~~~~~
+
+.. show-options:: oslo.middleware.ssl