public
/
pyceo
27
1
Fork 3
Code Issues 25 Pull Requests 5 Projects Releases 1 Wiki Activity
pyceo/docs
History
Daniel Sun 010937ea17
continuous-integration/drone/push Build is passing Details
Add group lookup functionality (#88) 
note: **I am unaware of best practices** but I tried my best to keep changes consistent with the codebase

feedback would be much appreciated

notable changes:
**new api endpoint**: `/groups/search` -- I moved searching into the api so it could be used in tui and cli, also seemed like a good idea to keep the json response as small as possible
**tui searching** -- at first I wanted to make this realtime interactable, but the work required seemed inappropriate to a feature I am assuming will only be used sparingly

Co-authored-by: Daniel Sun <dandancool@github.com>
Co-authored-by: Daniel Sun <d6sun@uwaterloo.ca>
Reviewed-on: #88
Reviewed-by: Max Erenberg <merenber@csclub.uwaterloo.ca>
Co-authored-by: Daniel Sun <d6sun@csclub.uwaterloo.ca>
Co-committed-by: Daniel Sun <d6sun@csclub.uwaterloo.ca>
 		2023-03-04 01:21:04 -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 group lookup functionality (#88) 2023-03-04 01:21:04 -05:00
redoc-static.html Implement TUI support for multiple users in each position (#80) 2023-01-23 02:26:13 -05:00

README.md

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.

Man pages

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