matthiaskoenig / pkdb

Pharmacokinetics database
https://alpha.pk-db.com
30 stars 6 forks source link

Better REST documentation #612

Closed matthiaskoenig closed 3 years ago

matthiaskoenig commented 4 years ago

Check if redoc allows for interactive examples (if yes, use it).

interventions__substance_sid__in 13dmu
groups__choice_sid__in abcb1c3435t-c-over-c
individuals__choice_sid__in abcb1c3435t-c-over-c

Document what is returned, i.e the hashes


  |  
-- | --
studies |  
hash | "296f122b-8798-4174-b4aa-a97f43bd71f3"
count | 0
groups |  
hash | "2fc94722-d1d0-49bd-a18d-3f09dc178b01"
count | 0
individuals |  
hash | "732b3f6f-3121-495f-9537-6617e37c2065"
count | 0
interventions |  
hash | "127541b9-19c9-4025-846c-3addd7232a40"
count | 0
outputs |  
hash | "40d1b799-b946-4a3e-a4da-87d7c8b1f9e2"
count | 0
timecourses |  
hash | "cba9f3ff-d43b-4231-b19a-dee31da00320"
count | 0
scatter |  
hash | "8a54a927-4214-43ad-980c-21956bfbf4ac"
count | 0

Individual tab information can then be loaded via the hashes.

The allowed values for filtering can be retrieved via the

The search & retrieve data workflow must work via the APIs.

matthiaskoenig commented 3 years ago

Documentation in frontend is missing I would put the three icons (api, curation, login) on the right in the header bar. Otherwise the API is hidden too much. Also provide the links to the swagger documentation in frontend.