search

Steinbeck-Lab / cheminformatics-microservice

This set of essential and valuable microservices is designed to be accessed via API calls to support cheminformatics.
https://docs.api.naturalproducts.net
MIT License
30 stars 4 forks source link

Index endpoints are confusing #300

Closed cthoyt closed 1 year ago

cthoyt commented 1 year ago

Each of the components of this service have their own index endpoint like https://dev.api.naturalproducts.net/v1/chem/. This doesn't actually do anything other than return a response code. Since it's not really documented why this is here, I would suggest removing all of these index endpoints, since they are a distraction from the other more important parts

Alternatively, you might have some meta-component that gives information about the service's status/health that is decoupled from the components themselves

CS76 commented 1 year ago

image

Health checks are hidden from the schema except for the one at the root (app) level.