fix: better type for Responses policyRef (#67)

theopensystemslab · Nov 8, 2023 · 05fe2df · 05fe2df
1 parent d29bb24
commit 05fe2df
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 20 deletions.
diff --git a/schema/schema.json b/schema/schema.json
@@ -2857,14 +2857,7 @@
           "description": "Details of the digital planning service which sent the application",
           "properties": {
             "flowId": {
-              "anyOf": [
-                {
-                  "$ref": "#/definitions/UUID"
-                },
-                {
-                  "type": "string"
-                }
-              ]
+              "$ref": "#/definitions/UUID"
             },
             "name": {
               "type": "string"
@@ -2891,14 +2884,7 @@
               "$ref": "#/definitions/DateTime"
             },
             "id": {
-              "anyOf": [
-                {
-                  "$ref": "#/definitions/UUID"
-                },
-                {
-                  "type": "string"
-                }
-              ]
+              "$ref": "#/definitions/UUID"
             },
             "source": {
               "const": "PlanX",
@@ -17515,9 +17501,12 @@
                 "type": "string"
               },
               "url": {
-                "type": "string"
+                "$ref": "#/definitions/URL"
               }
             },
+            "required": [
+              "text"
+            ],
             "type": "object"
           },
           "type": "array"

diff --git a/types/schema/Responses.ts b/types/schema/Responses.ts
@@ -1,3 +1,5 @@
+import {URL} from './../utils';
+
 /**
  * @id #Responses
  * @description The ordered list of questions, answers, and their metadata for the application
@@ -7,14 +9,14 @@ export type Responses = QuestionAndResponses[];
 export interface QuestionMetaData {
   autoAnswered?: boolean;
   policyRefs?: Array<{
-    url?: string;
-    text?: string;
+    text: string;
+    url?: URL;
   }>;
   sectionName?: string;
 }
 
 export interface ResponseMetaData {
-  flags?: Array<string>; // @todo connect to result/flags enum
+  flags?: Array<string>; // @todo connect to result/flags enum, is this actually a list?
   options?: Array<string> | Array<Response>;
 }