-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Description
Currently the API only provides two functions:
- annotations: gets the list of annotations for the given pdb id
- entries: gets all entries in a given databank and state (PRESENT, VALID, etc)
There are two generic use cases for the API:
- Allow other services to update whynot when an entry is missing by providing the annotation. This would primarily be used by the databank update scripts. It has the knock on effect that whynot wouldn't need to crawl and annotate itself anymore, which performs poorly and often lags behind the real state of the databanks.
- Allow humans to manually update entries. Currently this is done by placing files in a
commentanduncommentfolder on the server, which is not ideal.
I also think this is a good opportunity to standardise the API using a hypermedia format like JSON-API and consolidate the API endpoints.
To Do
- Consider security implications. How exposed is the API?
- Propose endpoints
Metadata
Metadata
Assignees
Labels
No labels