Add API endpoint for fetching a brand#2937
Open
theseanything wants to merge 1 commit into
Open
Conversation
Forms include a brand_id in the form document sent to forms-runner, but there was no way for the runner to fetch the details of the brand it refers to. Add a GET /api/v2/brands/:brand_id endpoint that returns the brand as a JSON resource, currently just the name and slug, with future brand configuration such as colours and logo to be added as it is built. The response is served with a Cache-Control header allowing it to be cached for 5 minutes.
|
🎉 A review copy of this PR has been deployed! You can reach it at: https://pr-2937.admin.review.forms.service.gov.uk/ It may take 5 minutes or so for the application to be fully deployed and working. If it still isn't ready For the sign in details and more information, see the review apps wiki page. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
What problem does this pull request solve?
Forms include a
brand_idin the form document sent to forms-runner, but there was no way for the runner to fetch the details of the brand it refers to.This adds a
GET /api/v2/brands/:brand_idendpoint that returns the brand as a JSON resource. At the moment a brand only has a name and a slug, so that is all the response contains, but future brand configuration such as header colours and logo images can be added to the response as it is built.This would let us build a UI to configure brands.
The response is served with a
Cache-Control: max-age=300, publicheader so it can be cached for 5 minutes. Note that forms-runner's ActiveResource client doesn't honour cache headers by itself, so for the runner to benefit it will need its own client-side caching as part of the work to consume this endpoint.