New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add REST API docs to the developer's guide #521

Open

5 tasks

jay-m-dev opened this issue Jan 10, 2023 · 0 comments

Assignees

Labels

documentation enhancement

Contributor

jay-m-dev commented Jan 10, 2023

The API documentation should be accessible and updated as new endpoints are added.
Need to complete the following steps:

Generate the html API guide using the RAML specification for the lab.
- Ensure all endpoints are documented in the existing RAML spec.
Create a RAML spec for the machine API
Determine how to best integrate building and deploying the API html page with the existing documentation on GitHub Pages
- Add the steps to generate the html files from raml to the existing doc builder docker image, output to target directory.

jay-m-dev mentioned this issue

Build Data Preprocessing Interface #502

Closed

3 tasks

jay-m-dev self-assigned this

jay-m-dev added enhancement documentation labels

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment