STAR-322: Adding documentation and fixing model types

plugins/UM3NetworkPrinting/src/Cloud/Models/CloudErrorObject.py

@@ -1,17 +1,28 @@
 # Copyright (c) 2018 Ultimaker B.V.
 # Cura is released under the terms of the LGPLv3 or higher.
-from typing import Dict
+from typing import Dict, Optional
 
 from .BaseCloudModel import BaseCloudModel
 
 
-## Class representing errors generated by the cloud servers, according to the json-api standard.
+## Class representing errors generated by the cloud servers, according to the JSON-API standard.
+#  Spec: https://api-staging.ultimaker.com/connect/v1/spec
 class CloudErrorObject(BaseCloudModel):
-    def __init__(self, **kwargs) -> None:
-        self.id = None  # type: str
-        self.code = None  # type: str
-        self.http_status = None  # type: str
-        self.title = None  # type: str
-        self.detail = None  # type: str
-        self.meta = None  # type: Dict[str, any]
+    ## Creates a new error object.
+    #  \param id: Unique identifier for this particular occurrence of the problem.
+    #  \param title: A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence
+    #       of the problem, except for purposes of localization.
+    #  \param code: An application-specific error code, expressed as a string value.
+    #  \param detail: A human-readable explanation specific to this occurrence of the problem. Like title, this field's
+    #       value can be localized.
+    #  \param http_status: The HTTP status code applicable to this problem, converted to string.
+    #  \param meta: Non-standard meta-information about the error, depending on the error code.
+    def __init__(self, id: str, code: str, title: str, http_status: str, detail: Optional[str] = None,
+                 meta: Optional[Dict[str, any]] = None, **kwargs) -> None:
+        self.id = id
+        self.code = code
+        self.http_status = http_status
+        self.title = title
+        self.detail = detail
+        self.meta = meta
         super().__init__(**kwargs)