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

[Doc] API #32

Open
NiklasVousten opened this issue Sep 23, 2024 · 0 comments
Open

[Doc] API #32

NiklasVousten opened this issue Sep 23, 2024 · 0 comments

Comments

@NiklasVousten
Copy link
Contributor

I think it would be nice to have a short over view over the API endpoints. Maybe in a separate markdown document.

The API documentation can be enabled on the server, but I think it would be nice to have a different source than the own instance of crab-hole.

For example it can be that an instance with API but without documentation is deployed by an admin, and a different member has to query the API. For this person, a short overview over the endpoints would be very helpful. Otherwise this person would have to read the source code, or ask the admin to temporarily enable the documentation.

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

No branches or pull requests

1 participant