Skip to content

Commit

Permalink
Merge pull request #1876 from rgaiacs/add-endpoint-to-docs
Browse files Browse the repository at this point in the history
Add all API endpoints to the documentation
  • Loading branch information
manics authored Aug 7, 2024
2 parents a8a2e19 + bcc65fb commit c71bd8a
Showing 1 changed file with 25 additions and 3 deletions.
28 changes: 25 additions & 3 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
@@ -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:

::

Expand Down Expand Up @@ -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
------
Expand Down

0 comments on commit c71bd8a

Please sign in to comment.