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

Feature request: The root of /api/v0 should return the list of available endpoints #368

Open
BjrInt opened this issue Jan 23, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@BjrInt
Copy link
Member

BjrInt commented Jan 23, 2023

Problem description

When hitting https://api2.aleph.im/api/v0/ (or official.aleph.cloud), user are faced with a 404 error.

Proposal

This 404 is misleading as the base endpoint could also be used as a status check. Returning a list of available endpoints as a JSON object instead, would enhance the developer experience.

@BjrInt BjrInt added the enhancement New feature or request label Jan 23, 2023
@odesenfans
Copy link
Contributor

The right way to do this IMO is to provide an OpenAPI spec to the users. I think there's a way to do this with aiohttp but it would be much better to start using a better server-side framework that does this automatically for us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants