postgrest-docs

postgrest-docs copied to clipboard

Automated testing for tutorials

3

Just saw this: http://www.haskellforall.com/2020/11/how-to-use-nixos-for-lightweight.html Really interesting, automated testing with Nix for tutorials. Could be a future enhancement for the docs.

steve-chavez

Add example for ordering by json field

1

Currently missing in: http://postgrest.org/en/latest/api.html#json-columns

steve-chavez

Change the api reference http blocks to curl calls

1

This might be particularly helpful in the function section: http://postgrest.org/en/latest/api.html#stored-procedures This: ``` curl http://localhost:3000/rpc/add_them \ -X POST -H "Content-Type: application/json" \ -d '{"a": 3,"b":2}' ``` Is more useful than: ```...

steve-chavez

Preventing auto-updateability for a simple view will allow the OpenAPI output to only show the `GET` and not the other request methods. Just add the no-op `OFFSET NULL` to the...

wolfgangwalther

Under http://postgrest.org/en/v7.0.0/api.html#http-logic. Related to https://github.com/PostgREST/postgrest/issues/1642. Recommend to add a wrapper function as in https://github.com/PostgREST/postgrest/issues/1642#issuecomment-720566013.

steve-chavez

Add logging enhancements

1

Recommend using `log_line_prefix` and `application_name` as mentioned in https://github.com/PostgREST/postgrest/issues/540#issuecomment-540649767. In http://postgrest.org/en/v6.0/admin.html#database-logs.

steve-chavez

This would help newcomers understand what PostgREST does and avoid thinking it's "too magic". It could contain examples of the generated queries, the flow of the request(parser combinators -> statement)...

steve-chavez

Add this on http://postgrest.org/en/v7.0.0/admin.html. Useful for load balancing. See http://postgrest.org/en/v7.0.0/admin.html. Related to https://github.com/PostgREST/postgrest/issues/1565#event-3625223607.

steve-chavez

Configuration for keycloak

5

Follow the guideline in https://github.com/PostgREST/postgrest/issues/1191

steve-chavez

Warn about out of schema types error on SECURITY DEFINER

1

In http://postgrest.org/en/v7.0.0/schema_structure.html#schema-isolation. Functions don't find types outside of the api schema. Unless a `search_path` is added to them(see https://www.postgresql.org/docs/13/sql-createfunction.html#SQL-CREATEFUNCTION-SECURITY). This can show a: `ERROR: permission denied for schema `. This...

steve-chavez