More documentation and revert change from model_dump to model_dump_js…

…on back to model_dump(mode='json') in API.

src/edutap/wallet_google/api.py

@@ -377,7 +377,10 @@ def save_link(
                 obj = GoogleWalletObjectWithClassReferenceMixin.model_validate(obj)
             if isinstance(obj, GoogleWalletObjectWithClassReferenceMixin):
                 payload[name].append(
-                    obj.model_dump_json(
+                    obj.model_dump(
+                        # explicitly set to model_dump(mode="json") instead of model_dump_json due to problems
+                        # reported by jensens
+                        mode="json",
                         exclude_none=True,
                         exclude_unset=True,
                         exclude_defaults=True,
@@ -388,7 +391,14 @@ def save_link(
             # otherwise it must be a registered model
             model = lookup_model_by_plural_name(name)
             obj = _validate_data(model, obj)
-            obj_json = obj.model_dump_json(exclude_none=True)
+            obj_json = obj.model_dump(
+                # explicitly set to model_dump(mode="json") instead of model_dump_json due to problems
+                # reported by jensens
+                mode="json",
+                exclude_none=True,
+                exclude_unset=True,
+                exclude_defaults=True,
+            )
             payload[name].append(obj_json)
     claims = {
         "iat": "",

src/edutap/wallet_google/modelbase.py

@@ -1,3 +1,4 @@
+from .modelcore import GoogleWalletModel
 from .modelcore import GoogleWalletWithIdModel
 from .models.primitives import CallbackOptions
 from .models.primitives import GroupingInfo
@@ -14,13 +15,12 @@
 from .models.primitives.enums import MultipleDevicesAndHoldersAllowedStatus
 from .models.primitives.enums import ViewUnlockRequirement
 from .models.primitives.message import Message
-from pydantic import BaseModel
 from pydantic import Field
 
 
 class GoogleWalletClassModel(GoogleWalletWithIdModel):
     """
-    Base model for all Google Wallet Class models.
+    BaseModel for all Google Wallet Class Models.
     """
 
     # Templating and Visual Data
@@ -30,6 +30,7 @@ class GoogleWalletClassModel(GoogleWalletWithIdModel):
     linksModuleData: LinksModuleData | None = None
     infoModuleData: InfoModuleData | None = Field(
         description="deprecated",
+        deprecated=True,
         exclude=True,
         default=None,
     )
@@ -50,6 +51,7 @@ class GoogleWalletClassModel(GoogleWalletWithIdModel):
     )
     allowMultipleUsersPerObject: bool | None = Field(
         description="deprecated",
+        deprecated=True,
         exclude=True,
         default=None,
     )
@@ -64,6 +66,7 @@ class GoogleWalletClassModel(GoogleWalletWithIdModel):
     # heroImage: Image | None = None
     wordMark: Image | None = Field(
         description="deprecated",
+        deprecated=True,
         exclude=True,
         default=None,
     )
@@ -103,25 +106,25 @@ class GoogleWalletObjectModel(GoogleWalletWithIdModel):
     rotatingBarcode: RotatingBarcode | None = None
 
 
-class GoogleWalletObjectWithClassReferenceMixin(BaseModel):
+class GoogleWalletObjectWithClassReferenceMixin(GoogleWalletModel):
     """
-    Model for all Google Wallet Object with a Class references.
+    Mixin for all Google Wallet Object with a classReferences attribute, that reflects the whole class data.
     """
 
     classReference: GoogleWalletClassModel | None = None
 
 
 class GoogleWalletMessageableMixin:
     """
-    Model for Google Wallet Classes or Objects that can retrieve Messages
+    Mixin for Google Wallet Classes or Objects that can retrieve Messages
     """
 
     messages: list[Message] | None = None
 
 
 class GoogleWalletStyleableClassMixin:
     """
-    Model for Google Wallet Classes that can be styled
+    Mixin for Google Wallet Classes that can be styled.
     """
 
     # Design Options
@@ -133,7 +136,10 @@ class GoogleWalletStyleableClassMixin:
 
 class GoogleWalletStyleableObjectMixin:
     """
-    Model for Google Wallet Objects that can be styled
+    Mixin for Google Wallet Objects that can be styled.
+
+    TODO: Check if really all Objects that can be styled have all four attributes and also with this name.
+          Potential Override necessary for programLogo, ...
     """
 
     # Design Options

src/edutap/wallet_google/modelcore.py

@@ -5,7 +5,10 @@
 
 class GoogleWalletModel(BaseModel):
     """
-    Base model for all Google Wallet models.
+    Base Model for all Google Wallet Models.
+
+    Sets a model_config for all Google Wallet Models that enforce that all attributes must be explicitly modeled, and trying to set an unknown attribute would raise an Exception.
+    This Follows the Zen of Python (PEP 20) --> Explicit is better than implicit.
     """
 
     model_config = ConfigDict(
@@ -17,16 +20,21 @@ class GoogleWalletModel(BaseModel):
 
 class GoogleWalletWithKindMixin(GoogleWalletModel):
     """
-    Base model for Google Wallet models with an deprecated kind identifier.
+    Mixin Class for Google Wallet Models with an deprecated kind identifier.
+    Explicit kind value should be provided by the inheriting concret class.
     """
 
-    kind: str | None = Field(description="deprecated", exclude=True, default=None)
+    kind: str | None = Field(
+        description="deprecated",
+        deprecated=True,
+        exclude=True,
+        default=None,
+    )
 
 
 class GoogleWalletWithIdModel(GoogleWalletWithKindMixin):
     """
-    Base model for Google Wallet models with an identifier.
+    Model for Google Wallet models with an identifier.
     """
 
-    # kind: str | None = Field(description="deprecated", exclude=True, default=None)
     id: str