Add Public security definition to Swagger (#447) (#454)

* Add Public security definition to Swagger (#447)

Add Public security definition to Swagger settings as described in #446

* Formatting

* flake8

Co-authored-by: Milan Jaroš <milan.jaros@gmail.com>

api/app/settings/common.py

@@ -319,10 +319,22 @@
 SWAGGER_SETTINGS = {
     "SHOW_REQUEST_HEADERS": True,
     "SECURITY_DEFINITIONS": {
-        "api_key": {"type": "apiKey", "in": "header", "name": "Authorization"}
+        "Private": {
+            "type": "apiKey",
+            "in": "header",
+            "name": "Authorization",
+            "description": "Every time you create a new Project Environment, an environment API key is automatically generated for you. This is all you need to pass in to get access to Flags etc. <br />Example value: <br />Token 884b1b4c6b4ddd112e7a0a139f09eb85e8c254ff",  # noqa
+        },
+        "Public": {
+            "type": "apiKey",
+            "in": "header",
+            "name": "X-Environment-Key",
+            "description": "Things like creating new flags, environments, toggle flags or indeed anything that is possible from the administrative front end. <br />Example value: <br />FFnVjhp7xvkT5oTLq4q788",  # noqa
+        },
     },
 }
 
+
 LOGIN_URL = "/admin/login/"
 LOGOUT_URL = "/admin/logout/"