Skip to content
Specification for the Filecoin node HTTP API
Branch: master
Clone or download
Latest commit b82dce5 Oct 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api corrected spelling of receipt Oct 3, 2019
docs corrected spelling of receipt Oct 3, 2019
.gitignore Added linting tool Aug 27, 2019
LICENSE-APACHE Add licensing info Aug 30, 2019
LICENSE-MIT Add licensing info Aug 30, 2019
README.md tiny README typo Sep 13, 2019
package-lock.json Switch to recent version of ReDoc Sep 13, 2019
package.json Configure for GH Pages Sep 18, 2019

README.md

filecoin-http-api (WIP)

OpenAPI specification for the Filecoin HTTP REST API.

This is the specification for the HTTP REST API (to be) implemented by Filecoin nodes. Some details of its design and rationale can be found in this Design Document.

Setup

To facilitate development and review we're using speccy as a linter and redoc to generate HTML documentation. You can install them using NPM or Yarn.

$ npm install
# or
$ yarn install

Usage

To view the specification in HTML form you can invoke redoc via:

$ npm run serve

And view the resulting documentation at http://localhost:5000.

License

Dual MIT and Apache 2

You can’t perform that action at this time.