fix:bug: Close #107 Allow removing id by specifying null

Author: EliuX

time_tracker_api/activities/activities_namespace.py

@@ -1,13 +1,13 @@
 from faker import Faker
-from flask_restplus import fields, Resource, Namespace
+from flask_restplus import fields, Resource
 from flask_restplus._http import HTTPStatus
 
 from time_tracker_api.activities.activities_model import create_dao
-from time_tracker_api.api import common_fields
+from time_tracker_api.api import common_fields, api
 
 faker = Faker()
 
-ns = Namespace('activities', description='API for activities')
+ns = api.namespace('activities', description='Namespace of the API for activities')
 
 # Activity Model
 activity_input = ns.model('ActivityInput', {

time_tracker_api/api.py

@@ -38,30 +38,37 @@ def create_attributes_filter(ns: namespace, model: Model, filter_attrib_names: l
     return attribs_parser
 
 
-# Common models structure
+# Custom fields
+class NullableString(fields.String):
+    __schema_type__ = ['string', 'null']
+
+
+class UUID(NullableString):
+    def __init__(self, *args, **kwargs):
+        super(UUID, self).__init__(*args, **kwargs)
+        self.pattern = UUID_REGEX
+
+
 common_fields = {
-    'id': fields.String(
+    'id': UUID(
         title='Identifier',
         readOnly=True,
         required=True,
         description='The unique identifier',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
-    'tenant_id': fields.String(
+    'tenant_id': UUID(
         title='Identifier of Tenant',
         readOnly=True,
         required=True,
         description='Tenant it belongs to',
-        # pattern=UUID_REGEX, This must be confirmed
         example=faker.uuid4(),
     ),
-    'deleted': fields.String(
+    'deleted': UUID(
         readOnly=True,
         required=True,
         title='Last event Identifier',
         description='Last event over this resource',
-        pattern=UUID_REGEX,
     ),
 }
 

time_tracker_api/customers/customers_namespace.py

@@ -1,13 +1,13 @@
 from faker import Faker
-from flask_restplus import Namespace, Resource, fields
+from flask_restplus import Resource, fields
 from flask_restplus._http import HTTPStatus
 
-from time_tracker_api.api import common_fields
+from time_tracker_api.api import common_fields, api
 from time_tracker_api.customers.customers_model import create_dao
 
 faker = Faker()
 
-ns = Namespace('customers', description='API for customers')
+ns = api.namespace('customers', description='Namespace of the API for customers')
 
 # Customer Model
 customer_input = ns.model('CustomerInput', {

time_tracker_api/project_types/project_types_namespace.py

@@ -1,14 +1,13 @@
 from faker import Faker
-from flask_restplus import Namespace, Resource, fields
+from flask_restplus import Resource, fields
 from flask_restplus._http import HTTPStatus
 
-from time_tracker_api.api import common_fields, create_attributes_filter
+from time_tracker_api.api import common_fields, create_attributes_filter, api, UUID
 from time_tracker_api.project_types.project_types_model import create_dao
-from time_tracker_api.security import UUID_REGEX
 
 faker = Faker()
 
-ns = Namespace('project-types', description='API for project types')
+ns = api.namespace('project-types', description='Namespace of the API for project types')
 
 # ProjectType Model
 project_type_input = ns.model('ProjectTypeInput', {
@@ -26,19 +25,17 @@
         description='Comments about the project type',
         example=faker.paragraph(),
     ),
-    'customer_id': fields.String(
+    'customer_id': UUID(
         title='Identifier of the Customer',
         required=False,
         description='Customer this project type belongs to. '
                     'If not specified, it will be considered an internal project of the tenant.',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
-    'parent_id': fields.String(
+    'parent_id': UUID(
         title='Identifier of the parent project type',
         required=False,
         description='This parent node allows to created a tree-like structure for project types',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
 })

time_tracker_api/projects/projects_namespace.py

@@ -1,14 +1,13 @@
 from faker import Faker
-from flask_restplus import Namespace, Resource, fields
+from flask_restplus import Resource, fields
 from flask_restplus._http import HTTPStatus
 
-from time_tracker_api.api import common_fields, create_attributes_filter
+from time_tracker_api.api import common_fields, create_attributes_filter, UUID, api
 from time_tracker_api.projects.projects_model import create_dao
-from time_tracker_api.security import UUID_REGEX
 
 faker = Faker()
 
-ns = Namespace('projects', description='API for projects (clients)')
+ns = api.namespace('projects', description='Namespace of the API for projects')
 
 # Project Model
 project_input = ns.model('ProjectInput', {
@@ -26,19 +25,17 @@
         description='Description about the project',
         example=faker.paragraph(),
     ),
-    'customer_id': fields.String(
+    'customer_id': UUID(
         title='Identifier of the Customer',
         required=False,
         description='Customer this project type belongs to. '
                     'If not specified, it will be considered an internal project of the tenant.',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
-    'project_type_id': fields.String(
+    'project_type_id': UUID(
         title='Identifier of the project type',
         required=False,
         description='Id of the project type it belongs. This allows grouping the projects.',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
 })

time_tracker_api/time_entries/time_entries_namespace.py

@@ -1,26 +1,24 @@
 from datetime import timedelta
 
 from faker import Faker
-from flask_restplus import fields, Resource, Namespace
+from flask_restplus import fields, Resource
 from flask_restplus._http import HTTPStatus
 
 from commons.data_access_layer.cosmos_db import current_datetime, datetime_str, current_datetime_str
 from commons.data_access_layer.database import COMMENTS_MAX_LENGTH
-from time_tracker_api.api import common_fields, create_attributes_filter
-from time_tracker_api.security import UUID_REGEX
+from time_tracker_api.api import common_fields, create_attributes_filter, api, UUID
 from time_tracker_api.time_entries.time_entries_model import create_dao
 
 faker = Faker()
 
-ns = Namespace('time-entries', description='API for time entries')
+ns = api.namespace('time-entries', description='Namespace of the API for time entries')
 
 # TimeEntry Model
 time_entry_input = ns.model('TimeEntryInput', {
-    'project_id': fields.String(
+    'project_id': UUID(
         title='Project',
         required=True,
         description='The id of the selected project',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
     'start_date': fields.DateTime(
@@ -30,11 +28,10 @@
         description='When the user started doing this activity',
         example=datetime_str(current_datetime() - timedelta(days=1)),
     ),
-    'activity_id': fields.String(
+    'activity_id': UUID(
         title='Activity',
         required=False,
         description='The id of the selected activity',
-        pattern=UUID_REGEX,
         example=faker.uuid4(),
     ),
     'description': fields.String(
@@ -86,7 +83,7 @@
         description='Whether this time entry is currently running or not',
         example=faker.boolean(),
     ),
-    'owner_id': fields.String(
+    'owner_id': UUID(
         required=True,
         readOnly=True,
         title='Owner of time entry',