Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

22717-adjust wordings based on the feedback doc and discussion #2912

Merged
merged 3 commits into from
Aug 13, 2024
Merged

22717-adjust wordings based on the feedback doc and discussion #2912

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a76e86a
adjust wordings based on the feedback doc and discussion
eason-pan-bc Aug 13, 2024
70195cc
adjust whitespace and first letter capitalization in the overview des…
eason-pan-bc Aug 13, 2024
fb7744a
fix typo and punctuation
eason-pan-bc Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 31 additions & 6 deletions docs/business.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,33 @@
title: businesses
version: '2.0'
description: |-
Businesses provideas all of the services needed to manage legal entities.
This encompasses all types of businesses authorized to do business by the Registrar.
The Business Registry is a centralized electronic register of all business in British Columbia. This encompasses all types of businesses authorized to do business by the Registrar. The Business API provides a secure means of integrating your business systems with the Registry.
<br/>
<br/>This API supports the following filings:
- Incorporation Application
- Amalgamation Regular
- Amalgamation Short Form Horizontal
- Amalgamation Short Form Vertical
- Continuation In
- Registration
- AGM Extension Information
- AGM Location Change Information
- Alteration
- Annual Report
- Change of Address
- Change of Directors
- Change of Entity Name
- Change of Registration
- Consent Continuation Out
- Conversion (to change the business type of an organization eg: convert from a Member Funded Society to a BC Company)
- Court Order Information
- Correction
- Dissolution
- Registration (Sole Proprietorship, General Partnership)
- Special Resolution
- Transition

All API requests must include a BC Registries issued API key and an Account ID.
contact:
name: BC Registry
email: [email protected]
Expand Down Expand Up @@ -943,7 +968,7 @@
value:
errorMessage: API backend third party service error.
rootCause: message:Internal server error
description: This endpoint is used to submit a filing for a business entity. This endpoint uses a standard header applicable to all filing types as well as specific schemas for each filing type.
description: This is used to submit all filing types that are used to maintain or change the state of the Registration of any business entity in the Registry to which the user has access to.
tags:
- business
requestBody:
Expand All @@ -954,7 +979,7 @@
examples:
agm-location-change-request:
summary: AGM Location Change Request
value:

Check failure on line 982 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   schema is invalid: data/properties/header/properties/header/properties/name/enum must NOT have duplicate items (items ## 4 and 9 are identical)
filing:
header:
date: '2024-07-18'
Expand All @@ -971,7 +996,7 @@
agmLocation: Victoria, BC, Canada
consent-continuation-out-request:
summary: Consent Continuation Out Request
value:

Check failure on line 999 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
name: consentContinuationOut
Expand All @@ -993,7 +1018,7 @@
effectOfOrder: planOfArrangement
voluntary-dissolution-request:
summary: Voluntary Dissolution Request
value:

Check failure on line 1021 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
date: '2024-07-18'
Expand Down Expand Up @@ -1062,7 +1087,7 @@
hasPlanOfArrangement: false
change-of-address-request:
summary: Change Of Address
value:

Check failure on line 1090 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
name: changeOfAddress
Expand Down Expand Up @@ -1129,7 +1154,7 @@
streetAddressAdditional:
agm-extension-request:
summary: AGM Extension Request
value:

Check failure on line 1157 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
name: agmExtension
Expand Down Expand Up @@ -1160,7 +1185,7 @@
isEligible: true
annual-report-request:
summary: Annual Report Request
value:

Check failure on line 1188 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
name: annualReport
Expand Down Expand Up @@ -1261,7 +1286,7 @@
actions: []
change-of-directors-request:
summary: Change Of Directors Request
value:

Check failure on line 1289 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
name: changeOfDirectors
Expand Down Expand Up @@ -1436,7 +1461,7 @@
- nameChanged
alteration-request:
summary: Alteration Request
value:

Check failure on line 1464 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
name: alteration
Expand Down Expand Up @@ -1550,7 +1575,7 @@
'404':
description: Not Found
operationId: get-businesses-identifier-addresses
description: Returns the current addresses for the businesses. The number of addresses are based on the legal type.
description: Returns the current addresses for the businesses. The number of addresses will depend on the requirements of the legal type of the business entity.
tags:
- business
parameters:
Expand Down Expand Up @@ -2417,7 +2442,7 @@
description: The accept mimetype of the object
- $ref: '#/components/parameters/accountId'
/businesses:
post:

Check warning on line 2445 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

operation-operationId      Operation must have "operationId".
summary: save business creation filing
tags:
- business
Expand Down Expand Up @@ -3022,7 +3047,7 @@
value:
errorMessage: API backend third party service error.
rootCause: message:You are not authorized to submit a filing for TgtPxoS4FF.
description: Submitting a creation filing for a business will create that type of business if it is a fully valid filing and payment has been completed.
description: Submit an application to create or incorporate a new business. The new business entity will be created in the Registry if it is a fully valid filing and payment has been completed.
requestBody:
content:
application/json:
Expand All @@ -3031,7 +3056,7 @@
examples:
incorporation-application-request:
summary: Incorporation Application Request
value:

Check failure on line 3059 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   schema is invalid: data/properties/header/properties/header/properties/name/enum must NOT have duplicate items (items ## 4 and 9 are identical)
filing:
header:
certifiedBy: API Specs
Expand Down Expand Up @@ -3116,7 +3141,7 @@
roleType: Director
amalgamation-regular-request:
summary: Amalgamation Regular Request
value:

Check failure on line 3144 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-valid-media-example   "value" property must have required property "header"
filing:
header:
accountId: 1234
Expand Down Expand Up @@ -3527,7 +3552,7 @@
schema:
$ref: '#/components/schemas/party'
operationId: get-businesses-identifier-parties
description: Get all associated parties with a business.
description: Get all parties (Incorporator, Completing Party and Directors) associated with a business.
parameters:
- $ref: '#/components/parameters/accountId'
/businesses/search:
Expand Down Expand Up @@ -3861,7 +3886,7 @@
orderDate: '2019-08-24T14:15:22Z'
effectOfOrder: The Company will cease operations
orderDetails: The Company is ordered to dissolve
Amalgamation_application:

Check warning on line 3889 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-unused-component      Potentially unused component has been detected.
type: object
title: Amalgamation Application Filing
description: 'Amalgamation_application'
Expand Down Expand Up @@ -4615,7 +4640,7 @@
timestamp: '2022-04-19 15:59:55'
reference:
businessId: C1234567
Continuation_in:

Check warning on line 4643 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

oas3-unused-component      Potentially unused component has been detected.
type: object
title: Continuation In Filing
description: Represents the filing for a foreign corporation applying to “continue in” to BC. To do so, authorization must have been received from the foreign jurisdiction. Authorization is typically in the form of a letter. The authorization must be sent to the registry as a precondition to this transaction.
Expand Down Expand Up @@ -5288,7 +5313,7 @@
name:
type: string
title: The type of the main filing.
enum:

Check warning on line 5316 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks 

duplicated-entry-in-enum   "enum" property must not have duplicate items (items ## 4 and 9 are identical)
- adminFreeze
- alteration
- agmExtension
Expand Down