fix: document GET /reframe?q= #326
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
willscott
approved these changes
Sep 29, 2022
lidel
commented
Sep 29, 2022
Comment on lines
-33
to
-36
| - `GET /reframe/{mbase64url-dag-cbor}` | ||
| - Cachable HTTP `GET` requests with message passed as DAG-CBOR in HTTP path segment, encoded as URL-safe [`base64url` multibase](https://docs.ipfs.io/concepts/glossary/#base64url) string | ||
| - DAG-CBOR in multibase `base64url` is used instead of DAG-JSON because JSON may include characters that are not safe to be used in URLs, and re-encoding JSON in base would take too much space | ||
| - Suitable for sharing links, sending smaller messages, and when a query result MUST benefit from HTTP caching (see _HTTP Caching Considerations_ below). |
There was a problem hiding this comment.
ℹ️ Removing this for now since there is no implementation.
I believe we still want to implement this, so I re-introduced it as part of the IPIP which adds proper DAG-CBOR support (#327)
This is what Kubo 0.16.0-rc1 uses, and what is implemented in https://github.com/ipfs/go-delegated-routing
not implemented anywhere, we will add it as a separate IPIP
lidel
force-pushed
the
fix/dag-json-reframe-queries
branch
from
f5a023e
to
aa5d122
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.
This PR is a small fix that aligns Reframe specs with existing Implementation.
Percent-encoded DAG-JSON sent over
?q=is what Kubo 0.16.0-rc1 uses, and what is implemented in https://github.com/ipfs/go-delegated-routing v0.6.0.I decided to add this to the spec, because it saves us time and does not block Kubo/Indexer work (we don't need to change the wire format).
It is a safe path: makes the spec both backward-compatible (with Kubo and go-delegated-routing) and forward-compatible (with proper CBOR support proposed in separate IPIP from #327).
cc @guseggert @petar @willscott