-
Notifications
You must be signed in to change notification settings - Fork 232
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #51 from ipfs/feature/add-api-specs
Added the API Specs from ipfs/api
- Loading branch information
Showing
4 changed files
with
125 additions
and
0 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # IPFS API Spec | ||
|
|
||
| > Official spec of the APIs that ipfs implementations must conform to, as well as test suites to ensure they do. | ||
| > **WARNING** This is a work in *progress*. There be dragons. | ||
| The IPFS API code for apiary can be found in [ipfs/api](//github.com/ipfs/api). | ||
|
|
||
| The IPFS API has two levels. The first level is a general description based on function signatures and the second one is the transport specific description. | ||
|
|
||
| * [Level 1 Spec - Transport Agnostic](level1.md) | ||
| * Level 2 Spec - Transport Specific | ||
| * [Level 2 CLI Spec](level2/cli.md) | ||
| * [Level 2 HTTP(S) Spec](level2/http.md) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # IPFS API Level 1 Spec - Transport Agnostic | ||
|
|
||
| ### IPFS Core | ||
|
|
||
| > Everything defined here is required. | ||
| - version | ||
| - node | ||
| - id | ||
| - start | ||
| - stop | ||
| - block | ||
| - get | ||
| - put | ||
| - stat | ||
| - object - Basic manipulation of the DAG | ||
| - data | ||
| - get | ||
| - links | ||
| - new | ||
| - patch | ||
| - put | ||
| - stat | ||
| - refs - Listing of references. (Essentially, walking around the graph). | ||
| - local | ||
| - repo - Basic manipulation of the repo | ||
| - init | ||
| - stat | ||
| - gc | ||
| - config get | ||
| - config put | ||
| - pin - Basic manipulation of the pin set | ||
| - add | ||
| - ls | ||
| - rm | ||
| - log | ||
| - level | ||
| - tail | ||
| - name (ipns) | ||
| - name publish | ||
| - resolve | ||
|
|
||
| ### IPFS Ext | ||
|
|
||
| > Everything defined here is optional | ||
| - dns | ||
| - resolve | ||
| - tar | ||
| - add | ||
| - cat | ||
| - tour | ||
| - list | ||
| - next | ||
| - restart | ||
| - files | ||
| - add | ||
| - cat | ||
| - get | ||
| - stat - Statistics about everything | ||
| - bw | ||
| - mount | ||
| - bootstrap | ||
| - add | ||
| - list | ||
| - rm | ||
|
|
||
| ### IPFS Tools | ||
|
|
||
| > Everything defined here is optional, and might be specific to the | ||
| > implementation details (like running on the command line). | ||
| - commands | ||
| - update | ||
| - init - sugar around ipfs repo init | ||
| - config | ||
| - edit | ||
| - replace | ||
| - show | ||
| - daemon | ||
| - diag | ||
| - net | ||
| - sys | ||
|
|
||
| ### Libp2p | ||
|
|
||
| - ping | ||
| - dht | ||
| - findpeer | ||
| - findprovs | ||
| - get | ||
| - put | ||
| - query | ||
| - swarm | ||
| - addrs | ||
| - addrs local | ||
| - connect | ||
| - disconnect | ||
| - filters | ||
| - filters add | ||
| - filters rm | ||
| - peers | ||
| - record (iprs) | ||
| - put | ||
| - get | ||
| - bitswap | ||
| - stat | ||
| - unwant | ||
| - wantlist |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # IPFS API Level 2 CLI Spec |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # IPFS API Level 2 HTTP(S) Spec |