Skip to content
Speckle Open Api 2.0 Specification
Branch: master
Clone or download

README.md

Speckle OpenApi Documentation

DOI

View these docs here.

Build

  1. npm install
  2. npm run build

Build explanation

  1. swagger-cli bundle: This resolves all the references and bundles up the schemas into #/components/schemas.
  2. widdershins: This converts into a md file for use by shins.
  3. shins: This converts the md file into a single html file.

Deploy

If you push to the master branch, Travis will build and push the artifacts to the gh-pages branch.

You can’t perform that action at this time.