1
0
Fork 0
Commit Graph

4 Commits (5e03f7c759983c168331c99396163fed60fe533f)

Author SHA1 Message Date
Corey Shields 5e03f7c759 Epic API (doc) changes for SatNOGS DB
I've decided to change things up in API schema and doc generation.

Work is not quite complete but its enough for testing in dev and feedback.

Major changes:
* Renaming of api.view classes to match ViewSet inheritance (minor annoyance)
* Introduce drf-spectacular for schema generation and doc UI via swagger-ui
* lots of doc changes for the API to provide a good experience with the above.

New schema generation should work seamlessly in gitlab ci, as well as via /api/schema dynamically.

The new swagger ui view is available via /api/schema/docs/

Signed-off-by: Corey Shields <cshields@gmail.com>
2021-01-09 20:44:19 -05:00
Vasilis Tsiligiannis 498fa704a3 docs: Point to generated API documentation
Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-09-21 17:41:05 +03:00
Vasilis Tsiligiannis e2086c72b8 satnogs-db-api-client: Generate API documentation
Generate API documentation from OpenAPI specification. Also, update
outdated Sphinx documentation and include the generated docs.

Signed-off-by: Vasilis Tsiligiannis <acinonyx@openwrt.gr>
2020-09-21 13:13:10 +03:00
Nikos Roussos 9c5cde23a2
Move doc files inside repo 2017-03-13 19:15:06 +02:00