From f5767b8d8671c74bdff0910d39ec5a31f096c9ab Mon Sep 17 00:00:00 2001 From: Laurence Isla Date: Wed, 22 May 2024 16:23:35 -0500 Subject: [PATCH] docs: add "config" and "schema_cache" endpoints to the admin server --- docs/references/admin_server.rst | 37 ++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/references/admin_server.rst b/docs/references/admin_server.rst index e06b7272f..09faecc20 100644 --- a/docs/references/admin_server.rst +++ b/docs/references/admin_server.rst @@ -54,3 +54,40 @@ Metrics ======= Provides :ref:`metrics`. + +Runtime Configuration +===================== + +Provides a ``config`` endpoint that returns the runtime :ref:`configuration`. + +.. code-block:: bash + + curl "http://localhost:3001/config" + +.. code-block:: + + db-aggregates-enabled = false + db-anon-role = "web_anon" + db-channel = "pgrst" + db-channel-enabled = false + ... + +Runtime Schema Cache +==================== + +Provides the ``schema_cache`` endpoint that prints the runtime :ref:`schema_cache`. + +.. code-block:: bash + + curl "http://localhost:3001/schema_cache" + +.. code-block:: json + + { + "dbMediaHandlers": ["..."], + "dbRelationships": ["..."], + "dbRepresentations": ["..."], + "dbRoutines": ["..."], + "dbTables": ["..."], + "dbTimezones": ["..."] + }