search

mmisw / orr-portal

ORR Frontend component
Apache License 2.0
8 stars 5 forks source link

Improve /ont/upload documentation #116

Closed lewismc closed 6 years ago

lewismc commented 6 years ago

The /ont/upload documentation could be improved by explicitly listing the possible formats. Right now it is not obvious and the _guess parameter may not always provide adequate results.

screen shot 2017-12-16 at 11 57 49 am
carueda commented 6 years ago

Thanks for the observation. The heading of that API page points to the general documentation but certainly a direct link in this operation to https://mmisw.org/orrdoc/ontology/new/#supported-ontology-formats can be added.

lewismc commented 6 years ago

ack

carueda commented 6 years ago

Fixed by https://github.com/mmisw/mmiorr-docs/commit/325c0581bfe3e755ab9576f9206c34459b9767fc and manual update of /var/www/html/ontapi/swagger_cor.yaml to reflect the change for the COR.

It now looks like this:

image

with "this section" a link to https://mmisw.org/orrdoc/ontology/new/#supported-ontology-formats

This will be further updated once https://github.com/mmisw/orr-ont/issues/63 is in place.