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

22707 - Update wording for GET /businesses/{identifier}/documents/{documentName} #2910

Merged
merged 2 commits into from
Aug 13, 2024
Merged

22707 - Update wording for GET /businesses/{identifier}/documents/{documentName} #2910

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de83d0e
Update wording for GET /businesses/{identifier}/documents/{documentName}
AimeeGao Aug 13, 2024
3a5a0ea
Update wording for legalType and alternateNames
AimeeGao 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
20 changes: 10 additions & 10 deletions docs/business.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -954,7 +954,7 @@
examples:
agm-location-change-request:
summary: AGM Location Change Request
value:

Check failure on line 957 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 +971,7 @@
agmLocation: Victoria, BC, Canada
consent-continuation-out-request:
summary: Consent Continuation Out Request
value:

Check failure on line 974 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 +993,7 @@
effectOfOrder: planOfArrangement
voluntary-dissolution-request:
summary: Voluntary Dissolution Request
value:

Check failure on line 996 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 +1062,7 @@
hasPlanOfArrangement: false
change-of-address-request:
summary: Change Of Address
value:

Check failure on line 1065 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 +1129,7 @@
streetAddressAdditional:
agm-extension-request:
summary: AGM Extension Request
value:

Check failure on line 1132 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 +1160,7 @@
isEligible: true
annual-report-request:
summary: Annual Report Request
value:

Check failure on line 1163 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 +1261,7 @@
actions: []
change-of-directors-request:
summary: Change Of Directors Request
value:

Check failure on line 1264 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 +1436,7 @@
- nameChanged
alteration-request:
summary: Alteration Request
value:

Check failure on line 1439 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 @@ -2405,7 +2405,7 @@
reportType: lseal
stateFilings: []
operationId: get-businesses-identifier-document-documentName
description: Return the requested document.
description: Retrieves a specific document for the specified business.
parameters:
- schema:
type: string
Expand All @@ -2417,7 +2417,7 @@
description: The accept mimetype of the object
- $ref: '#/components/parameters/accountId'
/businesses:
post:

Check warning on line 2420 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 @@ -3031,7 +3031,7 @@
examples:
incorporation-application-request:
summary: Incorporation Application Request
value:

Check failure on line 3034 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 +3116,7 @@
roleType: Director
amalgamation-regular-request:
summary: Amalgamation Regular Request
value:

Check failure on line 3119 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 @@ -3861,7 +3861,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 3864 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 @@ -4112,13 +4112,13 @@
registeredDate: '2022-04-16T21:36:07.009977+00:00'
startDate: '2022-04-10'
type: 'DBA'
description: 'Organization or enterprising entity engaged in commercial, industrial, or professional activities.'
description: 'Organization or business entity.'
properties:
lastLedgerTimestamp:
type: string
format: date-time
example: '2020-11-24T18:24:27.179623+00:00'
description: Recorded date/time of a company's financial transactions.
description: Recorded date/time of a company's filing.
fiscalYearEndDate:
type: string
format: date
Expand All @@ -4133,15 +4133,15 @@
type: string
format: date-time
example: '2020-11-24T18:23:53.498863+00:00'
description: 'The date written on the company''s certificate of incorporation. '
description: 'The date written on the company''s certificate of incorporation, amalgamation, Continuation In or registration.'
chenhongjing marked this conversation as resolved.
Show resolved Hide resolved
identifier:
type: string
example: 'BC1234567 is an identifier for a corporation '
pattern: '^[A-Z]{1,3}[0-9]{7}|T[A-Za-z0-9]{9}$'
description: 'Unique code(letters & numbers) to identify a business, issued by the provincial or federal registry.'
legalName:
type: string
description: Name that appears on the formation document of the business.
description: Registered name of the business.
example: '1234567 B.C. Ltd. is a legal name for a corporation '
state:
type: string
Expand Down Expand Up @@ -4200,18 +4200,18 @@
- XP
- XS
example: 'GP: General Partnership'
description: 'Type of business eg: individual(SP), partnership(GP).'
description: 'Type of business eg: BC corporation (B), Continued in corporation (C), Sole proprietor(SP), partnership(GP).'
chenhongjing marked this conversation as resolved.
Show resolved Hide resolved
taxId:
type: string
pattern: '^[0-9]{9}$'
example: BN123456789
description: 'Company unique business number assigned by CRA: BN9 or BN15. '
goodStanding:
type: boolean
description: Being in good standing means that the company is not in the process of being dissolved for non-filing of federal and/or provincial tax returns or non-filing of the BC annual report.
description: The business is up to date with required filings, e.g. Annual Report.
adminFreeze:
type: boolean
description: 'Example: If a business is not in good standing or investigated for fraud BC Registry Admin might freeze the business to prevent further filing from them. '
description: The business has been placed in a Frozen state by the Registry which will prevent any further filings from being made.
naics:
$ref: '#/components/schemas/Naics'
natureOfBusiness:
Expand Down Expand Up @@ -4240,7 +4240,7 @@
example: '''https://LEGAL-API-HOST/api/v2/businesses/IDENTIFIER/filings/FILING_ID'''
alternateNames:
type: array
description: The alternate name of the business
description: The alternate name of the business. Only applicable for Sole Proprietorship(SP) and General Partnership(GP).
items:
type: object
properties:
Expand Down Expand Up @@ -4615,7 +4615,7 @@
timestamp: '2022-04-19 15:59:55'
reference:
businessId: C1234567
Continuation_in:

Check warning on line 4618 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 +5288,7 @@
name:
type: string
title: The type of the main filing.
enum:

Check warning on line 5291 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 Expand Up @@ -6129,7 +6129,7 @@
Naics:
type: object
title: NAICS Schema
description: NAICS is an abbreviation for The North American Industry Classification System and is a standard used to classify business activities.
description: NAICS is an abbreviation for The North American Industry Classification System and is a standard used to classify business activities. NAICS information is not required or collected for all types of business entities.
properties:
naicsCode:
type: string
Expand Down