Merge pull request #19 from mapswipe/feat/team-edit-input

Author: tnagorra

functions/definition/models.yaml

@@ -542,99 +542,3 @@ FbMappingResult:
           # NOTE: The key is usergroupId
           type: map
           valueType: boolean
-
-# USER AND USER GROUP
-
-FbUserGroup:
-  model: alias
-  # path: userGroups/{userGroupId}
-  docs: Represents a usergroup
-  type:
-    type: object
-    fields:
-      # TODO: this is an enum
-      createdAt:
-        type: int
-      createdBy:
-        type: string
-      description:
-        type: string
-      name:
-        type: string
-      # NOTE: We can remove this @deprecated
-      nameKey:
-        type: string
-      users:
-        type:
-          type: map
-          valueType: unknown
-
-FbUserGroupObsolete:
-  model: alias
-  # path: user_groups/{userGroupId}
-  docs: Represents a usergroup
-  type:
-    type: object
-    fields:
-      name:
-        type: string
-      description:
-        type: string
-
-FbUserGroupMembership:
-  model: alias
-  # path: userGroupMembershipLogs/{userGroupId}
-  docs: Represents a user contribution
-  type:
-    type: object
-    fields:
-      action:
-        type: FbEnumUserGroupMembershipAction
-      timestamp:
-        type: timestamp
-      userGroupId:
-        type: string
-      userId:
-        type: string
-
-FbUser:
-  model: alias
-  # path: users/{userId}
-  docs: Represents a user
-  type:
-    type: object
-    fields:
-      created:
-        type: timestamp
-      userName:
-        type: string
-      # NOTE: We can remove this @deprecated
-      userNameKey:
-        type: string
-      username:
-        type: string
-      # NOTE: We can remove this @deprecated
-      usernameKey:
-        type: string
-      accessibility:
-        optional: true
-        type: boolean
-      userGroups:
-        optional: true
-        type:
-          type: map
-          valueType: unknown
-
-FbUserContribution:
-  model: alias
-  # path: userContributions/{userId}/{projectId}/{groupId}
-  docs: Represents a user contribution
-  type:
-    type: object
-    fields:
-      endTime:
-        type: timestamp
-      startTime:
-        type: timestamp
-      timestamp:
-        type: timestamp

functions/definition/user.yaml

@@ -0,0 +1,37 @@
+FbUserReadonlyType:
+  model: alias
+  docs: Represents user fields that cannot be updated from backend
+  type:
+    type: object
+    fields:
+      created:
+        type: timestamp
+      userName:
+        type: string
+      # NOTE: We can remove this @deprecated
+      userNameKey:
+        type: string
+      username:
+        type: string
+      # NOTE: We can remove this @deprecated
+      usernameKey:
+        type: string
+      accessibility:
+        optional: true
+        type: boolean
+      userGroups:
+        optional: true
+        type:
+          type: map
+          valueType: unknown
+
+FbUserUpdateInput:
+  model: alias
+  # path: users/{userId}
+  docs: Represents a user
+  type:
+    type: object
+    fields:
+      teamId:
+        type: string
+        optional: true

functions/definition/userContribution.yaml

@@ -0,0 +1,13 @@
+FbUserContribution:
+  model: alias
+  # path: userContributions/{userId}/{projectId}/{groupId}
+  docs: Represents a user contribution
+  type:
+    type: object
+    fields:
+      endTime:
+        type: timestamp
+      startTime:
+        type: timestamp
+      timestamp:
+        type: timestamp

functions/definition/userGroup.yaml

@@ -0,0 +1,51 @@
+FbUserGroup:
+  model: alias
+  # path: userGroups/{userGroupId}
+  docs: Represents a usergroup
+  type:
+    type: object
+    fields:
+      # TODO: this is an enum
+      createdAt:
+        type: int
+      createdBy:
+        type: string
+      description:
+        type: string
+      name:
+        type: string
+      # NOTE: We can remove this @deprecated
+      nameKey:
+        type: string
+      users:
+        type:
+          type: map
+          valueType: unknown
+
+FbUserGroupObsolete:
+  model: alias
+  # path: user_groups/{userGroupId}
+  docs: Represents a usergroup
+  type:
+    type: object
+    fields:
+      name:
+        type: string
+      description:
+        type: string
+
+FbUserGroupMembership:
+  model: alias
+  # path: userGroupMembershipLogs/{userGroupId}
+  docs: Represents a user contribution
+  type:
+    type: object
+    fields:
+      action:
+        type: FbEnumUserGroupMembershipAction
+      timestamp:
+        type: timestamp
+      userGroupId:
+        type: string
+      userId:
+        type: string

functions/generated/pyfirebase/pyfirebase_mapswipe/extended_models.py

@@ -14,7 +14,9 @@ class FbProject(
     class Config:  # type: ignore[reportIncompatibleVariableOverride]
         use_enum_values = True
         frozen = True
-        extra = "forbid"
+        # NOTE: We need to allow extra fields as FbProject
+        # is not a complete project representation
+        extra = "allow"
 
 
 class FbMappingGroup(
@@ -25,3 +27,13 @@ class Config:  # type: ignore[reportIncompatibleVariableOverride]
         use_enum_values = True
         frozen = True
         extra = "forbid"
+
+
+class FbUser(
+    models.FbUserUpdateInput,
+    models.FbUserReadonlyType,
+):
+    class Config:  # type: ignore[reportIncompatibleVariableOverride]
+        use_enum_values = True
+        frozen = True
+        extra = "forbid"