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

incorporation application changes for api spec #2871

Merged

Conversation

PaulGarewal
Copy link
Contributor

Issue #: /bcgov/entity#22115

Description of changes:

  • New PR for incorporation application api spec
  • Created new pr with addressed comments

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of the lear license (Apache 2.0).

docs/business.yaml Outdated Show resolved Hide resolved
docs/business.yaml Outdated Show resolved Hide resolved
docs/business.yaml Outdated Show resolved Hide resolved
docs/business.yaml Outdated Show resolved Hide resolved
@ketaki-deodhar
Copy link
Collaborator

Add 'Not authorized to submit' response examples in API spec and also in Postman collection. Something similar to amalgamation. See below screenshot.

image

Copy link
Collaborator

@eason-pan-bc eason-pan-bc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, after editing the specs, consider updating requests in the Postman collection accordingly.

docs/oas/business.yaml Outdated Show resolved Hide resolved
docs/oas/business.yaml Show resolved Hide resolved
docs/oas/business.yaml Outdated Show resolved Hide resolved
Copy link

sonarcloud bot commented Jul 31, 2024

Copy link
Collaborator

@AimeeGao AimeeGao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🐱

@ketaki-deodhar
Copy link
Collaborator

ketaki-deodhar commented Jul 31, 2024

Add 'Not authorized to submit' response examples in API spec and also in Postman collection. Something similar to amalgamation. See below screenshot.

image

I tried to test 401 in Postman 'not authorized' endpoint and did not show correct response. Please fix that

@ketaki-deodhar
Copy link
Collaborator

Looks good apart from my latest comment for postman collection

Copy link
Collaborator

@eason-pan-bc eason-pan-bc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 😃

@PaulGarewal PaulGarewal merged commit 5f8cbf2 into bcgov:api-spec-updates Jul 31, 2024
3 checks passed
@PaulGarewal PaulGarewal deleted the 22115-incorporation-app-spec branch July 31, 2024 23:54
argush3 added a commit that referenced this pull request Aug 20, 2024
* 22301-update change agm location (#2846)

* add AGM_location_change schema
* update filing_head schema
* update Filing schema
* update business schema
* add example - agm location change to the filing path
* add 3 failed response examples - missing location, reason, year

* 22295-update-consent-to-continue-out-spec  (#2847)

* Update consent continuation out filing doc

* 22297-update voluntary dissolution spec (#2852)

* Update related schemas for voluntary dissolution 
* update examples names in agm location change to follow naming convensions, update submiter and payment info to mocks
* add request and response examples for voluntary dissolution
* update example info for get the certificate of good standing
* remove all taxId fields in x-examples under Party and Officer/Person

* 22114 - add change of address api specs (#2855)

* 22114 - add change of address api specs

* 22114 - update request and response

* 22114 - revert changes for actions

* 22114 - update names and objects

* 22114 - update as per naming convention and responses

* 22114 - update response name

* 22294 update agm extension spec (#2857)

* Update Agm extension schema and spec.

* 22300-update annual report spec (#2860)

* Updated relevant schemas -- Annual_report, office
* Added request and response examples for annual report filing

* 22211 - add amalgamation spec (#2863)

* 22211 - add amalgamation spec

* 22211 - update response name

* 22211 - updates

* 22211 - updates

* 22211 - updates

* 22211 - updates

* 22211 - updates

* 22211 - updates

* 22211 - updates

* 22293 update change of directors spec (#2864)

* Update change of directors spec

* 22298-update alterations specs (#2866)

* update relevant schemas (name_request, name_translation, court_order)
* add request and response examples for alterations

* add CI workflow for legal api specs (#2874)

Add OAS CI workflow to api-spec-updates branch for docs/business.yaml file so any updates to api spec are linted.

* update folder structure and oas-ci workflow (#2877)

- moved business.yaml under docs/oas/
- updated the file path in oas-ci
- Will have a test PR after this PR merged. Try to see if this change can make the lint check work properly.

* add permissions section (#2880)

add permissions section

* incorporation application changes for api spec (#2871)

* incorporation application changes for api spec

* removed id from request body

* replaced date and nrnum

* replaced account id with mock val

* fixed indent

* added 401 unauthorized response

* changed date string types and values

* update workflow file and folder structure for business.yaml according to the latest oas-ci changes (#2888)

* updated the oas ci file based on suggestions from Patrick Wei
* moved the business.yaml to ./docs, since the oas ci in SRE repo has now changed

* 22212 - add continuation in spec (#2891)

* Update API Specs authentication requirements info (#2896)

* Update wording for POST /businesses/{identifier}/filings (#2906)

Adjust wording for POST /businesses/{identifier}/filings endpoint

* Update wording for GET /businesses/{identifier}/filings (#2908)

Update wording for GET /businesses/{identifier}/filings endpoint

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

Update wording for GET /businesses/{identifier}/documents/{documentName} endpoint

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

* adjust wordings based on the feedback doc and discussion for business overview section and related items

* 22700 - Sorted filing request and response examples alphabetically (#2917)

Sorted filing request and response examples alphabetically for POST /businesses/{identifier}/filings

* Update spec wordings (#2914)

* update spec wording

* fix duplicate issue

* 22698 - fix linting issues related to 7 filings (#2919)

* removed the duplications in the enums
* adjusted the required item in the Filing schema to filing which is the one in Business Schemas
* adjusted filing_header schema to fit the updated filing schema
* adjusted examples didn't meet requirements in schemas

* Sort examples alphabetically (#2920)

* update spec wording

* fix duplicate issue

* arrange in alphabetical order

* fix lint issue

* Fix linting issues (#2921)

* update spec wording

* fix duplicate issue

* arrange in alphabetical order

* fix lint issue

* fix linting issue 1

* fix linting issue 1

* fix linting issue 2

* fix linting issue 3

* fix linting issue 4

---------

Co-authored-by: EasonPan <[email protected]>
Co-authored-by: Aimee <[email protected]>
Co-authored-by: ketaki-deodhar <[email protected]>
Co-authored-by: PaulG <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants