Jason CloseandGitHub
1fff248c78
This change adds an explanation of how to handle an array of JSON objects within an RPC call. To pass multiple objects, an array of JSON objects must be the JSON value, with the key being the json or jsonb variable name of the Postgres function. For people who want to perform multiple tasks/inserts/updates within a single API call, this is a needed explanation for that use-case.
PostgREST documentation https://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
To build the docs locally, see the Nix development readme.
Documentation structure
This documentation is structured according to tutorials-howtos-topics-references. For more details on the rationale of this structure, see https://www.divio.com/blog/documentation.
Translating
To create .po files for translation into a new language pass the language code as the first argument to postgrest-docs-build.
Example to add German/de:
postgrest-docs-build de
The livereload server also supports a language/locale argument to show the translated docs during translation:
postgrest-docs-serve de
Spellcheck is currently only available for the default language.