steve-chavez
c8ba505b99
docs: linkcheck ignore patreon
2024-05-19 13:44:23 -05:00
steve-chavez
d25df459ea
feat: add metric label for scache load
...
localhost:3001/metrics now includes:
pgrst_schema_cache_loads_total{status="FAIL"} 352.0
pgrst_schema_cache_loads_total{status="SUCCESS"} 3.0
This allows testing the failure case on:
https://github.com/PostgREST/postgrest/issues/3424#issuecomment-2104904910
2024-05-14 17:57:21 -05:00
Wolfgang Walther
aef29d49ba
docs: Mark db_tx_end as db-configurable
2024-05-12 11:53:59 +02:00
Taimoor Zaeem and Wolfgang Walther
7a5079542c
docs: update docs for pg error 53400
2024-05-12 11:47:05 +02:00
steve-chavez
0060abeb01
feat: /live and /ready respond with 500 on failure
...
503 is still used by /ready to indicate a transient state
that can be recovered from.
2024-05-08 17:19:48 -05:00
steve-chavez
df9b373465
docs: better place for application_name
2024-05-06 11:12:45 -05:00
steve-chavez
7e91e5311d
fix: not adding application_name on all URIs
2024-05-06 11:12:45 -05:00
Taimoor Zaeem and Steve Chavez
7e5fd317e6
docs: add docs page for CLI
2024-04-29 12:51:54 -05:00
Laurence Isla
85a4e35a2d
docs: fix http status for PGRST121 error
2024-04-24 15:04:35 -05:00
steve-chavez
3eff4670f0
docs: metrics for schema cache and connection pool
2024-04-23 19:08:37 -05:00
steve-chavez
3e615bd0d9
feat: add log-level=debug
2024-04-22 21:36:29 -05:00
Taimoor Zaeem and Steve Chavez
88abf600c4
fix: fix wrong http status on pg error 42P17 infinite recursion
2024-04-22 13:40:07 -05:00
steve-chavez
b88191299f
docs: remove schema cache dep from Query
2024-04-10 19:35:23 -05:00
Laurence Isla
4bcd6725fe
chore: update sponsor logos
2024-04-10 18:37:57 -05:00
Laurence Isla
70396d3f6c
docs: add dark mode
...
- Uses sphinx-rtd-dark-mode for sphinx-rtd-theme
- Adds dark mode logos for sponsors
2024-04-10 18:37:57 -05:00
steve-chavez
c9136816a2
docs: move ARCHITECTURE.md to architecture.rst
2024-04-10 15:51:08 -05:00
steve-chavez
4428253efe
docs: move health_check.rst to admin_server.rst
2024-04-10 15:51:08 -05:00
steve-chavez
47a4e2bfd0
docs: add proxy and config reloading to arch
2024-04-10 13:57:49 -05:00
steve-chavez
2772b78013
docs: add config/cli/developer to arch
2024-04-08 15:51:30 -05:00
steve-chavez
ab73624366
docs: add architecture diagram
2024-04-08 11:57:03 -05:00
steve-chavez
3d55f77bae
Revert "fix: slow responses on schema cache reload"
...
This reverts commit 727ef465c1 .
Also documents requests waiting for the schema cache.
2024-04-02 23:15:09 -05:00
steve-chavez
d7c64a93f8
docs: update schema cache
2024-04-01 19:03:14 -05:00
steve-chavez
9405a62de8
docs: update links to cache/config notify reload
2024-03-08 10:31:55 -05:00
Steve Chavez and GitHub
2f91853cb1
docs: add index usage section ( #3299 )
2024-03-02 11:00:31 -05:00
Laurence Isla and Wolfgang Walther
b8b957667b
docs: add enums to working with data types how-to
2024-03-02 12:14:13 +01:00
renovate[bot] and Wolfgang Walther
f97c6e3db3
chore(deps): update dependency urllib3 to v2.2.1
2024-02-24 20:38:43 +01:00
renovate[bot] and Wolfgang Walther
e6cde92f11
chore(deps): update dependency sphinxext-opengraph to v0.9.1
2024-02-24 20:01:04 +01:00
renovate[bot] and Wolfgang Walther
f7879bd4b1
chore(deps): update dependency docutils to v0.20.1
2024-02-24 20:00:51 +01:00
Wolfgang Walther and Wolfgang Walther
1a141c19df
nix: Add postgrest-docs-render to render latex documents
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
b8f35d880f
docs: Fix broken redirects in api.rst
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
791b86cbf6
docs: Add note about not support Stored Procedures
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/147
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
944b02fbb8
docs: Rename Stored Procedures to Functions consistently
...
This avoids confusing our RPCs with actual CREATE PROCEDURE, which we don't
support.
References https://github.com/PostgREST/postgrest-docs/issues/147
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
95b8751496
docs: Simplify SQL for user management how-tos
...
All those DROP IF EXISTS and CREATE IF NOT EXISTS etc. just give a lot more text to
read and understand. If in fact a user creates the same thing twice, they should be
able to understand the error message from postgres.
2024-02-21 09:40:11 +01:00
Wolfgang Walther and Wolfgang Walther
9b1ff2235a
docs: Simplify auth examples with OUT parameter
...
The jwt_token type was not created consistently in all examples, which can
be confusing when following those. To return an object with a single key
named token, it's enough to have an OUT parameter to the function.
Resolves https://github.com/PostgREST/postgrest-docs/issues/280
2024-02-21 09:40:11 +01:00
Laurence Isla and GitHub
229bc77886
docs: using or across embedded resources
2024-02-20 17:15:42 -05:00
Wolfgang Walther and Wolfgang Walther
fac7acafa3
chore: Add docs/_build to .gitignore again to allow switching to old release branches easily
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
645217333b
docs: Display version number more prominently
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/734
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
fcd29caecf
docs: Use code-block postgres consistently
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
553ac79d9b
docs: Add example on how to automatically store mimetype in files table
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/612
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
b2ad914435
docs: Improve introduction for datatypes how-to
...
Not all examples on this page are strictly using string representation, especially bytea.
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
8ee4e9f0bb
docs: Sort datatypes how-to alphabetically
...
The examples in this sections were in seemingly random order before.
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
8f2b6b1652
docs: Add hint about schema reloading with db-config=true
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/490
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
b1deb049c8
docs: Clarify behavior of jwt-aud and tokens without aud claim
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/479
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
51db5ce26f
docs: Add example for ordering by json field
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/364
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
e7dde2806c
docs: Change tutorials to use identity column instead of serial/sequence
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/311
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
4325a4f9d5
docs: Add links to resource embedding from insert/update/delete sections
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/277
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
77715dcabf
docs: Rename remaining instances of computed columns to computed fields
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/368
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
aaaf0572ce
docs: Remove deprecated auth0 features
...
As mentioned in https://github.com/PostgREST/postgrest/discussions/3088 rules and hooks are not
available to new tenants anymore, so the note is not helpful anymore.
Resolves #3088
Resolves https://github.com/PostgREST/postgrest-docs/issues/85
Resolves https://github.com/PostgREST/postgrest-docs/issues/715
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
500aad3360
docs: Clarify secret wording in tutorial 1
...
Resolves https://github.com/PostgREST/postgrest-docs/issues/108
2024-02-19 21:54:15 +01:00
Wolfgang Walther and Wolfgang Walther
3d95c41115
docs: Remove note about risk of asymmetric keys for JWT auth
...
The obviously wrong statement is, that PostgREST does not support asymmetric keys, while it
does. Extending on this type of attack is not necessary, because it is in fact covered by
the paragraph before - reading the algorithm from the JWT header is the problem in that case,
too. We don't do that.
This leaves us with the sentence about how the chosen library is the most important part. While
that is correct, the hint about high quality libraries for use on the *client* side is mis-
leading: The important part here is the library we choose to implement PostgREST with, not the
client-side lib. Thus, removing the whole paragraph is the best thing to do here.
Resolves https://github.com/PostgREST/postgrest-docs/issues/123
2024-02-19 21:54:15 +01:00