David BaynardandGitHub
018427e2b6
* Clarify vnd.pgrst.object+json is also Content-Type The previous docs explained how the `Accept` header could be set to `application/vnd.pgrst.object+json`. This change indicates the resulting response `Content-Type` begins likewise. While robust clients will correctly identify that `application/vnd.pgrst.object+json` data are json, many others which naively check the `Content-Type` is `application/json` will fail to recognize what should be a valid `Content-Type`.
PostgREST documentation https://postgrest.org/
PostgREST docs use the reStructuredText format, check this cheatsheet to get acquainted with it.
To build the docs locally, use nix:
nix-shell
Once in the nix-shell you have the following commands available:
postgrest-docs-build: Build the docs.postgrest-docs-serve: Build the docs and start a livereload server onhttp://localhost:5500.postgrest-docs-spellcheck: Run aspell.
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.