Skip to content
This repository has been archived by the owner on Dec 19, 2023. It is now read-only.

Apperio/ledes-api-docs

Repository files navigation

LEDES API OpenAPI Documentation

This is a work in progress to illustrate what is possible and does not represent the final form.

To get started

npm install
npm start

Then navigate to http://localhost:8080. Refresh to see any changes you've made to the specification.

Public Hosted version

A generated, static, publicly hosted version of this documentation can be found on Github Pages at https://apperio.github.io/ledes-api-docs/, which serves files in the /docs folder. To update this public static snapshot you will need to create a single YAML document by combining all the reference files by running:

node compile-specification.ps

About

Illustrating documenting the LEDES API in OpenAPI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published