Add routes for resolving items by refcode #807
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #807 +/- ##
==========================================
+ Coverage 67.26% 67.33% +0.06%
==========================================
Files 62 62
Lines 3858 3869 +11
==========================================
+ Hits 2595 2605 +10
- Misses 1263 1264 +1
|
ml-evs
force-pushed
the
ml-evs/refcode-resolver
branch
from
706c0b8
to
5250762
Compare
|
Test summaryRun details
This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Cloud |
ml-evs
force-pushed
the
ml-evs/refcode-resolver
branch
3 times, most recently
from
f99d6d2
to
bb75f2d
Compare
ml-evs
force-pushed
the
ml-evs/refcode-resolver
branch
2 times, most recently
from
154c77b
to
847a20e
Compare
ml-evs
force-pushed
the
ml-evs/refcode-resolver
branch
from
847a20e
to
fdecf81
Compare
ml-evs
force-pushed
the
ml-evs/refcode-resolver
branch
from
fdecf81
to
8828987
Compare
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.
First steps on #803
This PR adds/items/by-refcode/<refcode>and/items/by-id/<id>endpoints that essentially replace/get_item_data/<item_id>. I'm not entirely happy with the routes yet, and would like to find some examples of how other APIs deal with what are essentially multiple canonical IDs. Havingby-idandby-refcodefeels natural, but perhaps simply/items/refcode/<refcode>is more extensible and compatible with e.g. JSON:API to other fields in the future.Went with this in the end: having
/items/<refcode>be the canonical URL is appealing, with the "legacy" endpoint being the only way to refer to items by item ID -- this would also allow us to promote refcode at some point to simply be the top-levelidfield in JSON:API parlance, which has some nice properties.