Skip to content

storm-platform/storm-ws-spec

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SpatioTemporal Open Research Manager Web Service - Specification

Run in Insomnia Software License Software Life Cycle Release Join us at Discord Made with Spacemacs

About

SpatioTemporal Open Research Manager Web Service OpenAPI 3.0 specification.

Repository Organization

Building the Documentation

Requirements

The build system for the REST API documentation relies on the Node.js run-time environment:

  • Node.js (Version 8+).
  • ReDoc: generates HTML reference documentation from an OpenAPI specification file.

Build

If you have Node.js installed, please, execute the following command to install the ReDoc dependency:

$ npm install

After that, generate the documentation:

$ npm run build

The above command will create a folder named dist with the bundled file index.html. You may open it in your web browser or may serve it with an HTTP Server.

For Python developers, you can serve the HTML with:

python3.8 -m http.server 8080 --directory dist

License

Copyright (C) 2021 INPE.

SpatioTemporal Open Research Manager Web Service is free software; you can redistribute it and/or modify it under the terms of the MIT License; see LICENSE file for more details.