From c4005ad8f27ad4463fbb48bc0904f04d5fe57341 Mon Sep 17 00:00:00 2001 From: steve-chavez Date: Thu, 6 Feb 2020 14:21:43 -0500 Subject: [PATCH] Change server-proxy-uri 2 openapi-server-proxy-uri --- configuration.rst | 54 +++++++++++++++++++++---------------------- releases/upcoming.rst | 2 ++ 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/configuration.rst b/configuration.rst index 6317aa4db..fe9b9f7f2 100644 --- a/configuration.rst +++ b/configuration.rst @@ -30,29 +30,29 @@ The user specified in the db-uri is also known as the authenticator role. For mo Here is the full list of configuration parameters. -======================= ====== ========= ======== -Name Type Default Required -======================= ====== ========= ======== -db-uri String Y -db-schema String Y -db-anon-role String Y -db-pool Int 10 -db-pool-timeout Int 10 -db-extra-search-path String public -server-host String !4 -server-port Int 3000 -server-unix-socket String -server-unix-socket-mode String 660 -server-proxy-uri String -jwt-secret String -jwt-aud String -secret-is-base64 Bool False -max-rows Int ∞ -pre-request String -app.settings.* String -role-claim-key String .role -raw-media-types String -======================= ====== ========= ======== +======================== ====== ========= ======== +Name Type Default Required +======================== ====== ========= ======== +db-uri String Y +db-schema String Y +db-anon-role String Y +db-pool Int 10 +db-pool-timeout Int 10 +db-extra-search-path String public +server-host String !4 +server-port Int 3000 +server-unix-socket String +server-unix-socket-mode String 660 +openapi-server-proxy-uri String +jwt-secret String +jwt-aud String +secret-is-base64 Bool False +max-rows Int ∞ +pre-request String +app.settings.* String +role-claim-key String .role +raw-media-types String +======================== ====== ========= ======== .. _db-uri: @@ -149,15 +149,15 @@ server-unix-socket-mode `Unix file mode `_ to be set for the socket specified in :ref:`server-unix-socket` Needs to be a valid octal between 600 and 777. - + .. code:: bash server-unix-socket-mode = "660" -.. _server-proxy-uri: +.. _openapi-server-proxy-uri: -server-proxy-uri ----------------- +openapi-server-proxy-uri +------------------------ Overrides the base URL used within the OpenAPI self-documentation hosted at the API root path. Use a complete URI syntax :code:`scheme:[//[user:password@]host[:port]][/]path[?query][#fragment]`. Ex. :code:`https://postgrest.com` diff --git a/releases/upcoming.rst b/releases/upcoming.rst index 72293b8fa..19572008f 100644 --- a/releases/upcoming.rst +++ b/releases/upcoming.rst @@ -24,3 +24,5 @@ Changed ------- * :ref:`bulk_call` should now be done by specifying a ``Prefer: params=multiple-objects`` header. + +* ``server-proxy-uri`` config option has been renamed to :ref:`openapi-server-proxy-uri`.