Skip to content
This repository has been archived by the owner on Apr 2, 2024. It is now read-only.

ds-wizard/engine-backend-api-docs

Repository files navigation

Engine Backend API Docs

User Guide License CII Best Practices

API Docs for Data Stewardship Wizard

Requirements

  • Python (recommended 3.11)
  • Makefile (recommended 3.81)

Run

For building the output that contains the Swagger specifications, diffs between Swagger specifications and the root index file, please run the following from the root of the project

$ make build

How to add new version of API Docs?

Add the Swagger specification under the corresponding version into the specs folder. Then, run the make build to rebuild the project. The result will be in the output folder.

License

This project is licensed under the Apache License v2.0 - see the LICENSE file for more details.