jimmy/postgrest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Typo in api.rst, correct ignore_privileges

Browse Source 
The correct setting name is `ignore-privileges`, with dash in between the words.
This commit is contained in:
Bartłomiej Szostek
2021-10-04 10:46:02 -05:00
committed by Laurence Isla
parent a6a088e9f0
commit ad13e00f64
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
api.rst
+1 -1
View File
@@ -1461,7 +1461,7 @@ Every API hosted by PostgREST automatically serves a full `OpenAPI <https://www.
.. note::
By default, this output depends on the permissions of the role that is contained in the JWT role claim (or the :ref:`db-anon-role` if no JWT is sent). If you need to show all the endpoints disregarding the role's permissions, set the :ref:`openapi-mode` config to :code:`ignore_privileges`.
By default, this output depends on the permissions of the role that is contained in the JWT role claim (or the :ref:`db-anon-role` if no JWT is sent). If you need to show all the endpoints disregarding the role's permissions, set the :ref:`openapi-mode` config to :code:`ignore-privileges`.
For extra customization, the OpenAPI output contains a "description" field for every `SQL comment <https://www.postgresql.org/docs/current/sql-comment.html>`_ on any database object. For instance,