Closed AsherJingkongChen closed 4 months ago
I introduced swagger-ui-py to generate Web API documentation from our OpenAPI configuration.
swagger-ui-py
Besides, I added a heartbeat endpoint for testing purposes, with manual tests run for /ping and /data endpoints.
/ping
/data
The repository doc is also added as a sub-module due to the necessity of documentation generation.
doc
I removed unnecessary artifacts which are challenging to update. Their functionalities are replaced by swagger-ui-py.
Generates Web API documentation programmatically with extra tests
Description
I introduced
swagger-ui-py
to generate Web API documentation from our OpenAPI configuration.Besides, I added a heartbeat endpoint for testing purposes, with manual tests run for
/ping
and/data
endpoints.The repository
doc
is also added as a sub-module due to the necessity of documentation generation.Motivation or Context
I removed unnecessary artifacts which are challenging to update. Their functionalities are replaced by
swagger-ui-py
.Checklist