Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: add /metadata/v1 prefix to all routes #100

Merged
merged 8 commits into from
Feb 7, 2023
Merged

fix: add /metadata/v1 prefix to all routes #100

merged 8 commits into from
Feb 7, 2023

Conversation

rafaelcr
Copy link
Collaborator

@rafaelcr rafaelcr commented Feb 6, 2023 •
edited
Loading

Also add the /metadata prefix with the same effect

@CharlieC3
Copy link
Member

Also, rewrite /metadata/* URLs to /metadata/v1/*

Based on @saralab's comment, I'm not sure this scenarios calls for any HTTP path rewriting. For example, /metadata/cool/function should resolve as-is and so should /metadata/v1/cool/function. No rewrites should occur and they should both perform the same action while v1 is the latest available versioned API provided by the TMS.

Months or years from now when API version v2 comes out and v1 is officially removed after an appropriate deprecation period, /metadata/v1/cool/function would redirect to /metadata/v2/cool/function or /metadata/cool/function. So I don't believe we'll need any URL redirects for some time (I'm aware rewrites are different from redirects, but figure I'd cover both since they're a bit tangential).

@rafaelcr
Copy link
Collaborator Author

rafaelcr commented Feb 6, 2023

Gotcha, I'll make that change @CharlieC3

zone117x
zone117x reviewed Feb 6, 2023
View reviewed changes
src/api/util/helpers.ts Outdated Show resolved Hide resolved
@rafaelcr rafaelcr linked an issue Feb 6, 2023 that may be closed by this pull request
Add root path to all API routes #99
Closed
@rafaelcr
Copy link
Collaborator Author

rafaelcr commented Feb 6, 2023

Done @CharlieC3 can you take another look?

CharlieC3
CharlieC3 approved these changes Feb 7, 2023
View reviewed changes
Copy link
Member

@CharlieC3 CharlieC3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! :shipit:

@rafaelcr rafaelcr merged commit a11d4be into beta Feb 7, 2023
@rafaelcr rafaelcr deleted the fix/prefix branch February 7, 2023 14:36
blockstack-devops pushed a commit that referenced this pull request Feb 7, 2023
@semantic-release-bot
chore(release): 0.1.0-beta.7 [skip ci]
c4a6074 
## [0.1.0-beta.7](v0.1.0-beta.6...v0.1.0-beta.7) (2023-02-07)

### Bug Fixes

* add `/metadata/v1` prefix to all routes ([#100](#100)) ([a11d4be](a11d4be))
@blockstack-devops
Copy link

🎉 This PR is included in version 0.1.0-beta.7 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

blockstack-devops pushed a commit that referenced this pull request Feb 22, 2023
@semantic-release-bot
chore(release): 0.1.0 [skip ci]
86d7f9a 
## [0.1.0](v0.0.1...v0.1.0) (2023-02-22)

### Features

* add server version to status endpoint and rendered docs ([#76](#76)) ([ba2f7de](ba2f7de))
* enable run modes ([#116](#116)) ([c7a9c55](c7a9c55))
* import sip-019 notifications during boot ([#81](#81)) ([6c28037](6c28037))
* refresh dynamic metadata tokens periodically ([#64](#64)) ([e1c0882](e1c0882))
* throttle requests to rate limited domains ([#97](#97)) ([5b75060](5b75060))

### Bug Fixes

* add `/metadata/v1` prefix to all routes ([#100](#100)) ([a11d4be](a11d4be))
* add cache-control, remove cache for error responses ([#114](#114)) ([e03caf8](e03caf8))
* contract log queries ([4bd2812](4bd2812))
* display cached image in metadata responses ([#104](#104)) ([156e9e2](156e9e2))
* dockerfile CMD path ([#91](#91)) ([de60556](de60556))
* enclose response etag in double quotes ([#113](#113)) ([2b77cfe](2b77cfe))
* etag cache calculation with url prefix ([#111](#111)) ([f872f93](f872f93))
* follow redirects when fetching metadata ([#109](#109)) ([0ab2fbb](0ab2fbb))
* generate git info on docker build ([#93](#93)) ([9808b47](9808b47))
* handle pg disconnections and transaction management ([#92](#92)) ([201d813](201d813))
* ignore invalid ssl certs for metadata fetch ([#107](#107)) ([46e184c](46e184c))
* ignore ts type maps when migrating ([#95](#95)) ([b92b9d8](b92b9d8))
* improve SIGINT handling for queued jobs ([e16fcd5](e16fcd5))
* jsonb type interpretation on endpoints ([5985c80](5985c80))
* jsonb value insertions ([8dff8a6](8dff8a6))
* make importer wait for API height to catch up if it's behind ([#101](#101)) ([930cce3](930cce3))
* manage additional timeout errors on metadata fetch ([e658e1d](e658e1d))
* move from fetch to request to fix ENOBUFS ([9b26439](9b26439))
* persist http agent for metadata fetches ([a30641a](a30641a))
* retry 429 and gateway timeouts ([08cdce6](08cdce6))
* sft_mint detection ([53673b2](53673b2))
* shut down queue at the end of sequence ([e268c79](e268c79))
* support JSON5 metadata strings ([#106](#106)) ([d19634f](d19634f))
* uintcv creation ([780b160](780b160))
* update_at jobs on status or retry change ([c16025f](c16025f))
@blockstack-devops
Copy link

🎉 This PR is included in version 0.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@CharlieC3 CharlieC3 CharlieC3 approved these changes

@zone117x zone117x Awaiting requested review from zone117x

Assignees
No one assigned
Labels
released on @beta released
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add root path to all API routes
4 participants
@rafaelcr @CharlieC3 @blockstack-devops @zone117x