Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not all API endpoints are fine #152

Open
eboileau opened this issue Aug 20, 2024 · 0 comments
Open

Not all API endpoints are fine #152

eboileau opened this issue Aug 20, 2024 · 0 comments
Assignees
Labels
status:long-running Continuous improvement type:maintenance Patch maintenance

Comments

@eboileau
Copy link
Collaborator

eboileau commented Aug 20, 2024

Aims/objectives.

We would like in the longer-term to provide a documented functional REST API service. How would that work with https://scimodom.dieterichlab.org ?

Although most API endpoints should be safe by now to be reached directly, I believe there still may be some unhandled cases, unspecific error handling, etc. Some endpoints were initially designed, for simplicity, assuming they would receive validated data only from the frontend, and thus may fail in general, e.g. http://127.0.0.1:5000/api/v0/modification/

Other endpoints, e.g. those related to the Compare view, may be more complicated to handle. I don't know if there is a general recommended way to handle APIs with endpoints that are generally accessible, endpoints that only make sense to be called from the web application frontend, and secure endpoints?

See also #74.

A clear and concise description of todo items.

  • The first thing to do is to go through all endpoints, and make sure they all have proper "data validation", adequate error handling, and to handle restricted endpoints appropriately.
@eboileau eboileau added type:maintenance Patch maintenance status:long-running Continuous improvement labels Aug 20, 2024
@eboileau eboileau self-assigned this Aug 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:long-running Continuous improvement type:maintenance Patch maintenance
Projects
None yet
Development

No branches or pull requests

1 participant