@ideal-postcodes/openapi
Version:
Ideal Postcodes OpenAPI v3 specifications
693 lines (313 loc) • 27.1 kB
Markdown
## [4.10.1](https://github.com/ideal-postcodes/openapi/compare/4.10.0...4.10.1) (2025-01-28)
### Bug Fixes
* **Canada:** Fix lon/lat types ([7871f7d](https://github.com/ideal-postcodes/openapi/commit/7871f7d76f9dfa5217726ec1be7647f07cde43e4))
# [4.10.0](https://github.com/ideal-postcodes/openapi/compare/4.9.2...4.10.0) (2025-01-27)
### Features
* **Canada:** Add Canadian national address file ([b7130cd](https://github.com/ideal-postcodes/openapi/commit/b7130cd5ba657a99b6f6b3cebeb7b0edc8a34f57))
## [4.9.2](https://github.com/ideal-postcodes/openapi/compare/4.9.1...4.9.2) (2025-01-22)
### Bug Fixes
* **Release:** Trigger npm release ([ed7d92c](https://github.com/ideal-postcodes/openapi/commit/ed7d92c567508a373f23b321dd1cb10674f783ad))
## [4.9.1](https://github.com/ideal-postcodes/openapi/compare/4.9.0...4.9.1) (2025-01-20)
### Bug Fixes
* **Release:** Trigger new release ([d9bbada](https://github.com/ideal-postcodes/openapi/commit/d9bbadae958dc6bf206b4900d64c138f247ef697))
* **Release:** Trigger new release ([f6782db](https://github.com/ideal-postcodes/openapi/commit/f6782db92c1d67909335c248af30ce3e5cda576a))
* **Release:** Update GitHub action ([4850973](https://github.com/ideal-postcodes/openapi/commit/4850973f92246d50518ecf05ff5fd79cc1239b13))
# [4.9.0](https://github.com/ideal-postcodes/openapi/compare/4.8.0...4.9.0) (2025-01-20)
### Features
* **Denmark:** Add SDFI ([6602bd5](https://github.com/ideal-postcodes/openapi/commit/6602bd5d38cb8e586c5bd3dc42bb7e0755bab729))
# [4.8.0](https://github.com/ideal-postcodes/openapi/compare/4.7.0...4.8.0) (2024-07-10)
### Features
* **Language:** Add Assamese (as) language ([7962e54](https://github.com/ideal-postcodes/openapi/commit/7962e54ceae11072fa652335ea7f3cd485c78b5a))
# [4.7.0](https://github.com/ideal-postcodes/openapi/compare/4.6.2...4.7.0) (2024-05-21)
### Features
* **Verify:** Improve documentation ([dfba777](https://github.com/ideal-postcodes/openapi/commit/dfba7770097fde63ca90cbf202228ce7174e10dd))
# [4.7.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.6.2...4.7.0-beta.1) (2024-05-21)
### Features
* **Verify:** Improve documentation ([dfba777](https://github.com/ideal-postcodes/openapi/commit/dfba7770097fde63ca90cbf202228ce7174e10dd))
## [4.6.2](https://github.com/ideal-postcodes/openapi/compare/4.6.1...4.6.2) (2024-05-17)
### Bug Fixes
* **Keys APIs:** Fix user_token, start and end params ([ff4249e](https://github.com/ideal-postcodes/openapi/commit/ff4249edd4682bcf2047fea429b3819ccd084621))
## [4.6.2-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.6.1...4.6.2-beta.1) (2024-05-17)
### Bug Fixes
* **Keys APIs:** Fix user_token, start and end params ([ff4249e](https://github.com/ideal-postcodes/openapi/commit/ff4249edd4682bcf2047fea429b3819ccd084621))
## [4.6.1](https://github.com/ideal-postcodes/openapi/compare/4.6.0...4.6.1) (2024-05-16)
### Bug Fixes
* **Verify:** Correct field names ([b1b52fe](https://github.com/ideal-postcodes/openapi/commit/b1b52fee96a99ec11829f67c455d0cfb13c1b16d))
## [4.6.1-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.6.0...4.6.1-beta.1) (2024-05-14)
### Bug Fixes
* **Verify:** Correct field names ([b1b52fe](https://github.com/ideal-postcodes/openapi/commit/b1b52fee96a99ec11829f67c455d0cfb13c1b16d))
# [4.6.0](https://github.com/ideal-postcodes/openapi/compare/4.5.0...4.6.0) (2024-05-14)
### Features
* **Verify:** Add USPS Verification API ([19c08ab](https://github.com/ideal-postcodes/openapi/commit/19c08abd19694a20d71e4784ed8a602fd567cb68))
# [4.6.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.5.0...4.6.0-beta.1) (2024-05-14)
### Features
* **Verify:** Add USPS Verification API ([19c08ab](https://github.com/ideal-postcodes/openapi/commit/19c08abd19694a20d71e4784ed8a602fd567cb68))
# [4.5.0](https://github.com/ideal-postcodes/openapi/compare/4.4.0...4.5.0) (2024-04-30)
### Features
* **Norway:** Add Kartverket dataset ([33af702](https://github.com/ideal-postcodes/openapi/commit/33af7025c7a9a0cb66265295ed94017649ae803f))
# [4.5.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.4.0...4.5.0-beta.1) (2024-04-30)
### Features
* **Norway:** Add Kartverket dataset ([33af702](https://github.com/ideal-postcodes/openapi/commit/33af7025c7a9a0cb66265295ed94017649ae803f))
# [4.4.0](https://github.com/ideal-postcodes/openapi/compare/4.3.0...4.4.0) (2024-04-29)
### Features
* **Netherlands:** Add Kadaster ([30c03d8](https://github.com/ideal-postcodes/openapi/commit/30c03d8ad216bcbc72ad3d2d7f64af9bf200d68e))
# [4.4.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.3.0...4.4.0-beta.1) (2024-04-29)
### Features
* **Netherlands:** Add Kadaster ([30c03d8](https://github.com/ideal-postcodes/openapi/commit/30c03d8ad216bcbc72ad3d2d7f64af9bf200d68e))
# [4.3.0](https://github.com/ideal-postcodes/openapi/compare/4.2.1...4.3.0) (2024-02-19)
### Bug Fixes
* **USPS:** Add missing countries ([5ba5418](https://github.com/ideal-postcodes/openapi/commit/5ba5418cd3646551c4ab4b99d44517a7731b1ea9))
### Features
* **Rest of World:** Add additional countries ([dd13654](https://github.com/ideal-postcodes/openapi/commit/dd13654b0499e8c76dcce6c3f06906476b3dc093))
# [4.3.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/4.3.0-beta.1...4.3.0-beta.2) (2024-02-19)
### Bug Fixes
* **USPS:** Add missing countries ([5ba5418](https://github.com/ideal-postcodes/openapi/commit/5ba5418cd3646551c4ab4b99d44517a7731b1ea9))
# [4.3.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/4.2.1...4.3.0-beta.1) (2024-01-23)
### Features
* **Rest of World:** Add additional countries ([dd13654](https://github.com/ideal-postcodes/openapi/commit/dd13654b0499e8c76dcce6c3f06906476b3dc093))
## [4.2.1](https://github.com/ideal-postcodes/openapi/compare/4.2.0...4.2.1) (2023-11-29)
### Bug Fixes
* **Australia:** Fix GNAF schema ([d61d229](https://github.com/ideal-postcodes/openapi/commit/d61d229e5c693d736b39af07dec3758f75291ad6))
# [4.2.0](https://github.com/ideal-postcodes/openapi/compare/4.1.1...4.2.0) (2023-11-29)
### Features
* **Australia:** Add GNAF dataset ([644a8c7](https://github.com/ideal-postcodes/openapi/commit/644a8c7697507d203f1a65d070ae61bd4f1cab28))
## [4.1.1](https://github.com/ideal-postcodes/openapi/compare/4.1.0...4.1.1) (2023-11-02)
### Bug Fixes
* **Languages:** Add new supported language ([af87339](https://github.com/ideal-postcodes/openapi/commit/af873390473e05a47f1bd208c816217f8a137fbd))
# [4.1.0](https://github.com/ideal-postcodes/openapi/compare/4.0.1...4.1.0) (2023-09-05)
### Features
* **Keys:** Add new keys endpoint ([61c71d3](https://github.com/ideal-postcodes/openapi/commit/61c71d3f781f3ea1a4881c26acd4e42f081abc80))
## [4.0.1](https://github.com/ideal-postcodes/openapi/compare/4.0.0...4.0.1) (2023-07-07)
### Bug Fixes
* **ISO Code:** Update Country and Language Enums ([c95bc3d](https://github.com/ideal-postcodes/openapi/commit/c95bc3dee470aa4aed30c48e2bf936e7fc0bd0cb))
# [4.0.0](https://github.com/ideal-postcodes/openapi/compare/3.10.0...4.0.0) (2023-07-07)
### Features
* **OpenAPI:** Add Global Address datasets ([8b23829](https://github.com/ideal-postcodes/openapi/commit/8b238294cbc71352bfb33a9eed78c08e41d884ef))
### BREAKING CHANGES
* **OpenAPI:** Some operation IDs (i.e. endpoint identifiers) have been updated to better reflect
usage
# [3.10.0](https://github.com/ideal-postcodes/openapi/compare/3.9.6...3.10.0) (2023-04-26)
### Features
* **Phone:** Separate live carrier information ([118cc75](https://github.com/ideal-postcodes/openapi/commit/118cc75e602cafa3c837417a8c132e3058f8c865))
## [3.9.6](https://github.com/ideal-postcodes/openapi/compare/3.9.5...3.9.6) (2023-03-15)
### Bug Fixes
* **PAF:** Extends Postcode Type ([77e4bfd](https://github.com/ideal-postcodes/openapi/commit/77e4bfd22d0691c6fad997d01431999b5fe07a77))
## [3.9.5](https://github.com/ideal-postcodes/openapi/compare/3.9.4...3.9.5) (2023-03-14)
### Bug Fixes
* **AB:** Require id and dataset ([1792c1c](https://github.com/ideal-postcodes/openapi/commit/1792c1c6c8829ff101a8012b3966d4b03f1cfa05))
## [3.9.4](https://github.com/ideal-postcodes/openapi/compare/3.9.3...3.9.4) (2023-03-14)
### Bug Fixes
* **AB Core:** Add ID and dataset fields ([a3f8e94](https://github.com/ideal-postcodes/openapi/commit/a3f8e94701a6cdeebde19a4f046b607527a9ba75))
## [3.9.3](https://github.com/ideal-postcodes/openapi/compare/3.9.2...3.9.3) (2023-03-14)
### Bug Fixes
* **AB Core:** Add country iso ([e6710d0](https://github.com/ideal-postcodes/openapi/commit/e6710d0c9ac3de0a4bcd1c679410a7c1857225ed))
## [3.9.2](https://github.com/ideal-postcodes/openapi/compare/3.9.1...3.9.2) (2023-03-13)
### Bug Fixes
* **AB Core:** UPRNs delivered as strings ([5bf31e1](https://github.com/ideal-postcodes/openapi/commit/5bf31e1f6f23d2d299f76d380f94b3f8625d7b40))
## [3.9.1](https://github.com/ideal-postcodes/openapi/compare/3.9.0...3.9.1) (2023-03-13)
### Bug Fixes
* **AB Core:** Add to AB Core to UK endpoints ([1b3af9a](https://github.com/ideal-postcodes/openapi/commit/1b3af9acde6aef6cb0b751686ea7765c86b8c8dc))
# [3.9.0](https://github.com/ideal-postcodes/openapi/compare/3.8.0...3.9.0) (2023-03-10)
### Features
* **AB Core:** Add AddressBase core ([afbd719](https://github.com/ideal-postcodes/openapi/commit/afbd719b91698cd9817c2f5d5cbbfeacf1f3c5b9))
# [3.8.0](https://github.com/ideal-postcodes/openapi/compare/3.7.1...3.8.0) (2023-01-26)
### Features
* **Cleanse:** Add GBR cleanse API ([00fd5ef](https://github.com/ideal-postcodes/openapi/commit/00fd5eff56064f6d57e5513f70866a3c0803729c))
## [3.7.1](https://github.com/ideal-postcodes/openapi/compare/3.7.0...3.7.1) (2023-01-20)
### Bug Fixes
* **Datasets:** Add new dataset attributes ([681881b](https://github.com/ideal-postcodes/openapi/commit/681881bb5a819b12babe877ecc608f98c79c828e))
# [3.7.0](https://github.com/ideal-postcodes/openapi/compare/3.6.0...3.7.0) (2023-01-18)
### Features
* **Phone:** Add carrier information to response payload ([b6b826f](https://github.com/ideal-postcodes/openapi/commit/b6b826fdec74727e64b704a5f35fc990a3152b00))
# [3.6.0](https://github.com/ideal-postcodes/openapi/compare/3.5.1...3.6.0) (2023-01-10)
### Features
* **Eircode:** Add Eircode to postcode lookup ([969c019](https://github.com/ideal-postcodes/openapi/commit/969c019e5ba7af475ff48a8cf947174061c36376))
## [3.5.1](https://github.com/ideal-postcodes/openapi/compare/3.5.0...3.5.1) (2022-12-28)
### Bug Fixes
* **Phone:** Fix typo in URL ([a85a556](https://github.com/ideal-postcodes/openapi/commit/a85a556afddb7ef4fea3d7f3400a824cd4802fc4))
# [3.5.0](https://github.com/ideal-postcodes/openapi/compare/3.4.0...3.5.0) (2022-12-16)
### Features
* **Phone:** Add phone validation ([244fe91](https://github.com/ideal-postcodes/openapi/commit/244fe9180cc8858eaea1642d012844b82159619c))
# [3.4.0](https://github.com/ideal-postcodes/openapi/compare/3.3.0...3.4.0) (2022-12-08)
### Features
* **Email:** Email verification endpoint ([0204f92](https://github.com/ideal-postcodes/openapi/commit/0204f92a2e03cd767c763bb0f2e111fe6b768c7c))
# [3.3.0](https://github.com/ideal-postcodes/openapi/compare/3.2.0...3.3.0) (2022-10-26)
### Bug Fixes
* **Geonames:** Add native data attribute ([e063128](https://github.com/ideal-postcodes/openapi/commit/e063128b9eb642154c73accd1388ed77424916ef))
* **Geonames:** Allow sub admins to be nullable ([0d29ddb](https://github.com/ideal-postcodes/openapi/commit/0d29ddbde7e0f7576f0af719ded7d7b848a67d53))
* **Geonames:** Nullable dem and elevation ([7e247a0](https://github.com/ideal-postcodes/openapi/commit/7e247a025cbd03f57c33c5988703157b57d3f122))
* **Geonames:** Require country in suggestion ([dbd4566](https://github.com/ideal-postcodes/openapi/commit/dbd4566ed35610af5b148a3e56ebfaea6fbedfcf))
* **Places:** Fix typo ([0bc36d6](https://github.com/ideal-postcodes/openapi/commit/0bc36d6af56e4708fcea848bd362d910b8fc5a03))
* **Release:** Trigger beta release ([2205bd6](https://github.com/ideal-postcodes/openapi/commit/2205bd69299d60dc3a4f26c170622d92142c6de0))
### Features
* **Places:** Expose places API ([c9cd926](https://github.com/ideal-postcodes/openapi/commit/c9cd926121d0a7f2c323c44e436baebaa8350869))
# [3.3.0-beta.7](https://github.com/ideal-postcodes/openapi/compare/3.3.0-beta.6...3.3.0-beta.7) (2022-10-25)
### Bug Fixes
* **Geonames:** Nullable dem and elevation ([7e247a0](https://github.com/ideal-postcodes/openapi/commit/7e247a025cbd03f57c33c5988703157b57d3f122))
# [3.3.0-beta.6](https://github.com/ideal-postcodes/openapi/compare/3.3.0-beta.5...3.3.0-beta.6) (2022-10-25)
### Bug Fixes
* **Geonames:** Require country in suggestion ([dbd4566](https://github.com/ideal-postcodes/openapi/commit/dbd4566ed35610af5b148a3e56ebfaea6fbedfcf))
# [3.3.0-beta.5](https://github.com/ideal-postcodes/openapi/compare/3.3.0-beta.4...3.3.0-beta.5) (2022-10-25)
### Bug Fixes
* **Geonames:** Allow sub admins to be nullable ([0d29ddb](https://github.com/ideal-postcodes/openapi/commit/0d29ddbde7e0f7576f0af719ded7d7b848a67d53))
# [3.3.0-beta.4](https://github.com/ideal-postcodes/openapi/compare/3.3.0-beta.3...3.3.0-beta.4) (2022-10-25)
### Bug Fixes
* **Geonames:** Add native data attribute ([e063128](https://github.com/ideal-postcodes/openapi/commit/e063128b9eb642154c73accd1388ed77424916ef))
# [3.3.0-beta.3](https://github.com/ideal-postcodes/openapi/compare/3.3.0-beta.2...3.3.0-beta.3) (2022-10-24)
### Bug Fixes
* **Places:** Fix typo ([0bc36d6](https://github.com/ideal-postcodes/openapi/commit/0bc36d6af56e4708fcea848bd362d910b8fc5a03))
# [3.3.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/3.3.0-beta.1...3.3.0-beta.2) (2022-10-22)
### Bug Fixes
* **Release:** Trigger beta release ([2205bd6](https://github.com/ideal-postcodes/openapi/commit/2205bd69299d60dc3a4f26c170622d92142c6de0))
# [3.3.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/3.2.0...3.3.0-beta.1) (2022-10-20)
### Features
* **Places:** Expose places API ([c9cd926](https://github.com/ideal-postcodes/openapi/commit/c9cd926121d0a7f2c323c44e436baebaa8350869))
# [3.2.0](https://github.com/ideal-postcodes/openapi/compare/3.1.0...3.2.0) (2022-08-17)
### Bug Fixes
* **ApiKey:** Add required attrs ([e722fa5](https://github.com/ideal-postcodes/openapi/commit/e722fa567c11201bdaadab812f10f425af3cdeee))
### Features
* **Global Addresses:** Add native address formats ([7fda507](https://github.com/ideal-postcodes/openapi/commit/7fda507e5d1058df43ff0a9a308455ae38655106))
# [3.2.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/3.2.0-beta.1...3.2.0-beta.2) (2022-08-08)
### Bug Fixes
* **ApiKey:** Add required attrs ([2ff1c16](https://github.com/ideal-postcodes/openapi/commit/2ff1c16eb1bb6d985a6110b116ca3b4b048bd3cf))
# [3.2.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/3.1.0...3.2.0-beta.1) (2022-08-03)
### Features
* **Global Addresses:** Add native address formats ([d33e770](https://github.com/ideal-postcodes/openapi/commit/d33e770f88c86a805c0d90088495656dad6aa5b7))
# [3.1.0](https://github.com/ideal-postcodes/openapi/compare/3.0.0...3.1.0) (2022-07-19)
### Features
* **Attributes:** Add Language, Country and County Codes ([#90](https://github.com/ideal-postcodes/openapi/issues/90)) ([842547e](https://github.com/ideal-postcodes/openapi/commit/842547e13419385cb4a4100567ea32b71d28c789))
# [3.1.0-beta.7](https://github.com/ideal-postcodes/openapi/compare/3.1.0-beta.6...3.1.0-beta.7) (2022-07-10)
### Features
* **Keys:** Update to keys API ([cc37080](https://github.com/ideal-postcodes/openapi/commit/cc37080fb7654d0cd9eab3583e3b34f9fed9435c))
# [3.1.0-beta.6](https://github.com/ideal-postcodes/openapi/compare/3.1.0-beta.5...3.1.0-beta.6) (2022-06-30)
### Bug Fixes
* **Bump:** Increment version ([40d7a02](https://github.com/ideal-postcodes/openapi/commit/40d7a0260be4394f147eaeaca1df93679c3714f4))
# [3.1.0-beta.5](https://github.com/ideal-postcodes/openapi/compare/3.1.0-beta.4...3.1.0-beta.5) (2022-06-27)
### Bug Fixes
* **ECAD:** Remove ECAF ID from ECAD ([2605bee](https://github.com/ideal-postcodes/openapi/commit/2605beefd7eb7d88fa1bda4c32083e4f33dea31e))
* **ECAD:** Split locality address type ([c3efa32](https://github.com/ideal-postcodes/openapi/commit/c3efa32d850b0759f0d6597873259b81259e9b33))
# [3.1.0-beta.4](https://github.com/ideal-postcodes/openapi/compare/3.1.0-beta.3...3.1.0-beta.4) (2022-06-26)
### Bug Fixes
* **ECAD:** Include ID ([4f2a05e](https://github.com/ideal-postcodes/openapi/commit/4f2a05e693a5c30820c032d1c97db819ebdf4018))
# [3.1.0-beta.3](https://github.com/ideal-postcodes/openapi/compare/3.1.0-beta.2...3.1.0-beta.3) (2022-06-23)
### Bug Fixes
* **Eircode:** Add missing type to Eircbase ([0983e6a](https://github.com/ideal-postcodes/openapi/commit/0983e6a2150c4bf1eddafc03658282c308c0999f))
# [3.1.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/3.1.0-beta.1...3.1.0-beta.2) (2022-06-22)
### Features
* **Ireland:** Add Eircode Address ([1c7e992](https://github.com/ideal-postcodes/openapi/commit/1c7e992bea123e435042394f6b96e6cccad3f088))
# [3.1.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/3.0.0...3.1.0-beta.1) (2022-06-12)
### Features
* **Attributes:** Add Language, Country and County Codes ([3185f34](https://github.com/ideal-postcodes/openapi/commit/3185f343235c45929e7a28fc68437285dcf696bc))
# [3.0.0](https://github.com/ideal-postcodes/openapi/compare/2.1.1...3.0.0) (2022-06-07)
### Features
* **3.0.0:** API & Dataset Updates ([883abc7](https://github.com/ideal-postcodes/openapi/commit/883abc76d119f05310aca8f662c7b0221c8b3ceb))
* **GBR:** Add reverse geocoding parameters ([3d5d273](https://github.com/ideal-postcodes/openapi/commit/3d5d2730404253924159847d3706d156b1bad4f2))
* **PAF Alias:** Add PAF Alias ([8b42b86](https://github.com/ideal-postcodes/openapi/commit/8b42b86c4ec91aa9364ec8fc424437596575f324))
### BREAKING CHANGES
* **3.0.0:** - UK Address Suggestion formats for PAF, MR, NYB and PAFW have been
merged into one suggestion type for the UK
- Rename GlobalAddressSuggestion to AddressSuggestion
# [3.0.0-beta.3](https://github.com/ideal-postcodes/openapi/compare/3.0.0-beta.2...3.0.0-beta.3) (2022-06-02)
### Features
* **GBR:** Add reverse geocoding parameters ([3d5d273](https://github.com/ideal-postcodes/openapi/commit/3d5d2730404253924159847d3706d156b1bad4f2))
# [3.0.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/3.0.0-beta.1...3.0.0-beta.2) (2022-06-01)
### Features
* **PAF Alias:** Add PAF Alias ([8b42b86](https://github.com/ideal-postcodes/openapi/commit/8b42b86c4ec91aa9364ec8fc424437596575f324))
# [3.0.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/2.1.1...3.0.0-beta.1) (2022-05-04)
### Features
* **3.0.0:** API & Dataset Updates ([883abc7](https://github.com/ideal-postcodes/openapi/commit/883abc76d119f05310aca8f662c7b0221c8b3ceb))
### BREAKING CHANGES
* **3.0.0:** - UK Address Suggestion formats for PAF, MR, NYB and PAFW have been
merged into one suggestion type for the UK
- Rename GlobalAddressSuggestion to AddressSuggestion
## [2.1.1](https://github.com/ideal-postcodes/openapi/compare/2.1.0...2.1.1) (2022-05-03)
### Bug Fixes
* **Spec:** Bump version ([2454a15](https://github.com/ideal-postcodes/openapi/commit/2454a1519ef994eb99df1ed36d780548c7c54a6b))
# [2.1.0](https://github.com/ideal-postcodes/openapi/compare/2.0.1...2.1.0) (2022-05-03)
### Features
* **UK:** Add Welsh PAF responses ([39d7452](https://github.com/ideal-postcodes/openapi/commit/39d745297b56b081f30eec872e169d800abe0b5a))
# [2.1.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/2.0.1...2.1.0-beta.1) (2022-04-24)
### Features
* **UK:** Add Welsh PAF responses ([39d7452](https://github.com/ideal-postcodes/openapi/commit/39d745297b56b081f30eec872e169d800abe0b5a))
## [2.0.1](https://github.com/ideal-postcodes/openapi/compare/2.0.0...2.0.1) (2022-04-21)
### Bug Fixes
* **Exports:** Include TS file in package ([ac9bc2c](https://github.com/ideal-postcodes/openapi/commit/ac9bc2c177f11cdaca2f9cc9552492aec5a5aaf0))
# [2.0.0](https://github.com/ideal-postcodes/openapi/compare/1.2.0...2.0.0) (2022-04-20)
### Code Refactoring
* **Intl Address:** Reorganise for international addresses ([ffabeb0](https://github.com/ideal-postcodes/openapi/commit/ffabeb06121a18edab5f558f210859b475a4a22f))
### BREAKING CHANGES
* **Intl Address:** Major version bump as a precaution
API Paths have been retagged and reorganised. This should not cause a
change in functionality but we have noticed changes of this type can
sometimes produce a backwards incompatible change in API interface if
this package is consumed by a code generator.
# [1.2.0](https://github.com/ideal-postcodes/openapi/compare/1.1.0...1.2.0) (2022-04-05)
### Bug Fixes
* **USPS:** Add country ([2c935dd](https://github.com/ideal-postcodes/openapi/commit/2c935dd65d0ffe57674569f1f8629566c4e4e846))
* **USPS:** Add dual data types ([9491cae](https://github.com/ideal-postcodes/openapi/commit/9491caeaaf4079bf6e8c5bba37da907e5ff86667))
* **USPS:** Add USPS schema definitions ([eae2cf5](https://github.com/ideal-postcodes/openapi/commit/eae2cf53b6e67e187bb0e6f52fc15a689abe8d77))
* **USPS:** Narrow USPS typings ([c29aeaa](https://github.com/ideal-postcodes/openapi/commit/c29aeaacf8c9cde03f136d3a715ebb2a6c98a1e3))
* **USPS:** Update definitions ([22d1023](https://github.com/ideal-postcodes/openapi/commit/22d102310ce34eb5257687467cae36cacf628649))
### Features
* **Mocks:** Embed mock server ([b7bb5b9](https://github.com/ideal-postcodes/openapi/commit/b7bb5b9b9c10fb1d12af06e0e55f16147e4a0e26))
* **USPS:** Resolve addresses formated to US spec ([e67e728](https://github.com/ideal-postcodes/openapi/commit/e67e728ac6be11dab467a508fdc6fceacfd49364))
# [1.2.0-beta.4](https://github.com/ideal-postcodes/openapi/compare/1.2.0-beta.3...1.2.0-beta.4) (2022-04-03)
### Bug Fixes
* **USPS:** Add country ([2c935dd](https://github.com/ideal-postcodes/openapi/commit/2c935dd65d0ffe57674569f1f8629566c4e4e846))
# [1.2.0-beta.3](https://github.com/ideal-postcodes/openapi/compare/1.2.0-beta.2...1.2.0-beta.3) (2022-04-03)
### Bug Fixes
* **USPS:** Narrow USPS typings ([c29aeaa](https://github.com/ideal-postcodes/openapi/commit/c29aeaacf8c9cde03f136d3a715ebb2a6c98a1e3))
# [1.2.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/1.2.0-beta.1...1.2.0-beta.2) (2022-03-31)
### Bug Fixes
* **USPS:** Add dual data types ([9491cae](https://github.com/ideal-postcodes/openapi/commit/9491caeaaf4079bf6e8c5bba37da907e5ff86667))
# [1.2.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/1.1.0...1.2.0-beta.1) (2022-03-30)
### Bug Fixes
* **USPS:** Add USPS schema definitions ([eae2cf5](https://github.com/ideal-postcodes/openapi/commit/eae2cf53b6e67e187bb0e6f52fc15a689abe8d77))
* **USPS:** Update definitions ([22d1023](https://github.com/ideal-postcodes/openapi/commit/22d102310ce34eb5257687467cae36cacf628649))
### Features
* **Mocks:** Embed mock server ([b7bb5b9](https://github.com/ideal-postcodes/openapi/commit/b7bb5b9b9c10fb1d12af06e0e55f16147e4a0e26))
* **USPS:** Resolve addresses formated to US spec ([e67e728](https://github.com/ideal-postcodes/openapi/commit/e67e728ac6be11dab467a508fdc6fceacfd49364))
# [1.1.0-beta.6](https://github.com/ideal-postcodes/openapi/compare/1.1.0-beta.5...1.1.0-beta.6) (2022-03-29)
### Bug Fixes
* **USPS:** Add USPS schema definitions ([e9d07bf](https://github.com/ideal-postcodes/openapi/commit/e9d07bf675f73ca9b0fb3c58f2b54e4017f8a964))
# [1.1.0-beta.5](https://github.com/ideal-postcodes/openapi/compare/1.1.0-beta.4...1.1.0-beta.5) (2022-03-28)
### Features
* **Mocks:** Embed mock server ([5e65331](https://github.com/ideal-postcodes/openapi/commit/5e65331683d68cfb5d2f0728a46729206c9def93))
* **USPS:** Resolve addresses formated to US spec ([4a2d71d](https://github.com/ideal-postcodes/openapi/commit/4a2d71db3db88b8406d42b56ad04be816f968c9f))
# [1.1.0](https://github.com/ideal-postcodes/openapi/compare/1.0.2...1.1.0) (2022-02-08)
### Bug Fixes
* **Keys API:** Fix typo ([8a04adf](https://github.com/ideal-postcodes/openapi/commit/8a04adfe7bf393db3c221a6e6b98a089336a9b2f))
* **Postcodes:** Enforce union type for postcodes response ([78ae451](https://github.com/ideal-postcodes/openapi/commit/78ae451ec54a1a266c45ec431cbc8e04957f21a7))
### Features
* **USPS:** Add USPS typings ([887bd40](https://github.com/ideal-postcodes/openapi/commit/887bd40a5745b93f11a3dd676236663a056ed426))
* **Version:** Release beta branch ([d21166e](https://github.com/ideal-postcodes/openapi/commit/d21166e1ac0b2d9d97e829ad559bcbe10cadac7e))
# [1.1.0-beta.4](https://github.com/ideal-postcodes/openapi/compare/1.1.0-beta.3...1.1.0-beta.4) (2022-02-02)
### Bug Fixes
* **Postcodes:** Enforce union type for postcodes response ([770576d](https://github.com/ideal-postcodes/openapi/commit/770576d6ce25eb2097ef7b820687acfae9b18601))
# [1.1.0-beta.3](https://github.com/ideal-postcodes/openapi/compare/1.1.0-beta.2...1.1.0-beta.3) (2022-02-02)
### Bug Fixes
* **Keys API:** Fix typo ([0536732](https://github.com/ideal-postcodes/openapi/commit/053673201d70e2b52d5795464b94ab7aedf1ae99))
# [1.1.0-beta.2](https://github.com/ideal-postcodes/openapi/compare/1.1.0-beta.1...1.1.0-beta.2) (2022-02-02)
### Features
* **USPS:** Add USPS typings ([bbc7981](https://github.com/ideal-postcodes/openapi/commit/bbc798126b9bdc17328a5f2bd534aa7d37365d9f))
# [1.1.0-beta.1](https://github.com/ideal-postcodes/openapi/compare/1.0.2...1.1.0-beta.1) (2022-02-02)
### Features
* **Version:** Release beta branch ([7f13388](https://github.com/ideal-postcodes/openapi/commit/7f133887f8c81274b141c58e204d2fe002ec02b5))
## [1.0.2](https://github.com/ideal-postcodes/openapi/compare/1.0.1...1.0.2) (2021-09-28)
### Bug Fixes
* **Params:** tags, datasets ([514e9d9](https://github.com/ideal-postcodes/openapi/commit/514e9d981d676c144263300f9d5807774d1b31b8))
## [1.0.1](https://github.com/ideal-postcodes/openapi/compare/1.0.0...1.0.1) (2021-09-21)
### Bug Fixes
* **Dependant:** Dependent => Dependant ([98bc5b7](https://github.com/ideal-postcodes/openapi/commit/98bc5b7bf1e48293d0b69635ead4b5542785e4e9)), closes [#24](https://github.com/ideal-postcodes/openapi/issues/24)
# [1.0.0](https://github.com/ideal-postcodes/openapi/compare/0.0.1...1.0.0) (2021-08-30)
### Features
* **Rewrite:** Rewrite OpenAPI Spec ([d2926aa](https://github.com/ideal-postcodes/openapi/commit/d2926aaae891c5189c772a102116bb7e7e37b13c))
* **Typings:** Ship OpenAPI typings ([994754a](https://github.com/ideal-postcodes/openapi/commit/994754affbd9b538d0ff4809f45f2efcdbb1f77e))
### BREAKING CHANGES
* **Rewrite:** Full OpenAPI spec served from dist/
# Changelog
Any changes, including backwards incompatible changes will be listed here
## master
- Fix error response schema on `/postcodes/:postcode`
## 1.0.0 (16/04/2019)
- Initial release