Added examples for testing

Author: pcrespov

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

@@ -363,7 +363,8 @@ class ServiceAccessRights(BaseModel):
 
 
 class ServiceMetaData(ServiceCommonData):
-    # for a partial update all members must be Optional
+    # Overrides all fields of ServiceCommonData:
+    #    - for a partial update all members must be Optional
     name: Optional[str]
     thumbnail: Optional[HttpUrl]
     description: Optional[str]

services/catalog/src/simcore_service_catalog/models/schemas/services.py

@@ -11,7 +11,57 @@
 
 # OpenAPI models (contain both service metadata and access rights)
 class ServiceUpdate(ServiceMetaData, ServiceAccessRights):
-    pass
+    class Config:
+        schema_extra = {
+            "examples": [
+                {
+                    # ServiceAccessRights
+                    "access_rights": {
+                        1: {
+                            "execute_access": False,
+                            "write_access": False,
+                        },
+                        2: {
+                            "execute_access": True,
+                            "write_access": True,
+                        },
+                        44: {
+                            "execute_access": False,
+                            "write_access": False,
+                        },
+                    },
+                    # ServiceMetaData = ServiceCommonData +
+                    "name": "My Human Readable Service Name",
+                    "thumbnail": None,
+                    "description": "An interesting service that does something",
+                    "classifiers": ["RRID:SCR_018997", "RRID:SCR_019001"],
+                    "quality": {
+                        "tsr": {
+                            "r01": {"level": 3, "references": ""},
+                            "r02": {"level": 2, "references": ""},
+                            "r03": {"level": 0, "references": ""},
+                            "r04": {"level": 0, "references": ""},
+                            "r05": {"level": 2, "references": ""},
+                            "r06": {"level": 0, "references": ""},
+                            "r07": {"level": 0, "references": ""},
+                            "r08": {"level": 1, "references": ""},
+                            "r09": {"level": 0, "references": ""},
+                            "r10": {"level": 0, "references": ""},
+                        },
+                        "enabled": True,
+                        "annotations": {
+                            "vandv": "",
+                            "purpose": "",
+                            "standards": "",
+                            "limitations": "",
+                            "documentation": "",
+                            "certificationLink": "",
+                            "certificationStatus": "Uncertified",
+                        },
+                    },
+                }
+            ]
+        }
 
 
 class ServiceOut(

services/catalog/tests/unit/test_models_schemas_services.py

@@ -4,10 +4,14 @@
 from pprint import pformat
 
 import pytest
-from simcore_service_catalog.models.schemas.services import ServiceOut, ServiceUpdate
+from simcore_service_catalog.models.schemas.services import (
+    ServiceItem,
+    ServiceOut,
+    ServiceUpdate,
+)
 
 
-@pytest.mark.parametrize("model_cls", (ServiceOut, ServiceUpdate))
+@pytest.mark.parametrize("model_cls", (ServiceOut, ServiceUpdate, ServiceItem))
 def test_service_api_models_examples(model_cls, model_cls_examples):
     for name, example in model_cls_examples.items():
         print(name, ":", pformat(example))