This repo contains OpenAPI schema for NVIDIA Bare Metal REST endpoints. Redoc rendered latest version can be viewed at https://nvidia.github.io/bare-metal-manager-rest/
OpenAPI schema must be updated whenever the API endpoints are added/updated.
Please ensure that the following tools are installed:
- Docker
- npm
To lint schema after making changes, run:
make lint-openapi
To view a rendered/browsable version of the schema locally, run:
make preview-openapi
Then access the schema at:
http://127.0.0.1:8090
In order to update the Github pages to reflect schema changes, you must include rendered HTML changes in your PR.
To modify the rendered HTML, run:
make publish-openapi