Merge pull request #22 from mapswipe/feat/validate-tutorial-types

fix: update schema for validate tutorial

Author: tnagorra

functions/definition/tutorial/common.yaml

@@ -104,6 +104,10 @@ FbBaseTutorial:
       tutorialDraftId:
         type: string
         deprecated: true
+      screens:
+        type:
+          type: list
+          elementType: FbScreen
 
 FbBaseTutorialGroup:
   model: alias

functions/definition/tutorial/compare.yaml

@@ -15,48 +15,12 @@ FbCompareTutorial:
         type: FbObjRasterTileServer
       zoomLevel:
         type: int
-      screens:
-        type:
-          type: list
-          elementType: FbScreen
-
-FbCompareTutorialGroup:
-  model: alias
-  type:
-    type: object
-    fields:
-      xMax:
-        type: int
-      xMin:
-        type: int
-      yMax:
-        type: int
-      yMin:
-        type: int
 
 FbCompareTutorialTask:
   model: alias
   type:
     type: object
     fields:
-      geometry: # NOTE: initially empty string
-        type: string
-      groupId:
-        type: int
-      projectId:
-        type: string
-      referenceAnswer:
-        type: int
-      screen:
-        type: int
-      taskId:
-        type: string
-      taskId_real:
-        type: string
-      taskX:
-        type: int
-      taskY:
-        type: int
       url:
         type: string
       urlB:

functions/definition/tutorial/completeness.yaml

@@ -17,48 +17,12 @@ FbCompletenessTutorial:
         type: FbObjUnifiedOverlayTileServer
       zoomLevel:
         type: int
-      screens:
-        type:
-          type: list
-          elementType: FbScreen
-
-FbCompletenessTutorialGroup:
-  model: alias
-  type:
-    type: object
-    fields:
-      xMax:
-        type: int
-      xMin:
-        type: int
-      yMax:
-        type: int
-      yMin:
-        type: int
 
 FbCompletenessTutorialTask:
   model: alias
   type:
     type: object
     fields:
-      geometry: # NOTE: initially empty string
-        type: string
-      groupId:
-        type: int
-      projectId:
-        type: string
-      referenceAnswer:
-        type: int
-      screen:
-        type: int
-      taskId:
-        type: string
-      taskId_real:
-        type: string
-      taskX:
-        type: int
-      taskY:
-        type: int
       url:
         type: string
       urlB:

functions/definition/tutorial/find.yaml

@@ -13,47 +13,11 @@ FbFindTutorial:
         type: FbObjRasterTileServer
       zoomLevel:
         type: int
-      screens:
-        type:
-          type: list
-          elementType: FbScreen
-
-FbFindTutorialGroup:
-  model: alias
-  type:
-    type: object
-    fields:
-      xMax:
-        type: int
-      xMin:
-        type: int
-      yMax:
-        type: int
-      yMin:
-        type: int
 
 FbFindTutorialTask:
   model: alias
   type:
     type: object
     fields:
-      geometry: # NOTE: initially empty string
-        type: string
-      groupId:
-        type: int
-      projectId:
-        type: string
-      referenceAnswer:
-        type: int
-      screen:
-        type: int
-      taskId:
-        type: string
-      taskId_real:
-        type: string
-      taskX:
-        type: int
-      taskY:
-        type: int
       url:
         type: string

functions/definition/tutorial/tileMapService.yaml

@@ -0,0 +1,37 @@
+FbTileMapServiceTutorialGroup:
+  model: alias
+  type:
+    type: object
+    fields:
+      xMax:
+        type: int
+      xMin:
+        type: int
+      yMax:
+        type: int
+      yMin:
+        type: int
+
+FbTileMapServiceTutorialTask:
+  model: alias
+  type:
+    type: object
+    fields:
+      geometry: # NOTE: initially empty string
+        type: string
+      groupId:
+        type: int
+      projectId:
+        type: string
+      referenceAnswer:
+        type: int
+      screen:
+        type: int
+      taskId:
+        type: string
+      taskId_real:
+        type: string
+      taskX:
+        type: int
+      taskY:
+        type: int

functions/definition/tutorial/validate.yaml

@@ -5,8 +5,10 @@ FbValidateTutorial:
   type:
     type: object
     fields:
-      inputGeometries: # NOTE: local path to geometry file
+      # NOTE: local path to geometry file
+      inputGeometries:
         type: string
+        deprecated: true
       projectType:
         type:
           type: literal
@@ -15,10 +17,7 @@ FbValidateTutorial:
         type: FbObjRasterTileServer
       zoomLevel:
         type: int
-      screens:
-        type:
-          type: list
-          elementType: FbScreen
+        deprecated: true
       customOptions:
         optional: true
         type:
@@ -30,14 +29,12 @@ FbValidateTutorialTaskProperties:
   type:
     type: object
     fields:
-      building:
-        type: string
-      description:
-        type: string
-      reference:
-        type: string # NOTE: not sure if this is int or string
+      id:
+        type: int
       screen:
-        type: string # NOTE: not sure if this is int or string
+        type: int
+      reference:
+        type: int
 
 FbValidateTutorialTask:
   model: alias
@@ -50,9 +47,5 @@ FbValidateTutorialTask:
         type: unknown
       properties:
         type: FbValidateTutorialTaskProperties
-      screen:
-        type: int
-      reference:
-        type: int
       geometry: # NOTE: geometry as WKT
         type: string

functions/generated/pyfirebase/pyfirebase_mapswipe/extended_models.py

@@ -14,9 +14,7 @@ class FbProject(
     class Config:  # type: ignore[reportIncompatibleVariableOverride]
         use_enum_values = False
         frozen = True
-        # NOTE: We need to allow extra fields as FbProject
-        # is not a complete project representation
-        extra = "allow"
+        extra = "forbid"
 
 
 class FbMappingGroup(
@@ -48,3 +46,33 @@ class Config:  # type: ignore[reportIncompatibleVariableOverride]
         use_enum_values = False
         frozen = True
         extra = "forbid"
+
+
+class FbFindTutorialTaskComplete(
+    models.FbTileMapServiceTutorialTask,
+    models.FbFindTutorialTask,
+):
+    class Config:  # type: ignore[reportIncompatibleVariableOverride]
+        use_enum_values = True
+        frozen = True
+        extra = "forbid"
+
+
+class FbCompareTutorialTaskComplete(
+    models.FbTileMapServiceTutorialTask,
+    models.FbCompareTutorialTask,
+):
+    class Config:  # type: ignore[reportIncompatibleVariableOverride]
+        use_enum_values = True
+        frozen = True
+        extra = "forbid"
+
+
+class FbCompletenessTutorialTaskComplete(
+    models.FbTileMapServiceTutorialTask,
+    models.FbCompletenessTutorialTask,
+):
+    class Config:  # type: ignore[reportIncompatibleVariableOverride]
+        use_enum_values = True
+        frozen = True
+        extra = "forbid"