Project

General

Profile

Actions

Feature #1701

closed

Manual: added API documentation

Added by Alexander Watzinger almost 2 years ago. Updated about 1 year ago.

Status:
Closed
Priority:
Normal
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 1 (0 open1 closed)

Related to OpenAtlas - Feature #1751: Manual: add model documentationClosedNina Richards2022-08-29Actions
Actions #1

Updated by Alexander Watzinger almost 2 years ago

  • Description updated (diff)
Actions #2

Updated by Alexander Watzinger over 1 year ago

  • Related to Feature #1751: Manual: add model documentation added
Actions #3

Updated by Alexander Watzinger over 1 year ago

  • Status changed from Assigned to In Progress
Actions #4

Updated by Bernhard Koschiček-Krombholz over 1 year ago

  • Target version changed from 208 to 7.7.0
Actions #5

Updated by Bernhard Koschiček-Krombholz over 1 year ago

  • Target version changed from 7.7.0 to 7.8.0
Actions #6

Updated by Alexander Watzinger over 1 year ago

  • Target version changed from 7.8.0 to 7.9.0
Actions #7

Updated by Alexander Watzinger about 1 year ago

  • Assignee changed from Bernhard Koschiček-Krombholz to Nina Richards
Actions #8

Updated by Nina Richards about 1 year ago

  • 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?

Actions #9

Updated by Alexander Watzinger about 1 year ago

  • Target version changed from 7.9.0 to 7.10.0
Actions #10

Updated by Alexander Watzinger about 1 year ago

  • Status changed from Resolved to Closed
Actions #11

Updated by Alexander Watzinger about 1 year ago

  • Subject changed from API: documentation to API: documentation in manual
Actions #12

Updated by Alexander Watzinger about 1 year ago

  • Subject changed from API: documentation in manual to Manual: added API documentation
  • Category changed from API to Documentation
Actions

Also available in: Atom PDF