Add env variables doc

quantmind · Feb 9, 2020 · 06c6fcf · 06c6fcf
1 parent f8bf848
commit 06c6fcf
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/docs/env.rst b/docs/env.rst
@@ -0,0 +1,18 @@
+.. _aio-openapi-env:
+
+
+======================
+ Environment Variables
+======================
+
+Several environment variables can be configured at application level
+
+* **BAD_DATA_MESSAGE** (Invalid data format), message displayed when data is not in valid format (not JSON for example)
+* **ERROR_500_MESSSAGE** (Internal Server Error), message displayed when things go wrong
+* **DBPOOL_MIN_SIZE** (10), minimum number of connection in postgres connection pool
+* **DBPOOL_MAX_SIZE** (10), maximum number of connections in postgres connection pool
+* **MICRO_SERVICE_PORT** (8080), default port when running the `serve` command
+* **MICRO_SERVICE_HOST** (0.0.0.0), default host when running the `serve` command
+* **MAX_PAGINATION_LIMIT** (100), maximum number of objects displayed at once
+* **DEF_PAGINATION_LIMIT** (50), default value of pagination
+* **SPEC_ROUTE** (/spec), path of OpenAPI spec doc (JSON)
diff --git a/docs/index.rst b/docs/index.rst
@@ -145,6 +145,7 @@ Contents
    :maxdepth: 2
 
    reference
+   env
    glossary