fix "Swagger issue for endpoints register & update" (#233)

* fix: Change on the inheritance model, according to the documentation for the request body parameters. #171

* fix: Changes on the documentation examples to fix the inheritance problem when passing the User class (for create or update only passing the pydantic one) #171

* fix: Changes on the documentation examples to fix the inheritance problem when passing the User class (for create or update only passing the pydantic one) #171

* Put back inheritance on update model and factorize create_update_dict methods

Co-authored-by: François Voron <fvoron@gmail.com>

docs/configuration/model.md

@@ -12,7 +12,7 @@
 There are four Pydantic models variations provided as mixins:
 
 * `BaseUser`, which provides the basic fields and validation ;
-* `BaseCreateUser`, dedicated to user registration, which makes the `email` compulsory and adds a compulsory `password` field ;
+* `BaseCreateUser`, dedicated to user registration, which consists of compulsory `email` and `password` fields ;
 * `BaseUpdateUser`, dedicated to user profile update, which adds an optional `password` field ;
 * `BaseUserDB`, which is a representation of the user in database, adding a `hashed_password` field.
 
@@ -26,7 +26,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/configuration/oauth.md

@@ -42,7 +42,7 @@ class User(models.BaseUser, models.BaseOAuthAccountMixin):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/db_mongodb.py

@@ -8,7 +8,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/db_sqlalchemy.py

@@ -10,7 +10,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/db_tortoise.py

@@ -8,7 +8,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/full_mongodb.py

@@ -12,7 +12,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/full_sqlalchemy.py

@@ -14,7 +14,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/full_tortoise.py

@@ -12,7 +12,7 @@ class User(models.BaseUser):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/oauth_full_mongodb.py

@@ -16,7 +16,7 @@ class User(models.BaseUser, models.BaseOAuthAccountMixin):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/oauth_full_sqlalchemy.py

@@ -22,7 +22,7 @@ class User(models.BaseUser, models.BaseOAuthAccountMixin):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

docs/src/oauth_full_tortoise.py

@@ -21,7 +21,7 @@ class User(models.BaseUser, models.BaseOAuthAccountMixin):
     pass
 
 
-class UserCreate(User, models.BaseUserCreate):
+class UserCreate(models.BaseUserCreate):
     pass
 
 

fastapi_users/models.py

@@ -4,7 +4,18 @@ from typing import List, Optional, TypeVar
 from pydantic import UUID4, BaseModel, EmailStr, validator
 
 
-class BaseUser(BaseModel):
+class CreateUpdateDictModel(BaseModel):
+    def create_update_dict(self):
+        return self.dict(
+            exclude_unset=True,
+            exclude={"id", "is_superuser", "is_active", "oauth_accounts"},
+        )
+
+    def create_update_dict_superuser(self):
+        return self.dict(exclude_unset=True, exclude={"id"})
+
+
+class BaseUser(CreateUpdateDictModel):
     """Base User model."""
 
     id: Optional[UUID4] = None
@@ -16,17 +27,8 @@ class BaseUser(BaseModel):
     def default_id(cls, v):
         return v or uuid.uuid4()
 
-    def create_update_dict(self):
-        return self.dict(
-            exclude_unset=True,
-            exclude={"id", "is_superuser", "is_active", "oauth_accounts"},
-        )
 
-    def create_update_dict_superuser(self):
-        return self.dict(exclude_unset=True, exclude={"id"})
-
-
-class BaseUserCreate(BaseUser):
+class BaseUserCreate(CreateUpdateDictModel):
     email: EmailStr
     password: str