fix: Close #85 #86 Ignore deleted objects and tweak ns constraints

Author: EliuX

time_tracker_api/activities/activities_model.py

@@ -15,7 +15,7 @@ class ActivityDao(CRUDDao):
     'partition_key': PartitionKey(path='/tenant_id'),
     'unique_key_policy': {
         'uniqueKeys': [
-            {'paths': ['/name']},
+            {'paths': ['/name', '/deleted']},
         ]
     }
 }

time_tracker_api/activities/activities_namespace.py

@@ -20,26 +20,13 @@
     ),
     'description': fields.String(
         title='Description',
+        required=False,
         description='Comments about the activity',
         example=faker.paragraph(),
     )
 })
 
-activity_response_fields = {
-    'id': fields.String(
-        readOnly=True,
-        required=True,
-        title='Identifier',
-        description='The unique identifier',
-        example=faker.uuid4(),
-    ),
-    'tenant_id': fields.String(
-        required=True,
-        title='Identifier of Tenant',
-        description='Tenant this activity belongs to',
-        example=faker.uuid4(),
-    ),
-}
+activity_response_fields = {}
 activity_response_fields.update(common_fields)
 
 activity = ns.inherit(

time_tracker_api/api.py

@@ -17,6 +17,20 @@
 
 # Common models structure
 common_fields = {
+    'id': fields.String(
+        title='Identifier',
+        readOnly=True,
+        required=True,
+        description='The unique identifier',
+        example=faker.uuid4(),
+    ),
+    'tenant_id': fields.String(
+        title='Identifier of Tenant',
+        readOnly=True,
+        required=True,
+        description='Tenant it belongs to',
+        example=faker.uuid4(),
+    ),
     'deleted': fields.String(
         readOnly=True,
         required=True,

time_tracker_api/customers/customers_model.py

@@ -15,7 +15,7 @@ class CustomerDao(CRUDDao):
     'partition_key': PartitionKey(path='/tenant_id'),
     'unique_key_policy': {
         'uniqueKeys': [
-            {'paths': ['/name']},
+            {'paths': ['/name', '/deleted']},
         ]
     }
 }

time_tracker_api/customers/customers_namespace.py

@@ -12,35 +12,22 @@
 # Customer Model
 customer_input = ns.model('CustomerInput', {
     'name': fields.String(
-        required=True,
         title='Name',
+        required=True,
         max_length=50,
         description='Name of the customer',
         example=faker.company(),
     ),
     'description': fields.String(
         title='Description',
+        required=False,
         max_length=250,
         description='Description about the customer',
         example=faker.paragraph(),
     ),
 })
 
-customer_response_fields = {
-    'id': fields.String(
-        readOnly=True,
-        required=True,
-        title='Identifier',
-        description='The unique identifier',
-        example=faker.uuid4(),
-    ),
-    'tenant_id': fields.String(
-        required=True,
-        title='Identifier of Tenant',
-        description='Tenant this customer belongs to',
-        example=faker.uuid4(),
-    ),
-}
+customer_response_fields = {}
 customer_response_fields.update(common_fields)
 
 customer = ns.inherit(

time_tracker_api/project_types/project_types_model.py

@@ -15,7 +15,7 @@ class ProjectTypeDao(CRUDDao):
     'partition_key': PartitionKey(path='/tenant_id'),
     'unique_key_policy': {
         'uniqueKeys': [
-            {'paths': ['/name', '/customer_id']},
+            {'paths': ['/name', '/customer_id', '/deleted']},
         ]
     }
 }

time_tracker_api/project_types/project_types_namespace.py

@@ -12,45 +12,35 @@
 # ProjectType Model
 project_type_input = ns.model('ProjectTypeInput', {
     'name': fields.String(
-        required=True,
         title='Name',
+        required=True,
         max_length=50,
         description='Name of the project type',
         example=faker.random_element(["Customer","Training","Internal"]),
     ),
     'description': fields.String(
         title='Description',
+        required=False,
         max_length=250,
-        description='Description about the project type',
+        description='Comments about the project type',
         example=faker.paragraph(),
     ),
     'customer_id': fields.String(
         title='Identifier of the Customer',
-        description='Customer this project type belongs to',
+        required=False,
+        description='Customer this project type belongs to. '
+                    'If not specified, it will be considered an internal project of the tenant.',
         example=faker.uuid4(),
     ),
     'parent_id': fields.String(
-        title='Identifier of Parent of the project type',
-        description='Defines a self reference of the model ProjectType',
+        title='Identifier of the parent project type',
+        required=False,
+        description='This parent node allows to created a tree-like structure for project types',
         example=faker.uuid4(),
     ),
 })
 
-project_type_response_fields = {
-    'id': fields.String(
-        readOnly=True,
-        required=True,
-        title='Identifier',
-        description='The unique identifier',
-        example=faker.uuid4(),
-    ),
-    'tenant_id': fields.String(
-        required=True,
-        title='Identifier of Tenant',
-        description='Tenant this project type belongs to',
-        example=faker.uuid4(),
-    ),
-}
+project_type_response_fields = {}
 project_type_response_fields.update(common_fields)
 
 project_type = ns.inherit(

time_tracker_api/projects/projects_model.py

@@ -15,7 +15,7 @@ class ProjectDao(CRUDDao):
     'partition_key': PartitionKey(path='/tenant_id'),
     'unique_key_policy': {
         'uniqueKeys': [
-            {'paths': ['/name', '/customer_id']},
+            {'paths': ['/name', '/customer_id', '/deleted']},
         ]
     }
 }

time_tracker_api/projects/projects_namespace.py

@@ -20,38 +20,27 @@
     ),
     'description': fields.String(
         title='Description',
+        required=False,
         max_length=250,
         description='Description about the project',
         example=faker.paragraph(),
     ),
     'customer_id': fields.String(
-        required=True,
         title='Identifier of the Customer',
-        description='Customer this project belongs to',
-        example=faker.uuid4(),
-    ),
-    'project_type_id': fields.String(
-        title='Identifier of Project type',
-        description='Type of the project. Used for grouping',
-        example=faker.uuid4(),
-    )
-})
-
-project_response_fields = {
-    'id': fields.String(
-        readOnly=True,
-        required=True,
-        title='Identifier',
-        description='The unique identifier',
+        required=False,
+        description='Customer this project type belongs to. '
+                    'If not specified, it will be considered an internal project of the tenant.',
         example=faker.uuid4(),
     ),
-    'tenant_id': fields.String(
+    'parent_id': fields.String(
+        title='Identifier of the parent project type',
         required=False,
-        title='Identifier of Tenant',
-        description='Tenant this project belongs to',
+        description='This parent node allows to created a tree-like structure for projects',
         example=faker.uuid4(),
     ),
-}
+})
+
+project_response_fields = {}
 project_response_fields.update(common_fields)
 
 project = ns.inherit(

time_tracker_api/time_entries/time_entries_namespace.py

@@ -50,7 +50,9 @@
     ),
     'uri': fields.String(
         title='Uniform Resource identifier',
-        description='Either identifier or locator',
+        description='Either identifier or locator of a resource in the Internet that helps to understand'
+                    ' what this time entry was about. For example, A Jira ticket, a Github issue, a Google document.',
+        required=False,
         example=faker.random_element([
             'https://github.com/ioet/time-tracker-backend/issues/51',
             '#54',
@@ -75,25 +77,12 @@
 })
 
 time_entry_response_fields = {
-    'id': fields.String(
-        readOnly=True,
-        title='Identifier',
-        description='The unique identifier',
-        example=faker.uuid4(),
-    ),
     'running': fields.Boolean(
         readOnly=True,
         title='Is it running?',
         description='Whether this time entry is currently running or not',
         example=faker.boolean(),
     ),
-    'tenant_id': fields.String(
-        required=True,
-        readOnly=True,
-        title='Identifier of Tenant',
-        description='Tenant this project belongs to',
-        example=faker.uuid4(),
-    ),
     'owner_id': fields.String(
         required=True,
         readOnly=True,