Extend Remote API documentation

inception-project / inception

INCEpTION provides a semantic annotation platform offering intelligent annotation assistance and knowledge management.

https://inception-project.github.io

Apache License 2.0

599 stars 152 forks source link

Extend Remote API documentation #1690

Open UWinch opened 4 years ago

UWinch commented 4 years ago

Is your feature request related to a problem? Please describe. The documentation at /swagger-ui.html is not sufficient to understand all API calls, especially parameter contents (e.g. document states).

reckart commented 4 years ago

Is the AERO 1.0.0 spec sufficient?

https://openminted.github.io/releases/aero-spec/1.0.0/omtd-aero/

UWinch commented 4 years ago

That's where I looked when I couldn't find the param values. I think it would be great if we could see some of this directly when trying stuff on the swagger-ui.html page.