History

Max Erenberg 2487ab3668 update security section of docs		2022-03-12 15:50:42 -05:00
..
README.md	add documentation (#22 )	2021-10-05 00:07:10 -04:00
architecture.md	update security section of docs	2022-03-12 15:50:42 -05:00
ceo.1.scd	add documentation (#22 )	2021-10-05 00:07:10 -04:00
ceo.ini.5.scd	Add debian packaging (#32 )	2021-10-28 20:52:19 -04:00
ceod.ini.5.scd	Add Kubernetes API endpoint (#38 )	2021-12-18 16:35:05 -05:00
openapi.yaml	Add Kubernetes API endpoint (#38 )	2021-12-18 16:35:05 -05:00
redoc-static.html	Add Kubernetes API endpoint (#38 )	2021-12-18 16:35:05 -05:00

Documentation

OpenAPI

We are using OpenAPI 3.0 to document the REST API for ceod, and Redoc to generate HTML documentation from the OpenAPI file.

First, make sure you have Node.js and npm installed. Then, install the Redoc CLI:

npm install -g redoc-cli

After you make changes to the openapi.yaml file, make sure to regenerate the HTML:

redoc-cli bundle openapi.yaml

You can now view the redoc-static.html file from your browser.

We are using scdoc to generate our man pages. You can view the pages from your terminal like so:

scdoc < ceo.1.scd > ceo.1
man ./ceo.1