Skip to content

Implementation and specification for the Filecoin node HTTP API

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

derbaltasar/filecoin-http-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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 https://localhost:5000.

License

Dual MIT and Apache 2

About

Implementation and specification for the Filecoin node HTTP API

Resources

License

Unknown, MIT licenses found

Licenses found

Unknown
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published