WIP: IPFS API (core+http+cli) #65
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
This was referenced Jan 11, 2016
Closed
I agree that it's very low in the scale of RESTfulness, why call it RESTful at all though? The explicit goal is to mirror the CLI as much as possible. |
|
|
||
| # Table of contents | ||
|
|
||
| - [%N% Introduction]() |
There was a problem hiding this comment.
It is just a placeholder for the future number of the chapter
This was referenced Jan 12, 2016
|
|
||
| > Official spec of the APIs that ipfs implementations must conform to, as well as test suites to ensure they do. | ||
| > This document presentes the specifications for the IPFS APIs, namely: 'core', the programmatic interface, 'http', a networked API interface over HTTP and 'cli', the command line interface to interact with IPFS. |
|
Added one spelling note, otherwise, looks good to me. |
daviddias
added a commit
that referenced
this pull request
Feb 10, 2016
WIP: IPFS API (core+http+cli)
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.
Upgraded the doc to reflect and indicate how we are organising our API specs. Moved from a
levelorg to asystemorg (calling something level 1 and 2, when inside level 1 there are extensions and optional features made things a tad confusing).Currently, the IPFS Core API (the programmatic interface) is still kind in flux (and that is ok), so no need to pressure ourselves into locking it down. The IPFS CLI happens as needed and as the system evolve. The only API spec that needs to get more stable, is the HTTP API as a lot of other libraries and applications depend on it.
Currently, the HTTP API is a mix of RPC and RESTful (it really isn't either), which makes it weird to assess. Having a RPC API gives us the chance of layering it over any other transport, while not having a RESTful one makes it weird for Web Apps libraries.
Let's continue the endeavour of documenting the current HTTP API through Apiary (here http://github.com/ipfs/api) so that then we can migrate through PR and reviews