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

Jump to bottom

feat(DTFS2-7121): create Companies House endpoint #821

Merged
merged 35 commits into from
May 31, 2024
Merged

feat(DTFS2-7121): create Companies House endpoint #821

merged 35 commits into from
May 31, 2024

Conversation

oscar-richardson-softwire
Copy link
Contributor

@oscar-richardson-softwire oscar-richardson-softwire commented May 3, 2024 •
edited
Loading

Introduction ✏️

We are moving integration with the Companies House API from DTFS to MDM API. This is a sub-task of DTFS2-7051 - once this PR is merged and tested, we make the changes to the DTFS codebase to consume this new endpoint and finish DTFS2-7051.

Resolution ✔️

  • Added a new helper module companies-house
  • Added a new module companies with endpoint /companies?registrationNumber=00000001
  • New endpoint returns same response format as DTFS; SIC code mapping has been moved from DTFS to MDM

@oscar-richardson-softwire oscar-richardson-softwire marked this pull request as draft May 13, 2024 09:29
@oscar-richardson-softwire oscar-richardson-softwire marked this pull request as ready for review May 15, 2024 08:25
abhi-markan
abhi-markan requested changes May 15, 2024
View reviewed changes
Copy link
Contributor

@abhi-markan abhi-markan left a comment

Choose a reason for hiding this comment

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

Good work, few comments to address please.

src/config/companies-house.config.ts Outdated Show resolved Hide resolved
src/modules/companies/companies.controller.test.ts Show resolved Hide resolved
src/modules/companies/companies.controller.test.ts Show resolved Hide resolved
src/modules/companies/companies.controller.test.ts Show resolved Hide resolved
src/modules/companies/companies.controller.ts Show resolved Hide resolved
src/modules/companies/examples/example-response-for-get-company-by-registration-number.json Show resolved Hide resolved
test/companies/get-company-by-registration-number.api-test.ts Show resolved Hide resolved
test/companies/get-company-by-registration-number.api-test.ts Outdated Show resolved Hide resolved
test/support/generator/get-company-generator.ts Outdated Show resolved Hide resolved
test/support/generator/get-company-generator.ts Show resolved Hide resolved
@oscar-richardson-softwire
feat(DTFS2-7121): add SIC code mapping to /companies endpoint
059feab
@oscar-richardson-softwire
fix(DTFS2-7121): add proper error handling for 404 in response to PR …
817656c 
…comments
@oscar-richardson-softwire
refactor(DTFS2-7121): move one-time test setup into beforeAll blocks …
8830f45 
…in response to PR comments
@oscar-richardson-softwire
refactor(DTFS2-7121): add constants in response to PR comments
ca76185
@oscar-richardson-softwire
refactor(DTFS2-7121): lint
d79f7b7
@oscar-richardson-softwire
feat(DTFS2-7121): add overseas company error handling in response to …
61b33d7 
…PR comments
@oscar-richardson-softwire
refactor(DTFS2-7121): lint
dcc4b97
@oscar-richardson-softwire
refactor(DTFS2-7121): improve typing on shuffleArray function
3001419
@oscar-richardson-softwire
refactor(DTFS2-7121): add 422 Swagger documentation
42015f3
@oscar-richardson-softwire
refactor(DTFS2-7121): lint
08388db
@oscar-richardson-softwire
fix(DTFS2-7121): correct typo in CHANGELOG.md causing cspell pipeline…
f4ca3ad 
… check to fail
@oscar-richardson-softwire
feat(DTFS2-7121): change response format to make mapping in DTFS easier
99287e1
@oscar-richardson-softwire oscar-richardson-softwire force-pushed the feat/DTFS2-7121/create-companies-house-endpoint branch from b0aebd4 to 99287e1 Compare May 31, 2024 12:56
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented May 31, 2024

Quality Gate Failed Quality Gate failed

Failed conditions
1 Security Hotspot

See analysis details on SonarCloud

@oscar-richardson-softwire oscar-richardson-softwire merged commit 7860528 into main May 31, 2024
16 of 17 checks passed
@oscar-richardson-softwire oscar-richardson-softwire deleted the feat/DTFS2-7121/create-companies-house-endpoint branch May 31, 2024 14:49
@abhi-markan abhi-markan mentioned this pull request May 31, 2024
Merged
abhi-markan added a commit that referenced this pull request Jun 4, 2024
@abhi-markan
chore(main): release 1.21.0 (#906)
e8a8300 
🤖 I have created a release *beep* *boop*
---


##
[1.21.0](v1.20.0...v1.21.0)
(2024-06-04)


### Features

* **DTFS-7049:** added POST /emails endpoint for sending emails using
GOV.UK Notify service
([#820](#820))
([3a1bf0e](3a1bf0e))
* **DTFS2-7049:** fixed tests caused by removal of global transformer
and allowing extra params
([71e44ff](71e44ff))
* **DTFS2-7049:** fixing PR issues
([e0e099e](e0e099e))
* **DTFS2-7049:** removed BadRequestException tests moving payload to
object instead of array
([3bb8d71](3bb8d71))
* **DTFS2-7049:** return error message as string instead of array
([86b5b4d](86b5b4d))
* **DTFS2-7049:** test unknown Gov.UK Notify responses
([c14fa49](c14fa49))
* **DTFS2-7121:** create Companies House endpoint
([#821](#821))
([7860528](7860528))


### Bug Fixes

* **eslint:** reverted back to eslint `8.57.0`
([#905](#905))
([75ca97c](75ca97c))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@avaitonis avaitonis avaitonis left review comments

@abhi-markan abhi-markan abhi-markan approved these changes

@AlexBramhill AlexBramhill Awaiting requested review from AlexBramhill

Assignees

@oscar-richardson-softwire oscar-richardson-softwire

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@oscar-richardson-softwire @avaitonis @abhi-markan