extend models library

Author: Andrei Neagu

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

@@ -11,12 +11,14 @@
 
 from common_library.basic_types import DEFAULT_FACTORY
 from common_library.dict_tools import remap_keys
+from models_library.projects import ProjectTemplateType, ProjectType
 from pydantic import (
     BeforeValidator,
     ConfigDict,
     Field,
     HttpUrl,
     PlainSerializer,
+    ValidationInfo,
     field_validator,
 )
 from pydantic.config import JsonDict
@@ -101,6 +103,9 @@ def to_domain_model(self) -> dict[str, Any]:
 class ProjectGet(OutputSchema):
     uuid: ProjectID
 
+    type: ProjectType
+    template_type: ProjectTemplateType | None
+
     # display
     name: str
     description: str
@@ -144,12 +149,28 @@ class ProjectGet(OutputSchema):
         none_to_empty_str_pre_validator
     )
 
+    @field_validator("template_type")
+    @classmethod
+    def validate_template_type(
+        cls, v: ProjectTemplateType | None, info: ValidationInfo
+    ) -> ProjectTemplateType | None:
+        type_value = info.data.get("type")
+        if type_value == ProjectType.STANDARD and v is not None:
+            msg = "template_type must be None when type is STANDARD"
+            raise ValueError(msg)
+        if type_value == ProjectType.TEMPLATE and v is None:
+            msg = "template_type must not be None when type is TEMPLATE"
+            raise ValueError(msg)
+        return v
+
     @staticmethod
     def _update_json_schema_extra(schema: JsonDict) -> None:
         schema.update(
             examples=[
                 {
                     "uuid": "a8b0f384-bd08-4793-ab25-65d5a755f4b6",
+                    "type": "STANDARD",
+                    "template_type": None,
                     "name": "My Project",
                     "description": "This is a sample project",
                     "thumbnail": "https://example.com/thumbnail.png",

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

@@ -52,6 +52,12 @@ class ProjectType(str, Enum):
     STANDARD = "STANDARD"
 
 
+class ProjectTemplateType(str, Enum):
+    TEMPLATE = "TEMPLATE"
+    TUTORIAL = "TUTORIAL"
+    HYPERTOOL = "HYPERTOOL"
+
+
 class BaseProjectModel(BaseModel):
     # Description of the project
     uuid: Annotated[

packages/pytest-simcore/src/pytest_simcore/simcore_webserver_projects_rest_api.py

@@ -60,6 +60,8 @@ def request_desc(self) -> str:
     response_body={
         "data": {
             "uuid": "18f1938c-567d-11ec-b2f3-02420a000010",
+            "type": "STANDARD",
+            "template_type": None,
             "name": "New Study",
             "description": "",
             "accessRights": {"2": {"read": True, "write": True, "delete": True}},
@@ -94,6 +96,8 @@ def request_desc(self) -> str:
     response_body={
         "data": {
             "uuid": "18f1938c-567d-11ec-b2f3-02420a000010",
+            "type": "STANDARD",
+            "template_type": None,
             "name": "New Study",
             "description": "",
             "thumbnail": "",
@@ -225,6 +229,8 @@ def request_desc(self) -> str:
     response_body={
         "data": {
             "uuid": "18f1938c-567d-11ec-b2f3-02420a000010",
+            "type": "STANDARD",
+            "template_type": None,
             "name": "New Study",
             "description": "",
             "thumbnail": "",
@@ -414,6 +420,8 @@ def request_desc(self) -> str:
     response_body={
         "data": {
             "uuid": "18f1938c-567d-11ec-b2f3-02420a000010",
+            "type": "STANDARD",
+            "template_type": None,
             "name": "New Study",
             "description": "",
             "thumbnail": "",
@@ -599,6 +607,8 @@ def request_desc(self) -> str:
         "data": [
             {
                 "uuid": "18f1938c-567d-11ec-b2f3-02420a000010",
+                "type": "STANDARD",
+                "template_type": None,
                 "name": "New Study",
                 "description": "",
                 "thumbnail": "",
@@ -797,6 +807,8 @@ def request_desc(self) -> str:
     response_body={
         "data": {
             "uuid": "4c58409a-d9e4-11ed-9c9e-02420a0b755a",
+            "type": "STANDARD",
+            "template_type": None,
             "name": "Sleepers",
             "description": "5 sleepers interconnected",
             "thumbnail": "https://raw.githubusercontent.com/ITISFoundation/osparc-assets/main/assets/TheSoftWatches.jpg",