Merge pull request #172 from Sunbird-Saral/v1-develop

changes related to this release
Sunbird-Saral · Apr 8, 2022 · 7210f76 · 7210f76
2 parents 8a43713 + c23e41e
commit 7210f76
Show file tree

Hide file tree

Showing 48 changed files with 25,338 additions and 1,899 deletions.
diff --git a/specs/v1.5/jupyter-notebook/ANY10S10Q_generated_roi.json b/specs/v1.5/jupyter-notebook/ANY10S10Q_generated_roi.json
diff --git a/specs/v1.5/jupyter-notebook/ANY10S10Q_vottraw.json b/specs/v1.5/jupyter-notebook/ANY10S10Q_vottraw.json
diff --git a/specs/v1.5/jupyter-notebook/ANY1S10Q_generated_roi.json b/specs/v1.5/jupyter-notebook/ANY1S10Q_generated_roi.json
@@ -148,24 +148,24 @@
                 "cellId": "4",
                 "rois": [
                     {
-                        "annotationTags": "QUESTION2",
+                        "annotationTags": "QUESTION3",
                         "extractionMethod": "CELL_OMR",
                         "roiId": "9",
                         "index": 0,
                         "rect": {
-                            "top": 267,
-                            "left": 207,
-                            "bottom": 287,
-                            "right": 222
+                            "top": 317,
+                            "left": 206,
+                            "bottom": 334,
+                            "right": 223
                         }
                     }
                 ],
                 "render": {
                     "index": 4
                 },
                 "format": {
-                    "name": "QUESTION2",
-                    "value": "QUESTION 2"
+                    "name": "QUESTION3",
+                    "value": "QUESTION 3"
                 },
                 "validate": {
                     "regExp": ""
@@ -362,4 +362,4 @@
             }
         ]
     }
-}
+}
diff --git a/specs/v1.5/jupyter-notebook/transform_ANY10S10Q_vott_to_roi.ipynb b/specs/v1.5/jupyter-notebook/transform_ANY10S10Q_vott_to_roi.ipynb
diff --git a/specs/v1.5/jupyter-notebook/transform_ANY1S10Q_voot_to_roi.ipynb b/specs/v1.5/jupyter-notebook/transform_ANY1S10Q_voot_to_roi.ipynb
@@ -2,7 +2,7 @@
  "cells": [
   {
    "cell_type": "code",
-   "execution_count": 8,
+   "execution_count": 1,
    "id": "05f432ef",
    "metadata": {},
    "outputs": [],
@@ -116,7 +116,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 9,
+   "execution_count": 2,
    "id": "a18c1334",
    "metadata": {},
    "outputs": [],
@@ -126,12 +126,12 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 3,
    "id": "95911b33",
    "metadata": {},
    "outputs": [],
    "source": [
-    "tagGroups = [\"ROLLNUMBER\",\"QUESTION1\",\"QUESTION2\",\"QUESTION2\",\"QUESTION4\",\"QUESTION5\",\"QUESTION6\",\"QUESTION7\",\"QUESTION8\",\"QUESTION9\",\"QUESTIONTEN\"]\n",
+    "tagGroups = [\"ROLLNUMBER\",\"QUESTION1\",\"QUESTION2\",\"QUESTION3\",\"QUESTION4\",\"QUESTION5\",\"QUESTION6\",\"QUESTION7\",\"QUESTION8\",\"QUESTION9\",\"QUESTIONTEN\"]\n",
     "\n",
     "formatLookup = {\n",
     "\"ROLLNUMBER\": \"ROLLNUMBER\",\n",
@@ -157,7 +157,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 4,
    "id": "3a0eb467",
    "metadata": {},
    "outputs": [],
@@ -167,7 +167,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 5,
    "id": "2766b594",
    "metadata": {},
    "outputs": [
@@ -325,24 +325,24 @@
       "                \"cellId\": \"4\",\n",
       "                \"rois\": [\n",
       "                    {\n",
-      "                        \"annotationTags\": \"QUESTION2\",\n",
+      "                        \"annotationTags\": \"QUESTION3\",\n",
       "                        \"extractionMethod\": \"CELL_OMR\",\n",
       "                        \"roiId\": \"9\",\n",
       "                        \"index\": 0,\n",
       "                        \"rect\": {\n",
-      "                            \"top\": 267,\n",
-      "                            \"left\": 207,\n",
-      "                            \"bottom\": 287,\n",
-      "                            \"right\": 222\n",
+      "                            \"top\": 317,\n",
+      "                            \"left\": 206,\n",
+      "                            \"bottom\": 334,\n",
+      "                            \"right\": 223\n",
       "                        }\n",
       "                    }\n",
       "                ],\n",
       "                \"render\": {\n",
       "                    \"index\": 4\n",
       "                },\n",
       "                \"format\": {\n",
-      "                    \"name\": \"QUESTION2\",\n",
-      "                    \"value\": \"QUESTION 2\"\n",
+      "                    \"name\": \"QUESTION3\",\n",
+      "                    \"value\": \"QUESTION 3\"\n",
       "                },\n",
       "                \"validate\": {\n",
       "                    \"regExp\": \"\"\n",

diff --git a/specs/v1.5/saral-physical-layout-representation-specs.yaml b/specs/v1.5/saral-physical-layout-representation-specs.yaml
@@ -40,23 +40,40 @@ components:
           description: validate erroneous resultData and show error message when resultData does not match with regular expression .
           properties:
             validate:  
-            type: object
-            properties:
-              regExp:
-              type: string
-              description: regular expression to detect erroneous resultData
-              errorMsg:
-              type: string
-              description: error message shows when resultData does not match with regular expression.
-        pages:
-          type: positiveInteger
-          description: number of pages supported by layout. Optional feild , to be used for multi-page layouts.
-          example: 3
-        cells:
-          type: array
-          items:
-            $ref: '#/components/schemas/cell'
-            minItems: 1
+              type: object
+              properties:
+                regExp:
+                  type: string
+                  description: regular expression to detect erroneous resultData
+                errorMsg:
+                  type: string
+                  description: error message shows when resultData does not match with regular expression.
+                pages:
+                  type: positiveInteger
+                  description: number of pages supported by layout. Optional feild , to be used for multi-page layouts.
+                  example: 3
+                cells:
+                  type: array
+                  items:
+                    $ref: '#/components/schemas/cell'
+                  minItems: 1
+
+        idValidation: 
+          type: object
+          description: validate erroneous Id and show an error message when the predicted Id does not match with the regular expression.
+          properties:
+            validate: 
+              type: object
+              properties:
+                regExp:
+                  type: string
+                  description: regular expression to detect erroneous resultData
+                  example: "^[0-9]{7}$"
+                errorMsg: 
+                  type: string
+                  description: error message shows when resultData does not match with regular expression.
+                  example: "Student I'd exceeds the limit"
+
 
     cell:
       type: object

diff --git a/specs/v1.5/swagger-saral-apidoc.yaml b/specs/v1.5/swagger-saral-apidoc.yaml
@@ -36,7 +36,7 @@ paths:
   /schools:
     get:
       tags:
-      - Frontend API
+      - Maintenance API
       - School
       summary: "Get School List"
       description: "should return list of school"
@@ -683,6 +683,12 @@ definitions:
             description: "If this is set to true frontend application will return base 64 encoded images . In savesMarksAPI and getSavedScanAPI these APIs will get data and value of encoded images will be stored in these fields studentIdTrainingData and trainningData, studentIdTrainingData field will contain base 64 encoded images of rollnumber and trainningData field will contain base 64 encoded images for marks. "
             default: false
             example: true
+          tags:
+            type: boolean
+            example: true
+          supportEmail:
+            type: string
+            example: "abc@gmail.com , xyz@gmail.com "
 
       classes:
             $ref: '#/definitions/classResponse'
@@ -761,6 +767,13 @@ definitions:
         default: false
         description: "If this is set to true frontend application will return base 64 encoded images . In savesMarksAPI and getSavedScanAPI these APIs will get data and value of encoded images will be stored in these fields studentIdTrainingData and trainningData, studentIdTrainingData field will contain base 64 encoded images of rollnumber and trainningData field will contain base 64 encoded images for marks. "
         example: true
+      tags:
+        type: boolean
+        example: true
+      autoSyncBatchSize:
+        type: number
+        description:  "Limit of student records to be stored in local storage before we push to backend."
+        example: 10
 
   CreateSchoolResponse:
     type: object
@@ -805,6 +818,13 @@ definitions:
         default: false
         example: true
         description: "If this is set to true frontend application will return base 64 encoded images . In savesMarksAPI and getSavedScanAPI these APIs will get data and value of encoded images will be stored in these fields studentIdTrainingData and trainningData, studentIdTrainingData field will contain base 64 encoded images of rollnumber and trainningData field will contain base 64 encoded images for marks. "
+      tags:
+        type: boolean
+        example: false
+      autoSyncBatchSize:
+        type: number
+        description:  "Limit of student records to be stored in local storage before we push to backend."
+        example: 10
 
   UpdateStudentBody:
     type: object
@@ -1255,6 +1275,18 @@ definitions:
           type: string
           description: "Question Id"
           example: "1"
+        tags: 
+          type: array
+          items:
+            type: object
+            properties:
+              tagName:
+                type: string
+                example: "Historic"
+              selected:
+                type: boolean
+                default: false
+                example: false
         indicatorTitle:
           type: string
           description: "Indicator Title"
@@ -1660,4 +1692,4 @@ definitions:
 
 
 
-
+