feat(DTFS-7052): added GET `/geospatial/addresses/postcode` endpoint for Ordnance Survey API data by avaitonis · Pull Request #804 · UK-Export-Finance/mdm-api

avaitonis · 2024-04-15T10:26:56Z

Introduction ✏️

We are moving integration with Ordnance Survey API from DTFS to MDM API.

Resolution ✔️

Added new helper module ordnance-survey
Added new module geospatial with endpoint /geospatial/addresses/postcode?postcode=SW1A2AQ
- returns same response format as DTFS.
- returns country field, DTFS was always returning {country: null}
- returns 200 [] for empty unsuccessful search.

Response example:

[
    {
        "organisationName": "CHURCHILL MUSEUM & CABINET WAR ROOMS",
        "addressLine1": "CLIVE STEPS KING CHARLES STREET",
        "addressLine2": null,
        "addressLine3": null,
        "locality": "LONDON",
        "postalCode": "SW1A 2AQ",
        "country": "England"
    }
]

Miscellaneous ➕

Refactored api-tests to solve typescript type error. Looks like it started because of supertest update.

…resses/postcode?postcode=W1A1AA

… lint. I added big examples to json files

…xternal-ordnance-survey-api

Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

test/support/generator/get-geospatial-addresses-generator.ts

src/helper-modules/ordnance-survey/ordnance-survey.service.test.ts

Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

…t.ts Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

oscar-richardson-softwire

LGTM

src/helper-modules/ordnance-survey/dto/get-search-postcode-ordnance-survey-query.dto.ts

…eyQueryDto

abhi-markan

Good work, few comments to address please.

.env.sample

src/config/ordnance-survey.config.test.ts

src/config/ordnance-survey.config.ts

src/constants/enums/geospatialCountries.ts

src/constants/geospatial.constant.ts

src/modules/geospatial/geospatial.service.ts

test/exposure-period/exposure-period.api-test.ts

test/geospatial/get-address-by-postcode.api-test.ts

… empty response from 200 to 404

…ut just in controller

…VEY_URL

src/modules/geospatial/geospatial.service.ts

sonarqubecloud · 2024-05-13T12:16:11Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
3.9% Duplication on New Code

See analysis details on SonarCloud

abhi-markan

LGTM 👍🏼

audrius-vaitonis added 14 commits April 10, 2024 09:20

feat(DTFS2-7052): new API modules and endpoint /api/v1/geospatial/add…

2cdd0de

…resses/postcode?postcode=W1A1AA

feat(DTFS2-7052): new module geospatial

14a6a08

feat(DTFS2-7052): fixed lint errors

17fea54

feat(DTFS2-7052): adding constants and examples

a3d5433

feat(DTFS2-7052): adding typescript include for json files, to satify…

0b79772

… lint. I added big examples to json files

feat(DTFS2-7052): trying to automate husky run on commit

1b6cf30

feat(DTFS2-7052): trying to automate husky run on commit

5fbf3d7

feat(DTFS2-7052): change husky install to same way as in DTFS project

889fe1b

feat(DTFS2-7052): work in progress of geospatial-get-address api tests

21f8006

feat(DTFS2-7052): package update

3259347

feat(DTFS2-7052): api-tests for geospatial/get-address-by-postcode

c8cb1bc

feat(DTFS2-7052): refactor api tests to match TFS and solve type issues

c91144d

feat(DTFS2-7052): tests for ordnance survey API endpoint

837a482

feat(DTFS2-7052): fix address line 1 formating

db50210

avaitonis added Type: Feature Type: chore labels Apr 15, 2024

Merge remote-tracking branch 'origin/main' into feat/DTFS2-7052/new-e…

0d86a35

…xternal-ordnance-survey-api

avaitonis temporarily deployed to qa April 15, 2024 10:51 — with GitHub Actions Inactive

avaitonis had a problem deploying to qa April 15, 2024 10:51 — with GitHub Actions Failure

avaitonis temporarily deployed to qa April 15, 2024 10:51 — with GitHub Actions Inactive

feat(DTFS2-7052): spelling fix

4c503ca

avaitonis temporarily deployed to qa April 15, 2024 10:56 — with GitHub Actions Inactive

avaitonis changed the title ~~feat: added GET /geospatial/addresses/postcode?postcode=SW1A2AQ endpoint for Ordnance Survey API data~~ feat(DTFS-7052): added GET /geospatial/addresses/postcode?postcode=SW1A2AQ endpoint for Ordnance Survey API data Apr 15, 2024

avaitonis requested review from AlexBramhill, abhi-markan and francescastocco April 15, 2024 11:13

audrius-vaitonis and others added 5 commits April 25, 2024 10:45

Update test/geospatial/get-address-by-postcode.api-test.ts

708533b

Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

feat(DTFS2-7052): actioning PR comments

7d15b07

feat(DTFS2-7052): actioning PR comments

e012eb4

feat(DTFS2-7052): updating API spec

15743c0

feat(DTFS2-7052): changing variables to use plural

c020867

oscar-richardson-softwire reviewed Apr 25, 2024

View reviewed changes

test/support/generator/get-geospatial-addresses-generator.ts Outdated Show resolved Hide resolved

oscar-richardson-softwire reviewed Apr 25, 2024

View reviewed changes

src/helper-modules/ordnance-survey/ordnance-survey.service.test.ts Outdated Show resolved Hide resolved

oscar-richardson-softwire reviewed Apr 25, 2024

View reviewed changes

src/helper-modules/ordnance-survey/ordnance-survey.service.test.ts Outdated Show resolved Hide resolved

oscar-richardson-softwire reviewed Apr 25, 2024

View reviewed changes

src/helper-modules/ordnance-survey/ordnance-survey.service.test.ts Outdated Show resolved Hide resolved

audrius-vaitonis and others added 4 commits April 25, 2024 14:43

Update test/support/generator/get-geospatial-addresses-generator.ts

e1ecd0d

Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

Update src/helper-modules/ordnance-survey/ordnance-survey.service.tes…

a6f33b4

…t.ts Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

Update src/helper-modules/ordnance-survey/ordnance-survey.service.tes…

370c342

…t.ts Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

Update src/helper-modules/ordnance-survey/ordnance-survey.service.tes…

90eb4d3

…t.ts Co-authored-by: oscar-richardson-softwire <116292912+oscar-richardson-softwire@users.noreply.github.com>

oscar-richardson-softwire previously approved these changes Apr 25, 2024

View reviewed changes

audrius-vaitonis added 2 commits April 25, 2024 15:12

feat(DTFS2-7049): adding new env variables to docker-compose.yml

3ca57f0

feat(DTFS2-7052): downgrade @commitlint/cli from 19.3.0 to 18.6.0

132d179

oscar-richardson-softwire reviewed Apr 29, 2024

View reviewed changes

src/helper-modules/ordnance-survey/dto/get-search-postcode-ordnance-survey-query.dto.ts Outdated Show resolved Hide resolved

feat(DTFS2-7052): removing unused class GetSearchPostcodeOrdnanceSurv…

32aa1ef

…eyQueryDto

abhi-markan suggested changes May 13, 2024

View reviewed changes

audrius-vaitonis added 4 commits May 13, 2024 09:23

feat(DTFS2-7052): code style improvements based on PR feedback

38939db

feat(DTFS2-7052): change GET /geospatial/addresses/postcode?postcode=…

33c9e65

… empty response from 200 to 404

feat(DTFS2-7052): changed numeric status code 200 to HttpStatus.OK, b…

3751992

…ut just in controller

feat(DTFS2-7052): changed documentation for .env setting ORDNANCE_SUR…

18fdf4a

…VEY_URL

abhi-markan suggested changes May 13, 2024

View reviewed changes

src/modules/geospatial/geospatial.service.ts Outdated Show resolved Hide resolved

feat(DTFS2-7052): tidying up map function

0da25c3

abhi-markan approved these changes May 13, 2024

View reviewed changes

This was referenced May 22, 2024

chore(main): release 1.18.0 #889

Merged

chore(main): release 1.19.0 #890

Merged

chore(main): release 1.20.0 #892

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(DTFS-7052): added GET `/geospatial/addresses/postcode` endpoint for Ordnance Survey API data#804

feat(DTFS-7052): added GET `/geospatial/addresses/postcode` endpoint for Ordnance Survey API data#804
avaitonis merged 61 commits intomainfrom
feat/DTFS2-7052/new-external-ordnance-survey-api

avaitonis commented Apr 15, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oscar-richardson-softwire left a comment

Uh oh!

Uh oh!

abhi-markan left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented May 13, 2024

Uh oh!

abhi-markan left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

avaitonis commented Apr 15, 2024

Introduction ✏️

Resolution ✔️

Miscellaneous ➕

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

oscar-richardson-softwire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

abhi-markan left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented May 13, 2024

Quality Gate passed

Uh oh!

abhi-markan left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants