Update OpenAPI Comments and UI

frostyfan109 / tranql

A Translator Query Language

https://researchsoftwareinstitute.github.io/data-translator/apps/tranql

MIT License

0 stars 1 forks source link

Update OpenAPI Comments and UI #96

Closed stevencox closed 5 years ago

stevencox commented 5 years ago

Update the OpenAPI annotations in api.py and server.py to generate useful documentation.

Also update the approach to generating the UI.

stevencox commented 5 years ago

Could we get this one into the upcoming pull request?

frostyfan109 commented 5 years ago

✔️ api.py
✔️ server.py

stevencox commented 5 years ago

The API UI looks much improved. A few questions -

Can we get just a bit more descriptive verbiage on each of the endpoints UI about what they are supposed to do?
Starting around here there's a lot of JSON in api.py. Is there straightforward way of keeping this kind of configuration in an external yaml configuration?

No is a perfectly alright answer to the second one but it would be nice.

frostyfan109 commented 5 years ago

1) Sure.

2) That's very doable, it is a bit out of place. The reason it's there is because api.py loads backplane/translator_interchange.yaml for the schemas, but that file shouldn't be directly modified. I should just move the JSON definitions into its own file and load both files.