moltimate / moltimate-backend

A protein active site alignment tool
GNU General Public License v2.0
10 stars 6 forks source link

Swagger UI & InvalidPdbIdException #86

Closed blackpan2 closed 5 years ago

blackpan2 commented 5 years ago

Swagger

Requires renaming of ActiveSiteAlignmentRequest:getCustomMotifs & getPdbForStructures With renaming: Preview with Renaming

Without renaming (also warning this takes a long time and Chrome asks multiple times if you want to wait or kill the page): The reason it takes a long time is because Swagger is building the complete reference as it parses through the BioJava object Preview without Renaming 1 Preview without Renaming 2

The annotations have been added for AlignmentController but not the other controllers yet, the automatically built information seems to be clear enough

To be able to see what the docs look like without using the branch, copy the "swagger.txt" information into the Swagger Editor (it will have some errors due to missing object definitions in the editor)

swagger.txt Swagger Editor

Using Optionals when calling PDB

If we provide multiple PDB ids to the alignment call and one/not all of them is bad (such as asdf which doesn't exist on the PDB) we should still execute the working ids and complete the request.

steplica commented 5 years ago

LGTM once the merge conflicts are fixed again (sorry, might be because of recent merges) 👍