Update data source for World Location methods #1203
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This method currently returns data retrieved from the Whitehall API,
which is being deprecated.
Therefore updating the method to get the data from the World Content
Item.
We need to transform the response to ensure the output remains backwards
compatible with previous versions of this gem.
====
Example:
Response using Whitehall API
```
=> {"id"=>"https://www.gov.uk/api/world-locations/france",
"title"=>"France",
"format"=>"World location",
"updated_at"=>"2017-08-28T09:40:55.000+01:00",
"web_url"=>"https://www.gov.uk/world/france",
"analytics_identifier"=>"WL48",
"details"=>{"slug"=>"france", "iso2"=>"FR"},
"organisations"=>{"id"=>"https://www.gov.uk/api/world-locations/france/organisations", "web_url"=>"https://www.gov.uk/world/france#organisations"},
"content_id"=>"5e9f00ce-7706-11e4-a3cb-005056011aef",
"_response_info"=>{"status"=>"ok", "links"=>[{"href"=>"https://www.gov.uk/api/world-locations/france", "rel"=>"self"}]}}
```
Response using World Content Item
```
=> {"id"=>"https://www.gov.uk/world/france",
"title"=>"France",
"format"=>"World location",
"updated_at"=>"2017-08-28T09:40:55.000+01:00",
"web_url"=>"https://www.gov.uk/world/france",
"analytics_identifier"=>"WL48",
"details"=>{"slug"=>"france", "iso2"=>"FR"},
"organisations"=>{"id"=>"https://www.gov.uk/world/france#organisations", "web_url"=>"https://www.gov.uk/world/france#organisations"},
"content_id"=>"5e9f00ce-7706-11e4-a3cb-005056011aef"}
```
This method currently returns data retrieved from the Whitehall API, which is being deprecated. Therefore updating the method to get the data from the World Content Item. This is a breaking change as we have removed the pagination from the response. This is to avoid multiple requests to the content item, when all the results are included anyway.
brucebolt
force-pushed
the
update-world-method
branch
from
363b51f
to
1ab0e84
Compare
CristinaRO
reviewed
Jul 19, 2023
CristinaRO
approved these changes
Jul 19, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These methods currently returns data retrieved from the Whitehall API, which is being deprecated.
Therefore updating the method to get the data from the World Content Item.
We need to transform the response to ensure the output remains as backwards compatible with previous versions of this gem as possible. However a breaking change has been introduced, as pagination of the World Locations endpoint has been removed.
The following applications use the affected methods and will be updated in the following PRs (once this a new version of this gem has been released):
gds-api-adaptersversion 89.0.0 smart-answers#6463gds-api-adaptersversion 89.0.0 finder-frontend#3113gds-api-adaptersversion 89.0.0 contacts-admin#1204Trello card