This repository was archived by the owner on Jun 26, 2019. It is now read-only.
Document bzz-list, bzz-raw and bzz-immutable schemes#44
Merged
Conversation
lmars
reviewed
Dec 19, 2017
|
|
||
| GET http://localhost:8500/bzz-list:/2477cc8584cc61091b5cc084cdcdb45bf3c6210c263b0143f030cf7d750e894d | ||
|
|
||
| Returns a list of all files contained in <manifest> under <path> grouped into common prefixes using ``/`` as a delimiter. The response is a JSON-encoded object with ``common_prefixes`` string field and ``entries`` list field. |
Contributor
There was a problem hiding this comment.
This comment refers to <manifest> and <path> but they don't appear in the example?
Member
Author
There was a problem hiding this comment.
Yes, the description is not so clear with this example. Updated.
|
|
||
| bzzr and bzzi | ||
| ^^^^^^^^^^^^^^ | ||
| Schemes with short names bzzr and bzzi are deprecated in favour of bzz-raw and bzz-immutable, respectably. They are kept for backward compatibility, and will be removed on the next release. |
gbalint
reviewed
Dec 19, 2017
| ------------- | ||
|
|
||
| Setting `list=true` in the query of a `GET` request returns a list of files contained under the path, grouped into common prefixes which represent directories: | ||
| A `GET` request with bzz-list url scheme returns a list of files contained under the path, grouped into common prefixes which represent directories: |
Contributor
There was a problem hiding this comment.
Maybe bzz-list can be teletyped or bold for readability
cobordism
approved these changes
Dec 19, 2017
cobordism
reviewed
Dec 19, 2017
| GET http://localhost:8500/bzz-immutable:/2477cc8584cc61091b5cc084cdcdb45bf3c6210c263b0143f030cf7d750e894d | ||
|
|
||
| The same as the generic scheme but there is no ENS domain resolution, the domain part of the path needs to be a valid hash. This is also a read-only scheme but explicit in its integrity protection. A particular bzzi url will always necessarily address the exact same fixed immutable content. | ||
| The same as the generic scheme but there is no ENS domain resolution, the domain part of the path needs to be a valid hash. This is also a read-only scheme but explicit in its integrity protection. A particular bzz-immutable url will always necessarily address the exact same fixed immutable content. |
Contributor
There was a problem hiding this comment.
"also read-only but explicit in its integrity protection" -> this is a strange formulation.
lmars
approved these changes
Dec 19, 2017
gbalint
approved these changes
Dec 20, 2017
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
PR ethereum/go-ethereum#15667 has been merged to ethereum master and this change updates the documentation.