feat: redesign http query url #898
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
added 2 commits
October 17, 2022 22:25
dirkmc
reviewed
Oct 18, 2022
dirkmc
reviewed
Oct 18, 2022
dirkmc
reviewed
Oct 18, 2022
dirkmc
reviewed
Oct 19, 2022
cmd/booster-http/server.go
Outdated
| writeError(w, r, http.StatusBadRequest, "unsupported format") | ||
| } | ||
| } else { // Error if more than 1 format value | ||
| writeError(w, r, http.StatusBadRequest, "unsupported query") |
There was a problem hiding this comment.
Let's try to give the user as much information as possible if they get the parameters wrong:
Suggested change
| writeError(w, r, http.StatusBadRequest, "unsupported query") | |
| writeError(w, r, http.StatusBadRequest, "missing 'format' query parameter") |
There was a problem hiding this comment.
We support no format query and default to a piece in that case. I have changed the error msg to be more detailed though.
There was a problem hiding this comment.
I'm not sure if I'm reading the code correctly, but it looks like it will return an error if the user doesn't specify the format query parameter.
If the user doesn't specify the format query parameter then len(q["format]) will be zero here, right?
if len(q["format"]) == 1
There was a problem hiding this comment.
My bad. Fixing it.
dirkmc
reviewed
Oct 19, 2022
cmd/booster-http/server.go
Outdated
| @@ -112,31 +110,31 @@ const idxPage = ` | |||
| Download a raw piece by payload CID | |||
| </td> | |||
| <td> | |||
| <a href="/payload/payloadcid">/payload/<payload cid></a> | |||
| <a href="/piece?payloadCid=bafySomePayloadCid&format=piece" > /payload/<payload cid></a> | |||
There was a problem hiding this comment.
Let's also change the link target text for these:
Suggested change
| <a href="/piece?payloadCid=bafySomePayloadCid&format=piece" > /payload/<payload cid></a> | |
| <a href="/piece?payloadCid=bafySomePayloadCid&format=piece" >/piece?payloadCid=<payload cid></a> |
dirkmc
approved these changes
Oct 20, 2022
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.
Fixes #888