📚 Docs Feedback: Health check endpoint

novuhq / novu

Open-Source Notification Platform. Embeddable Notification Center, E-mail, Push and Slack Integrations.

https://novu.co

Other

34.01k stars 3.47k forks source link

📚 Docs Feedback: Health check endpoint #5306

Open victorcarnaval opened 5 months ago

victorcarnaval commented 5 months ago

Duplicates

[X] I have searched the existing issues

https://docs.novu.co/api-reference/overview

Kind of issue

Missing information

Issue description

I was looking for health check endpoint and it appears it is not documented in the API reference (Swagger) and docs.

Context 🔦

I'm implementing novu (self-hosted) on Kubernetes and needed to configure livenessProbe. You can only notice the existence of the endpoint in the API logs on the server.

linear[bot] commented 5 months ago

NV-3582 📚 Docs Feedback: Health check endpoint