From bcc65fbe840828674dc0e868308b96d4cf013cb5 Mon Sep 17 00:00:00 2001
From: Raniere Silva <Raniere.CostadaSilva@gesis.org>
Date: Wed, 7 Aug 2024 12:27:41 +0200
Subject: [PATCH] Add all API endpoints to the documentation

Closes https://github.com/jupyterhub/mybinder.org-deploy/issues/3057

Closes https://github.com/jupyterhub/mybinder.org-deploy/issues/3058
---
 docs/source/api.rst | 28 +++++++++++++++++++++++++---
 1 file changed, 25 insertions(+), 3 deletions(-)

diff --git a/docs/source/api.rst b/docs/source/api.rst
index ebd18dc4a..6acdfb777 100644
--- a/docs/source/api.rst
+++ b/docs/source/api.rst
@@ -1,10 +1,13 @@
 BinderHub API Documentation
 ===========================
 
-Endpoint
---------
+Endpoints
+---------
+
+`/build`
+~~~~~~~~
 
-There's one API endpoint, which is:
+This is the main API endpoint, which is:
 
 ::
 
@@ -40,6 +43,25 @@ When the request is received, the following happens:
 4. If the build succeeds, we contact the JupyterHub API and start
    launching the server.
 
+`/health`
+~~~~~~~~~
+
+This reports the health of BinderHub and the services it needs to run.
+
+`/metrics`
+~~~~~~~~~~
+
+This reports the metrics for `Prometheus <https://prometheus.io/>`_.
+
+`/versions`
+~~~~~~~~~~~
+
+This reports the version of BinderHub and the services it needs to run.
+
+`/_config`
+~~~~~~~~~~
+
+This reports which :doc:`repository providers </reference/repoproviders>` are enabled.
 
 Events
 ------