Skip to content

stashenergy/api-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Stash Energy API Documentation

The documentation for the Stash Energy API uses the OpenAPI 3 specification format.

Currently we use ReDoc to generate the HTML docs we host at https://dev.stash.energy

How to view and/or edit the documentation

Prerequisites:

  • node
  • pnpm

To edit and see live changes while editing

  1. $ pnpm dev
  2. Open a web browser at the URL specified in the command output
  3. Make changes to the spec and save it
  4. Wait for the web page to refresh