Merge "swagger-ize testcase-apis of testAPI"

[releng.git] / utils / test / result_collection_api / resources / pod_models.py

diff --git a/utils/test/result_collection_api/resources/pod_models.py b/utils/test/result_collection_api/resources/pod_models.py
index 65b82f7..cc98c90 100644 (file)
--- a/utils/test/result_collection_api/resources/pod_models.py
+++ b/utils/test/result_collection_api/resources/pod_models.py
@@ -1,24 +1,36 @@
+from tornado_swagger_ui.tornado_swagger import swagger
+
 __author__ = '__serena__'
 
+# name: name of the POD e.g. zte-1
+# mode: metal or virtual
+# details: any detail
+# role: ci-pod or community-pod or single-node
+
 
+@swagger.model()
 class PodCreateRequest(object):
-    def __init__(self, name='', mode='', details=''):
+    def __init__(self, name, mode='', details='', role=""):
         self.name = name
         self.mode = mode
         self.details = details
+        self.role = role
 
     def format(self):
         return {
             "name": self.name,
             "mode": self.mode,
             "details": self.details,
+            "role": self.role,
         }
 
 
+@swagger.model()
 class Pod(PodCreateRequest):
-    """ describes a POD platform """
-    def __init__(self, name='', mode='', details='', _id='', create_date=''):
-        super(Pod, self).__init__(name, mode, details)
+    def __init__(self,
+                 name='', mode='', details='',
+                 role="", _id='', create_date=''):
+        super(Pod, self).__init__(name, mode, details, role)
         self._id = _id
         self.creation_date = create_date
 
@@ -33,6 +45,7 @@ class Pod(PodCreateRequest):
         p.name = pod_dict.get('name')
         p.mode = pod_dict.get('mode')
         p.details = pod_dict.get('details')
+        p.role = pod_dict.get('role')
         return p
 
     def format(self):
@@ -46,7 +59,11 @@ class Pod(PodCreateRequest):
         return f
 
 
+@swagger.model()
 class Pods(object):
+    """
+        @ptype pods: C{list} of L{Pod}
+    """
     def __init__(self, pods=list()):
         self.pods = pods