Skip to content
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.

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

REST API documentation. #11

Open
arnoldandreasson opened this issue Jun 21, 2020 · 0 comments
Open

REST API documentation. #11

arnoldandreasson opened this issue Jun 21, 2020 · 0 comments

Comments

@arnoldandreasson
Copy link
Member

The REST API is documented by use of OpenAPI 3.0 (earlier called Swagger). This documentation is automatically generated since the Python library FastAPI (https://fastapi.tiangolo.com/) is used to embed the server part of the detector.
But the FastAPI part of the code must contain more specifications of parameter types, option lists and other features to make the API documentation more useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant