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.

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

Test oas ci #2885

Closed
wants to merge 20 commits into from
8 changes: 2 additions & 6 deletions .github/workflows/legal-oas-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,10 @@ defaults:
run:
shell: bash
working-directory: .

permissions:
contents: write
actions: read
checks: write


jobs:
business-oas-ci:
uses: bcgov/bcregistry-sre/.github/workflows/oas-ci.yaml@main
with:
working_directory: "."
oas_file_directory: "./docs"
1 change: 1 addition & 0 deletions .spectral.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
extends: ["spectral:oas", "spectral:asyncapi"]
2 changes: 1 addition & 1 deletion docs/business.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
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.
This encompasses all types of businesses authorized to do business by the Registrar. 111
contact:
name: BC Registry
email: [email protected]
Expand Down Expand Up @@ -1213,7 +1213,7 @@
addressRegion:
type: string
maxLength: 2
example: 'BC for British Columbia '

Check failure on line 1216 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must not have more than 2 characters
description: '2 char code for province, state, territory or district.'
addressCountry:
type: string
Expand Down Expand Up @@ -1256,7 +1256,7 @@
enum:
- sample
- custom
example: Sample or custom

Check failure on line 1259 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must be equal to one of the allowed values: "sample", "custom"
description: 'Example: Sample and custom'
required:
- agreementType
Expand Down Expand Up @@ -1455,7 +1455,7 @@
cessationDate:
type: string
format: date
example: 'Date the officer has ended his/her role '

Check failure on line 1458 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must match format "date"
description: Date the director or officer has been terminated in the role.
required:
- officer
Expand Down Expand Up @@ -1604,12 +1604,12 @@
- SP
- GP
- BC
example: 'GP: General Partnership'

Check failure on line 1607 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must be equal to one of the allowed values: "BEN", "CP", "SP", "GP", "BC"
description: 'Type of business eg: individual(SP), partnership(GP).'
taxId:
type: string
pattern: '^[0-9]{9}$'
example: BN123456789

Check failure on line 1612 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must match pattern "^[0-9]{9}$"
description: 'Company unique business number assigned by CRA: BN9 or BN15. '
goodStanding:
type: boolean
Expand Down Expand Up @@ -1682,7 +1682,7 @@
format: date
description: The end date of the alternate name (reserved for future use)
nullable: true
example: ''

Check failure on line 1685 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must match format "date"
type:
type: string
description: The type of the alternate name
Expand Down Expand Up @@ -2002,7 +2002,7 @@
description: 'Phone number to be used to contact the business eg: (250) 234-4433.'
extension:
type: number
example: (555) 555-5555

Check failure on line 2005 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property type must be number
description: Extension number of the business contact phone number (555) 555-5555.
required:
- email
Expand Down Expand Up @@ -2155,7 +2155,7 @@
- CP
- HC
- CSC
example: '''CP'''

Check failure on line 2158 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must be equal to one of the allowed values: "CP", "HC", "CSC"
description: 'Defines cooperatives by type of membership eg: Financial Cooperatives.'
rulesFileKey:
type: string
Expand Down Expand Up @@ -2534,14 +2534,14 @@
- COMPLETED
- ERROR
description: 'Status of the filing eg: ''draft''. '
example: '"DRAFT", "PENDING", "COMPLETED", "ERROR"'

Check failure on line 2537 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property must be equal to one of the allowed values: "DRAFT", "PENDING", "COMPLETED", "ERROR"
affectedFilings:
type: array
title: List of affected filings (ids) from this filing.
description: 'Filings related to the header eg: [1234,4856].'
items:
type: integer
example: '[1234,4856]'

Check failure on line 2544 in docs/business.yaml

View workflow job for this annotation

GitHub Actions / business-oas-ci / spectralChecks

oas3-valid-schema-example "example" property type must be integer
isCorrected:
type: boolean
title: Has this filing been corrected?
Expand Down Expand Up @@ -3390,7 +3390,7 @@
postalCode: V8R 2P1
deliveryInstructions: '"Our apartment is located at the back of the building."'
title: Chief Executive Officer
party - copy:

Check warning on line 3393 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
x-stoplight:
id: ee4nvid30gu0u
Expand Down Expand Up @@ -3994,7 +3994,7 @@
BN: '123456789'
target: string
weight: 0
Suggestion_item - copy:

Check warning on line 3997 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
x-stoplight:
id: 21kymuins8gxo
Expand Down