isabella232 / filecoin-http-api

Specification for the Filecoin node HTTP API

filecoin-http-api (WIP)

OpenAPI specification for the Filecoin HTTP REST API.

The HTML version of the documentation can be viewed here.

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