Add introduction guidance (#140)

ONSdigital · Mar 4, 2022 · 400fdcd · 400fdcd
1 parent 0613d24
commit 400fdcd
Show file tree

Hide file tree

Showing 8 changed files with 114 additions and 14 deletions.
diff --git a/schemas/blocks/introduction.json b/schemas/blocks/introduction.json
@@ -32,7 +32,16 @@
               "$ref": "https://eq.ons.gov.uk/common_definitions.json#/contents"
             }
           },
-          "additionalProperties": false
+          "additionalProperties": true,
+          "required": ["id"],
+          "anyOf": [
+            {
+              "required": ["title"]
+            },
+            {
+              "required": ["contents"]
+            }
+          ]
         }
       },
       "preview_content": {

diff --git a/schemas/common_definitions.json b/schemas/common_definitions.json
@@ -42,6 +42,9 @@
         },
         {
           "required": ["definition"]
+        },
+        {
+          "required": ["guidance"]
         }
       ],
       "properties": {
@@ -59,6 +62,9 @@
         },
         "definition": {
           "$ref": "https://eq.ons.gov.uk/common_definitions.json#/definition"
+        },
+        "guidance": {
+          "$ref": "https://eq.ons.gov.uk/common_definitions.json#/guidance"
         }
       },
       "additionalProperties": false
@@ -406,5 +412,14 @@
   "interviewer_only": {
     "description": "Marks the page as for the interviewer only. Only applies for questionnaires that will be completed by an interviewer.",
     "type": "boolean"
+  },
+  "guidance": {
+    "description": "Question or contents guidance",
+    "type": "object",
+    "properties": {
+      "contents": {
+        "$ref": "https://eq.ons.gov.uk/common_definitions.json#/contents"
+      }
+    }
   }
 }
diff --git a/schemas/questions/definitions.json b/schemas/questions/definitions.json
@@ -17,15 +17,6 @@
       }
     ]
   },
-  "question_guidance": {
-    "description": "Question guidance",
-    "type": "object",
-    "properties": {
-      "contents": {
-        "$ref": "https://eq.ons.gov.uk/common_definitions.json#/contents"
-      }
-    }
-  },
   "summary": {
     "description": "TextField string concatenations for the summary page",
     "properties": {

diff --git a/schemas/questions/types/calculated.json b/schemas/questions/types/calculated.json
@@ -23,7 +23,7 @@
         "$ref": "https://eq.ons.gov.uk/common_definitions.json#/question_definitions"
       },
       "guidance": {
-        "$ref": "https://eq.ons.gov.uk/questions/definitions.json#/question_guidance"
+        "$ref": "https://eq.ons.gov.uk/common_definitions.json#/guidance"
       },
       "type": {
         "type": "string",

diff --git a/schemas/questions/types/date_range.json b/schemas/questions/types/date_range.json
@@ -23,7 +23,7 @@
         "$ref": "https://eq.ons.gov.uk/common_definitions.json#/non_empty_string"
       },
       "guidance": {
-        "$ref": "https://eq.ons.gov.uk/questions/definitions.json#/question_guidance"
+        "$ref": "https://eq.ons.gov.uk/common_definitions.json#/guidance"
       },
       "type": {
         "type": "string",

diff --git a/schemas/questions/types/general.json b/schemas/questions/types/general.json
@@ -26,7 +26,7 @@
         "$ref": "https://eq.ons.gov.uk/common_definitions.json#/question_definitions"
       },
       "guidance": {
-        "$ref": "https://eq.ons.gov.uk/questions/definitions.json#/question_guidance"
+        "$ref": "https://eq.ons.gov.uk/common_definitions.json#/guidance"
       },
       "summary": {
         "$ref": "https://eq.ons.gov.uk/questions/definitions.json#/summary"

diff --git a/schemas/questions/types/mutually_exclusive.json b/schemas/questions/types/mutually_exclusive.json
@@ -26,7 +26,7 @@
         "$ref": "https://eq.ons.gov.uk/common_definitions.json#/question_definitions"
       },
       "guidance": {
-        "$ref": "https://eq.ons.gov.uk/questions/definitions.json#/question_guidance"
+        "$ref": "https://eq.ons.gov.uk/common_definitions.json#/guidance"
       },
       "type": {
         "type": "string",

diff --git a/tests/schemas/valid/test_introduction_with_guidance.json b/tests/schemas/valid/test_introduction_with_guidance.json
@@ -0,0 +1,85 @@
+{
+  "mime_type": "application/json/ons/eq",
+  "language": "en",
+  "schema_version": "0.0.1",
+  "data_version": "0.0.3",
+  "survey_id": "144",
+  "theme": "default",
+  "title": "Test introduction",
+  "legal_basis": "Notice is given under section 999 of the Test Act 2000",
+  "metadata": [
+    {
+      "name": "user_id",
+      "type": "string"
+    },
+    {
+      "name": "period_id",
+      "type": "string"
+    },
+    {
+      "name": "ru_name",
+      "type": "string"
+    },
+    {
+      "name": "ru_ref",
+      "type": "string"
+    },
+    {
+      "name": "trad_as",
+      "type": "string",
+      "optional": true
+    }
+  ],
+  "questionnaire_flow": {
+    "type": "Linear",
+    "options": {}
+  },
+  "sections": [
+    {
+      "id": "introduction-section",
+      "title": "Introduction",
+      "groups": [
+        {
+          "id": "introduction-group",
+          "title": "General Business Information",
+          "blocks": [
+            {
+              "id": "introduction",
+              "type": "Introduction",
+              "primary_content": [
+                {
+                  "id": "business-details",
+                  "title": "You are completing this for ESSENTIAL ENTERPRISE LTD.",
+                  "contents": [
+                    {
+                      "guidance": {
+                        "contents": [
+                          {
+                            "title": "Coronavirus (COVID-19) guidance",
+                            "description": "<strong>Explain your figures</strong> in the comment section to minimise us contacting you and to help us tell an industry story"
+                          }
+                        ]
+                      }
+                    }
+                  ]
+                }
+              ]
+            },
+            {
+              "type": "Interstitial",
+              "id": "general-business-information-completed",
+              "content": {
+                "title": "Section complete",
+                "contents": [
+                  {
+                    "description": "<p>You have successfully completed this section</p>"
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}