Add endpoints output: improvements and compliance #569
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
ghost
added
the
hsanjuan
added
need/review
lidel
reviewed
Oct 3, 2018
| @@ -390,9 +389,9 @@ func outputDagnode(out chan *api.AddedOutput, name string, dn ipld.Node) error { | |||
| } | |||
|
|
|||
| out <- &api.AddedOutput{ | |||
| Hash: dn.Cid().String(), | |||
| Cid: dn.Cid().String(), | |||
There was a problem hiding this comment.
I suspect this change will require update (PR) to js-ipfs-api, which still expects Hash in file-result-stream-converter.js#L32 and L38 (it should try Hash and if missing use Cid)
There was a problem hiding this comment.
hey, this only affects the Cluster API /add. The IPFS Proxy /add output will be fully compatible with the ipfs output format.
There was a problem hiding this comment.
There was a problem hiding this comment.
Ah, I get it now, thanks for explanation!
This straigthens some mistakes with the outputs of the /add endpoints. Currently, we had exactly the same output format which: * was not exactly the ipfs API output format but was sort of similar * made some weird concessions to be compatible (like having a string-type "size") * was not aligned with Cluster API conventions (lowercase keys) This corrects all this: * The Cluster API /add output format now uses the right types and lowercase keys. * `Hash` is now `Cid`, because the field carries a Cid. * We copy error handling with request trailers from IPFS, and avoid carrying the errors in the output objects. * The proxy now returns exactly the types as ipfs would * We add the X-Chunked-Output: 1 header, which is custom and redundant, but otherwise breaks js-ipfs-api integrations with the /add endpoint. License: MIT Signed-off-by: Hector Sanjuan <code@hector.link>
hsanjuan
force-pushed
the
fix/add-output-format
branch
from
8fdd0c4
to
b6306a6
Compare
Closed
lanzafame
approved these changes
Oct 5, 2018
25 tasks
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 straigthens some mistakes with the outputs of the /add endpoints.
Currently, we had exactly the same output format which:
This corrects all this:
Hashis nowCid, because the field carries a Cid.errors in the output objects.
otherwise breaks js-ipfs-api integrations with the /add endpoint.
Fixes: ipfs/ipfs-companion#600
License: MIT
Signed-off-by: Hector Sanjuan code@hector.link