From e78906da185fab00763c638373506d47c998f86d Mon Sep 17 00:00:00 2001 From: Aimee Gao Date: Fri, 20 Jun 2025 13:54:09 -0700 Subject: [PATCH 1/2] Update API specs matching the validation updates --- docs/business.yaml | 44 ++++++++++++++++++++++++++++++++++++-------- 1 file changed, 36 insertions(+), 8 deletions(-) diff --git a/docs/business.yaml b/docs/business.yaml index 2473ba3a45..767ec6c2b6 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -4108,7 +4108,8 @@ components: type: object required: - registeredOffice - description: 'Addresses related to the business. ' + - recordsOffice + description: 'Addresses related to the business.' properties: registeredOffice: $ref: '#/components/schemas/Office' @@ -4199,10 +4200,20 @@ components: required: - officer - deliveryAddress + - mailingAddress - appointmentDate - cessationDate offices: - $ref: '#/components/schemas/Office' + type: object + required: + - registeredOffice + - recordsOffice + description: 'Addresses related to the business.' + properties: + registeredOffice: + $ref: '#/components/schemas/Office' + recordsOffice: + $ref: '#/components/schemas/Office' required: - annualReport x-examples: @@ -4861,6 +4872,7 @@ components: files: type: array minItems: 1 + maxItems: 5 items: required: - fileKey @@ -4888,7 +4900,7 @@ components: $ref: '#/components/schemas/Name_translations' offices: type: object - description: 'Addresses related to the business. ' + description: 'Addresses related to the business.' properties: registeredOffice: $ref: '#/components/schemas/Office' @@ -4896,6 +4908,7 @@ components: $ref: '#/components/schemas/Office' required: - registeredOffice + - recordsOffice parties: type: array description: 'Persons having a role in the corporation eg: company officer.' @@ -4944,11 +4957,11 @@ components: type: string format: phone example: (250) 234-4433 - description: 'Phone number to be used to contact the business eg: (250) 234-4433.' + description: 'Phone number to be used to contact the business eg: (250) 234-4433, maximum 10 digits' extension: type: number example: 123 - description: Extension number of the business contact phone number (555) 555-5555. + description: 'Extension number of the business contact phone number (555) 555-5555, maximum 5 digits' required: - email Conversion: @@ -5290,8 +5303,10 @@ components: - lastName deliveryAddress: $ref: '#/components/schemas/Address' + description: 'Standard address format: apartment, unit, or street address number and street name. City, province or territory code, country, postal code and instructions for delivery. Required for Change of Directors filing and Annual Report filing.' mailingAddress: $ref: '#/components/schemas/Address' + description: 'Standard address format: apartment, unit, or street address number and street name. City, province or territory code, country, postal code and instructions for delivery. Required for Change of Directors filing and Annual Report filing.' title: type: string description: 'Official title or position of the director in the company.' @@ -5409,12 +5424,13 @@ components: description: 'Whether the company has liability or not: Yes/No.' parties: type: array - description: Can be the company directors or applicant of the filing. + description: Can be the company directors or applicant of the filing. This field is required for voluntary dissolution filings. items: $ref: '#/components/schemas/party' courtOrder: $ref: '#/components/schemas/Court_order' custodialOffice: + description: 'Corporations required custodial office when applying for voluntary dissolution.' $ref: '#/components/schemas/Office' affidavitFileKey: type: string @@ -6101,12 +6117,15 @@ components: $ref: '#/components/schemas/Name_translations' offices: type: object - description: 'Addresses related to the business. ' + description: 'Addresses related to the business.' properties: registeredOffice: $ref: '#/components/schemas/Office' recordsOffice: $ref: '#/components/schemas/Office' + required: + - registeredOffice + - recordsOffice parties: type: array description: 'Persons having a role in the corporation eg: company director.' @@ -6504,6 +6523,7 @@ components: description: Officer is a key management executive of the business deliveryAddress: $ref: '#/components/schemas/Address' + description: 'Required when the role type is Director or Custodian.' mailingAddress: $ref: '#/components/schemas/Address' title: @@ -6581,6 +6601,10 @@ components: title: Person Schema description: 'An individual that is currently or had previously occupied a role in relation to a business.' properties: + firstName: + type: string + maxLength: 30 + description: 'First name of the individual. Used in corporations filings.' givenName: type: string maxLength: 30 @@ -6589,6 +6613,10 @@ components: type: string maxLength: 30 description: Last name or surname of the individual. + lastName: + type: string + maxLength: 30 + description: 'Last name or surname of the individual. Used in corporations filings.' additionalName: type: string title: 'An additional name for a Person, can be used for a middle name.' @@ -6602,7 +6630,7 @@ components: type: string format: email example: abc.def@gov.bc.ca - description: email address of the individual for contact information. + description: email address of the individual for contact information. Required for corporation voluntary dissolution filings. x-examples: Example 1: givenName: John From fa7a877b77e2f021446cbefb64e920967a6447b7 Mon Sep 17 00:00:00 2001 From: Aimee Gao Date: Fri, 20 Jun 2025 14:32:25 -0700 Subject: [PATCH 2/2] Fix linting --- docs/business.yaml | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/business.yaml b/docs/business.yaml index 767ec6c2b6..6d8cc79872 100644 --- a/docs/business.yaml +++ b/docs/business.yaml @@ -5302,10 +5302,12 @@ components: - firstName - lastName deliveryAddress: - $ref: '#/components/schemas/Address' + allOf: + - $ref: '#/components/schemas/Address' description: 'Standard address format: apartment, unit, or street address number and street name. City, province or territory code, country, postal code and instructions for delivery. Required for Change of Directors filing and Annual Report filing.' mailingAddress: - $ref: '#/components/schemas/Address' + allOf: + - $ref: '#/components/schemas/Address' description: 'Standard address format: apartment, unit, or street address number and street name. City, province or territory code, country, postal code and instructions for delivery. Required for Change of Directors filing and Annual Report filing.' title: type: string @@ -5431,7 +5433,8 @@ components: $ref: '#/components/schemas/Court_order' custodialOffice: description: 'Corporations required custodial office when applying for voluntary dissolution.' - $ref: '#/components/schemas/Office' + allOf: + - $ref: '#/components/schemas/Office' affidavitFileKey: type: string title: The Identifier for affidavit file in file server @@ -6522,7 +6525,8 @@ components: - $ref: '#/components/schemas/Business' description: Officer is a key management executive of the business deliveryAddress: - $ref: '#/components/schemas/Address' + allOf: + - $ref: '#/components/schemas/Address' description: 'Required when the role type is Director or Custodian.' mailingAddress: $ref: '#/components/schemas/Address'