Feature #1701
closed
Manual: added API documentation
Added by Alexander Watzinger over 2 years ago.
Updated over 1 year ago.
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
- Description updated (diff)
- Status changed from Assigned to In Progress
- Target version changed from 208 to 7.7.0
- Target version changed from 7.7.0 to 7.8.0
- Target version changed from 7.8.0 to 7.9.0
- Assignee changed from Bernhard Koschiček-Krombholz to Nina Richards
- 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?
- Target version changed from 7.9.0 to 7.10.0
- Status changed from Resolved to Closed
- Subject changed from API: documentation to API: documentation in manual
- Subject changed from API: documentation in manual to Manual: added API documentation
- Category changed from API to Documentation
Also available in: Atom
PDF
Updated by 
Updated by 
Updated by