more group examples

Author: pcrespov

packages/models-library/src/models_library/api_schemas_webserver/groups.py

@@ -187,6 +187,12 @@ class MyGroupsGet(OutputSchema):
     organizations: list[GroupGet] | None = None
     all: GroupGet
     product: GroupGet | None = None
+    support: Annotated[
+        GroupGet | None,
+        Field(
+            description="Group ID of the app support team or None if no support is defined for this product"
+        ),
+    ] = None
 
     model_config = ConfigDict(
         json_schema_extra={
@@ -225,6 +231,12 @@ class MyGroupsGet(OutputSchema):
                     "description": "Open to all users",
                     "accessRights": {"read": True, "write": False, "delete": False},
                 },
+                "support": {
+                    "gid": "2",
+                    "label": "Support Team",
+                    "description": "The support team of the application",
+                    "accessRights": {"read": False, "write": False, "delete": False},
+                },
             }
         }
     )
@@ -234,6 +246,7 @@ def from_domain_model(
         cls,
         groups_by_type: GroupsByTypeTuple,
         my_product_group: tuple[Group, AccessRightsDict] | None,
+        my_support_group: tuple[Group, AccessRightsDict] | None = None,
     ) -> Self:
         assert groups_by_type.primary  # nosec
         assert groups_by_type.everyone  # nosec
@@ -249,6 +262,11 @@ def from_domain_model(
                 if my_product_group
                 else None
             ),
+            support=(
+                GroupGet.from_domain_model(*my_support_group)
+                if my_support_group
+                else None
+            ),
         )
 
 

packages/models-library/src/models_library/groups.py

@@ -39,41 +39,44 @@ class Group(BaseModel):
 
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
-        schema.update(
-            {
-                "examples": [
-                    {
-                        "gid": 1,
-                        "name": "Everyone",
-                        "type": "everyone",
-                        "description": "all users",
-                        "thumbnail": None,
-                    },
-                    {
-                        "gid": 2,
-                        "name": "User",
-                        "description": "primary group",
-                        "type": "primary",
-                        "thumbnail": None,
-                    },
-                    {
-                        "gid": 3,
-                        "name": "Organization",
-                        "description": "standard group",
-                        "type": "standard",
-                        "thumbnail": None,
-                        "inclusionRules": {},
-                    },
-                    {
-                        "gid": 4,
-                        "name": "Product",
-                        "description": "standard group for products",
-                        "type": "standard",
-                        "thumbnail": None,
-                    },
-                ]
-            }
-        )
+        everyone = {
+            "gid": 1,
+            "name": "Everyone",
+            "type": "everyone",
+            "description": "all users",
+            "thumbnail": None,
+        }
+        user = {
+            "gid": 2,
+            "name": "User",
+            "description": "primary group",
+            "type": "primary",
+            "thumbnail": None,
+        }
+        organization = {
+            "gid": 3,
+            "name": "Organization",
+            "description": "standard group",
+            "type": "standard",
+            "thumbnail": None,
+            "inclusionRules": {},
+        }
+        product = {
+            "gid": 4,
+            "name": "Product",
+            "description": "standard group for products",
+            "type": "standard",
+            "thumbnail": None,
+        }
+        support = {
+            "gid": 5,
+            "name": "Support",
+            "description": "support group",
+            "type": "standard",
+            "thumbnail": None,
+        }
+
+        schema.update({"examples": [everyone, user, organization, product, support]})
 
     model_config = ConfigDict(
         populate_by_name=True, json_schema_extra=_update_json_schema_extra

packages/models-library/tests/test_users.py

@@ -1,3 +1,4 @@
+import pytest
 from models_library.api_schemas_webserver.users import (
     MyProfileRestGet,
 )
@@ -7,7 +8,11 @@
 from pydantic import TypeAdapter
 
 
-def test_adapter_from_model_to_schema():
+@pytest.mark.parametrize("with_support_group", [True, False])
+@pytest.mark.parametrize("with_standard_groups", [True, False])
+def test_adapter_from_model_to_schema(
+    with_support_group: bool, with_standard_groups: bool
+):
     my_profile = MyProfile.model_validate(MyProfile.model_json_schema()["example"])
 
     groups = TypeAdapter(list[Group]).validate_python(
@@ -17,13 +22,24 @@ def test_adapter_from_model_to_schema():
     ar = AccessRightsDict(read=False, write=False, delete=False)
 
     my_groups_by_type = GroupsByTypeTuple(
-        primary=(groups[1], ar), standard=[(groups[2], ar)], everyone=(groups[0], ar)
+        primary=(groups[1], ar),
+        standard=[(groups[2], ar)] if with_standard_groups else [],
+        everyone=(groups[0], ar),
     )
-    my_product_group = groups[-1], AccessRightsDict(
+    my_product_group = groups[3], AccessRightsDict(
         read=False, write=False, delete=False
     )
+
+    my_support_group = groups[4], AccessRightsDict(
+        read=False, write=False, delete=False
+    )
+
     my_preferences = {"foo": Preference(default_value=3, value=1)}
 
     MyProfileRestGet.from_domain_model(
-        my_profile, my_groups_by_type, my_product_group, my_preferences
+        my_profile,
+        my_groups_by_type,
+        my_product_group,
+        my_preferences,
+        my_support_group if with_support_group else None,
     )