Merge pull request #45 from OS2iot/feature/Add_Swagger_API_key_docs

added api key docs

Author: augusthjerrild

source/installation-guide/installation-guide.rst

@@ -259,6 +259,10 @@ OS2IoT-backend takes several environment variables as configuration, if these ar
 +-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 | CHIRPSTACK_API_KEY            | The API key (Bearer token) created in Chirpstack.                                                    | :code:`apikey`                                                                          |
 +-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
+| CHIRPSTACK_HOSTNAME           | Hostname for Chirpstack                                                                              | :code:`localhost`                                                                       |
++-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
+| CHIRPSTACK_PORT               | Chirpstack port                                                                                      | :code:`8080`                                                                            |
++-------------------------------+------------------------------------------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
 
 Logs levels
 """""""""""""""

source/internal-interface-design/internal-interface-design.rst

@@ -42,11 +42,12 @@ a new login must be performed as described above.
 Using Swagger with authorization
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-To use Swagger with protected endpoints, you must first login, and then add the JWT to Swagger.
+To use Swagger with protected endpoints you must first login, and provide either a API key or JWT to Swagger. 
 This is done by pressing the "Authorize" button near the top right. 
-To test your login, the ``/api/v1/auth/profile`` endpoint can be called, it will return the contents of the JWT payload, 
-which is explained below.
 
+To test your login with JWT, the ``/api/v1/auth/profile`` endpoint can be called, it will return the contents of the JWT payload.
+
+To test your login with an API-key, the GET ``/api/v1/application`` endpoint can be called. It will return all applications that this API-key gave you permission to.
 
 Authorization (Permissions)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

source/iot-data-handling/iot-data-handling.rst

@@ -67,7 +67,7 @@ OS2IoT supports two kinds of MQTT devices. An MQTT external broker and an MQTT i
 OS2IoT supports two kinds of authorization for MQTT devices: Username/password and certificate.
 
 MQTT external broker
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 When an MQTT external broker is created, the credentials for connecting to the internal MQTT-broker are generated. 
 These consists of a URL, a port and a topic for the device to send data to. 
@@ -77,7 +77,7 @@ When a known MQTT external broker sends data to the topic assigned to it, the me
 If a device attempts to send to a different topic the message will be discarded.
 
 MQTT internal broker
-~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 When an MQTT internal broker is created a connection to the external broker is made using the entered credentials. 
 When a message is received by the external broker on the topic configured, OS2IoT will also receive the message and further process it.