11563 registration and changeOfRegistration schema to support busines…

…sOffice (#91)
bcgov · Mar 29, 2022 · 7be2b17 · 7be2b17
1 parent 31ba464
commit 7be2b17
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 39 deletions.
diff --git a/src/registry_schemas/example_data/schema_data.py b/src/registry_schemas/example_data/schema_data.py
@@ -1393,20 +1393,22 @@
         'taxId': '123456789',
         'identifier': 'TOiakmfuF2'
     },
-    'businessAddress': {
-        'deliveryAddress': {
-            'streetAddress': 'delivery_address - address line one',
-            'addressCity': 'delivery_address city',
-            'addressCountry': 'Canada',
-            'postalCode': 'H0H0H0',
-            'addressRegion': 'BC'
-        },
-        'mailingAddress': {
-            'streetAddress': 'mailing_address - address line one',
-            'addressCity': 'mailing_address city',
-            'addressCountry': 'Canada',
-            'postalCode': 'H0H0H0',
-            'addressRegion': 'BC'
+    'offices': {
+        'businessOffice': {
+            'deliveryAddress': {
+                'streetAddress': 'delivery_address - address line one',
+                'addressCity': 'delivery_address city',
+                'addressCountry': 'Canada',
+                'postalCode': 'H0H0H0',
+                'addressRegion': 'BC'
+            },
+            'mailingAddress': {
+                'streetAddress': 'mailing_address - address line one',
+                'addressCity': 'mailing_address city',
+                'addressCountry': 'Canada',
+                'postalCode': 'H0H0H0',
+                'addressRegion': 'BC'
+            }
         }
     },
     'contactPoint': {
@@ -1493,20 +1495,22 @@
         },
         'identifier': 'FM1234567'
     },
-    'businessAddress': {
-        'deliveryAddress': {
-            'streetAddress': 'delivery_address - address line one',
-            'addressCity': 'delivery_address city',
-            'addressCountry': 'Canada',
-            'postalCode': 'H0H0H0',
-            'addressRegion': 'BC'
-        },
-        'mailingAddress': {
-            'streetAddress': 'mailing_address - address line one',
-            'addressCity': 'mailing_address city',
-            'addressCountry': 'Canada',
-            'postalCode': 'H0H0H0',
-            'addressRegion': 'BC'
+    'offices': {
+        'businessOffice': {
+            'deliveryAddress': {
+                'streetAddress': 'delivery_address - address line one',
+                'addressCity': 'delivery_address city',
+                'addressCountry': 'Canada',
+                'postalCode': 'H0H0H0',
+                'addressRegion': 'BC'
+            },
+            'mailingAddress': {
+                'streetAddress': 'mailing_address - address line one',
+                'addressCity': 'mailing_address city',
+                'addressCountry': 'Canada',
+                'postalCode': 'H0H0H0',
+                'addressRegion': 'BC'
+            }
         }
     },
     'contactPoint': {

diff --git a/src/registry_schemas/schemas/change_of_registration.json b/src/registry_schemas/schemas/change_of_registration.json
@@ -15,16 +15,21 @@
             ],
             "anyOf": [
                 {"required": ["business"]},
-                {"required": ["businessAddress"]},
+                {"required": ["offices"]},
                 {"required": ["nameRequest"]},
                 {"required": ["parties"]}
             ],
             "properties": {
                 "business": {
                     "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/business#/properties/business"
                 },
-                "businessAddress": {
-                    "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/office"
+                "offices": {
+                    "businessOffice": {
+                        "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/office"
+                    },
+                    "required": [
+                        "businessOffice"
+                    ]
                 },
                 "contactPoint": {
                     "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/contactPoint"

diff --git a/src/registry_schemas/schemas/registration.json b/src/registry_schemas/schemas/registration.json
@@ -12,7 +12,7 @@
             "type": "object",
             "required": [
                 "nameRequest",
-                "businessAddress",
+                "offices",
                 "parties",
                 "contactPoint",
                 "startDate"
@@ -21,8 +21,13 @@
                 "business": {
                     "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/business#/properties/business"
                 },
-                "businessAddress": {
-                    "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/office"
+                "offices": {
+                    "businessOffice": {
+                        "$ref": "https://bcrs.gov.bc.ca/.well_known/schemas/office"
+                    },
+                    "required": [
+                        "businessOffice"
+                    ]
                 },
                 "businessType": {
                     "type": "string",

diff --git a/src/registry_schemas/version.py b/src/registry_schemas/version.py
@@ -22,4 +22,4 @@
 Development release segment: .devN
 """
 
-__version__ = '2.15.20'  # pylint: disable=invalid-name
+__version__ = '2.15.21'  # pylint: disable=invalid-name
diff --git a/tests/unit/test_change_of_registration.py b/tests/unit/test_change_of_registration.py
@@ -52,7 +52,7 @@ def test_validate_valid_change_of_registration_with_any_required_element():
     """Assert valid if all of the required elements are present."""
     change_of_registration_json = copy.deepcopy(CHANGE_OF_REGISTRATION)
     del change_of_registration_json['nameRequest']
-    del change_of_registration_json['businessAddress']
+    del change_of_registration_json['offices']
     del change_of_registration_json['parties']
     del change_of_registration_json['courtOrder']
     legal_filing = {'changeOfRegistration': change_of_registration_json}
@@ -71,7 +71,7 @@ def test_validate_invalid_change_of_registration_with_no_required_element():
     """Assert not valid if required elements are not present."""
     change_of_registration_json = copy.deepcopy(CHANGE_OF_REGISTRATION)
     del change_of_registration_json['nameRequest']
-    del change_of_registration_json['businessAddress']
+    del change_of_registration_json['offices']
     del change_of_registration_json['parties']
     del change_of_registration_json['business']
     legal_filing = {'changeOfRegistration': change_of_registration_json}
@@ -116,4 +116,3 @@ def test_validate_invalid_name_request_change_of_registration():
     print(errors)
 
     assert not is_valid
-
diff --git a/tests/unit/test_registration.py b/tests/unit/test_registration.py
@@ -157,7 +157,7 @@ def test_validate_valid_registration_with_any_required_element():
 @pytest.mark.parametrize('element', [
     'contactPoint',
     'parties',
-    'businessAddress',
+    'offices',
     'nameRequest',
     'startDate'
 ])