RFC 089: move the Identifiers API routes under /identifiers/v1 - #171
Merged
Merged
Conversation
api.wellcomecollection.org routes by first path segment, so the public paths are /identifiers/v1/... rather than /v1/identifiers/....
RFC 085 quoted the old paths, RFC 089 gave no reason for the segment order, and its modified stamp had not moved.
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.
Preview
https://github.com/wellcomecollection/docs/blob/rfc-089-identifiers-path-prefix/rfcs/089-identifiers-api/README.md
What does this change?
Renames the Identifiers API path prefix in the RFC 089 route table, and in the two lines of RFC 085 that quote it, from
/v1/identifiers/...to/identifiers/v1/.... api.wellcomecollection.org routes on the first path segment with a/{service}/{version}/...convention (/catalogue/v2/works), so the planned/identifiers/*CloudFront behaviour in wellcomecollection/platform#6578 needs the origin to answer on/identifiers/.... The prototype is being renamed now, while nothing consumes it and no contract has been published.The canonical spec lives in catalogue-api and the matching change is wellcomecollection/catalogue-api#985. The RFC also now says why the service name comes first, and its modified stamp and the index entry are bumped.
How to test
Read the three changed rows of the route table.
python3 .scripts/validate_rfc.py rfcs/089-identifiers-api/README.mdstill passes.How can we measure success?
The RFC and the catalogue-api spec agree on the prefix when the CloudFront behaviour is built.
Have we considered potential risks?
Nothing deploys from this repo, and the API has no consumers, so the only cost of getting the prefix wrong is another rename.