Aliro icon indicating copy to clipboard operation
Aliro copied to clipboard

Add REST API docs to the developer's guide

Open jay-m-dev opened this issue 2 years ago • 0 comments

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 avatar Jan 10 '23 06:01 jay-m-dev