hawkBit rest docs (management & DDI API) (#688)

* hawkBit REST docs.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Fiy gitignore.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Add to website.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Switch to generated docs.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Fix typos.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Review findings.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Otimizations.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Revert accidental checkin.

Signed-off-by: kaizimmerm <kai.zimmermann@bosch-si.com>

* Add security link.

hawkbit-rest/hawkbit-rest-docs/src/main/errors/400.adoc

@@ -0,0 +1,3 @@
+| `400 Bad Request`
+| Bad Request - e.g. invalid parameters
+|

hawkbit-rest/hawkbit-rest-docs/src/main/errors/401.adoc

@@ -0,0 +1,3 @@
+| `401 Unauthorized`
+| The request requires user authentication.
+| 

hawkbit-rest/hawkbit-rest-docs/src/main/errors/403.adoc

@@ -0,0 +1,3 @@
+| `403 Forbidden`
+| Insufficient permissions, entity is not allowed to be changed (i.e. read-only) or data volume restriction applies.
+| See <<error-body>>

hawkbit-rest/hawkbit-rest-docs/src/main/errors/403_quota.adoc

@@ -0,0 +1,3 @@
+| `403 Forbidden`
+| Insufficient permissions, data volume restriction applies or quota limit exceeded.
+| See <<error-body>>

hawkbit-rest/hawkbit-rest-docs/src/main/errors/404.adoc

@@ -0,0 +1,3 @@
+| `404 Not Found`
+| Not Found Target.
+| See <<error-body>>

hawkbit-rest/hawkbit-rest-docs/src/main/errors/405.adoc

@@ -0,0 +1,3 @@
+| `405 Method Not Allowed`
+| The http request method is not allowed on the resource. 
+|

hawkbit-rest/hawkbit-rest-docs/src/main/errors/406.adoc

@@ -0,0 +1,3 @@
+| `406 Not Acceptable`
+|  In case accept header is specified and not application/json.
+|

hawkbit-rest/hawkbit-rest-docs/src/main/errors/409.adoc

@@ -0,0 +1,3 @@
+| `409 Conflict`
+| E.g. in case an entity is created or modified by another user in another request at the same time. You may retry your modification request.  
+| See <<error-body>>

hawkbit-rest/hawkbit-rest-docs/src/main/errors/415.adoc

@@ -0,0 +1,3 @@
+| `415 Unsupported Media Type`
+| The request was attempt with a media-type which is not supported by the server for this resource.
+|

hawkbit-rest/hawkbit-rest-docs/src/main/errors/429.adoc

@@ -0,0 +1,3 @@
+| `429 Too Many Request`
+| Too many requests. The server will refuse further attempts and the client has to wait another second.
+|

hawkbit-rest/hawkbit-rest-docs/src/main/errors/error-response-body.adoc

@@ -0,0 +1,27 @@
+[source,http]
+----
+
+{
+  "errorCode": "string",
+  "exceptionClass": "string",
+  "message": "string",
+  "parameters": [
+    "string"
+  ]
+}
+
+----
+
+=== Field description
+
+|=== 
+|**Field** |**Description** 
+| errorCode
+| A error code/key set by server
+| exceptionClass
+| The involved exceptionClass
+| message
+| An error message set by the server
+| parameters
+| A list of parameters
+|===