Feature #1701
Manual: added API documentation
Status:
Closed
Priority:
Normal
Assignee:
Category:
Documentation
Target version:
Start date:
2022-04-27
Estimated time:
Description
Although we already have an API documentation, thanks to Bernhard, we should think about an overhaul to make it more accessible for beginners and experts alike.
A few ideas:- We could take inspiration from successful API documentations, e.g. selected API examples
- Maybe switch to the in-application Sphinx documentation. It looks better and would have the advantage to always be the right documentation for the right version
- Should be written primarily by Bernhard Koschiček-Krombholz but
- Maybe Nina Richards could support with her excellent writing skills and with her perspective as an API beginner
- We could ask API interested people about feedback e.g. Eugen Hotwagner
Related issues
History
Updated by
Updated by Alexander Watzinger 9 months ago
- Related to Feature #1751: Manual: add model documentation added
Updated by
Updated by Alexander Watzinger 3 months ago
- Assignee changed from Bernhard Koschiček-Krombholz to Nina Richards
Updated by Nina Richards 3 months ago
Updated by - Status changed from In Progress to Resolved
- Assignee changed from Nina Richards to Bernhard Koschiček-Krombholz
I added all versions to the manual. It can be found in the feature_APImanual branch on GitHub. However, it should be checked by Bernhard before merging it to develop. Especially because version 0.1 of the API endpoints was not included in the Google Doc yet, so I just took the information provided on Swagger.
Furthermore, unfortunately, I messed the tables up again, Bernhard can you give me a hint, on how you fixed the overflow of the table content before?
Updated by Alexander Watzinger 2 months ago
- Subject changed from API: documentation to API: documentation in manual
Updated by Alexander Watzinger 2 months ago
- Subject changed from API: documentation in manual to Manual: added API documentation
- Category changed from API to Documentation