update organisation to be reference code

theopensystemslab · Nov 16, 2023 · b820016 · b820016
1 parent b9216c2
commit b820016
Show file tree

Hide file tree

Showing 10 changed files with 15 additions and 12 deletions.
diff --git a/examples/data/ldcE.ts b/examples/data/ldcE.ts
@@ -1227,7 +1227,7 @@ export const validLDCE: Schema = {
     },
   ],
   metadata: {
-    organisation: 'buckinghamshire',
+    organisation: 'BKM',
     id: '95f90e21-93f5-4761-90b3-815c673e041f',
     source: 'PlanX',
     service: {

diff --git a/examples/data/ldcP.ts b/examples/data/ldcP.ts
@@ -831,7 +831,7 @@ export const validLDCP: Schema = {
     },
   ],
   metadata: {
-    organisation: 'buckinghamshire',
+    organisation: 'BKM',
     id: '8da51c5b-a2a0-4386-a15d-29d66f9c121c',
     source: 'PlanX',
     service: {

diff --git a/examples/data/planningPermission.ts b/examples/data/planningPermission.ts
@@ -1249,7 +1249,7 @@ export const validPlanningPermission: Schema = {
     },
   ],
   metadata: {
-    organisation: 'lambeth',
+    organisation: 'LBH',
     id: '81bcaa0f-baf5-4573-ba0a-ea868c573faf',
     source: 'PlanX',
     service: {

diff --git a/examples/data/priorApproval.ts b/examples/data/priorApproval.ts
@@ -767,7 +767,7 @@ export const validPriorApproval: Schema = {
     },
   ],
   metadata: {
-    organisation: 'southwark',
+    organisation: 'SWK',
     id: 'b18c301b-9d44-4c6c-8d27-5b5bf33c570b',
     source: 'PlanX',
     service: {

diff --git a/examples/validLawfulDevelopmentCertificateExisting.json b/examples/validLawfulDevelopmentCertificateExisting.json
@@ -1849,7 +1849,7 @@
     }
   ],
   "metadata": {
-    "organisation": "buckinghamshire",
+    "organisation": "BKM",
     "id": "95f90e21-93f5-4761-90b3-815c673e041f",
     "source": "PlanX",
     "service": {

diff --git a/examples/validLawfulDevelopmentCertificateProposed.json b/examples/validLawfulDevelopmentCertificateProposed.json
@@ -1211,7 +1211,7 @@
     }
   ],
   "metadata": {
-    "organisation": "buckinghamshire",
+    "organisation": "BKM",
     "id": "8da51c5b-a2a0-4386-a15d-29d66f9c121c",
     "source": "PlanX",
     "service": {

diff --git a/examples/validPlanningPermission.json b/examples/validPlanningPermission.json
@@ -1760,7 +1760,7 @@
     }
   ],
   "metadata": {
-    "organisation": "lambeth",
+    "organisation": "LBH",
     "id": "81bcaa0f-baf5-4573-ba0a-ea868c573faf",
     "source": "PlanX",
     "service": {

diff --git a/examples/validPriorApproval.json b/examples/validPriorApproval.json
@@ -1097,7 +1097,7 @@
     }
   ],
   "metadata": {
-    "organisation": "southwark",
+    "organisation": "SWK",
     "id": "b18c301b-9d44-4c6c-8d27-5b5bf33c570b",
     "source": "PlanX",
     "service": {

diff --git a/schema/schema.json b/schema/schema.json
@@ -1167,7 +1167,8 @@
           "description": "Unique identifier for this application"
         },
         "organisation": {
-          "description": "UK Local Authority that this application is being submitted to",
+          "description": "The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority",
+          "maxLength": 4,
           "type": "string"
         },
         "schema": {
@@ -3140,7 +3141,8 @@
           "description": "Unique identifier for this application"
         },
         "organisation": {
-          "description": "UK Local Authority that this application is being submitted to",
+          "description": "The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority",
+          "maxLength": 4,
           "type": "string"
         },
         "schema": {

diff --git a/types/schema/Metadata.ts b/types/schema/Metadata.ts
@@ -12,9 +12,10 @@ export type Metadata = BaseMetadata | PlanXMetadata;
  */
 export interface BaseMetadata {
   /**
-   * @description UK Local Authority that this application is being submitted to
+   * @description The reference code for the organisation responsible for processing this planning application, sourced from planning.data.gov.uk/dataset/local-authority
+   * @maxLength 4
    */
-  organisation: string; // @todo align to DLUHC Planning Application API curie
+  organisation: string;
   /**
    * @description Unique identifier for this application
    */