Re: Fix OAuth validator docs for error_detail on internal errors
Chao Li <li.evan.chao@gmail.com>
From: Chao Li <li.evan.chao@gmail.com>
To: Daniel Gustafsson <daniel@yesql.se>
Cc: Postgres hackers <pgsql-hackers@lists.postgresql.org>,
Jacob Champion <jacob.champion@enterprisedb.com>
Date: 2026-06-04T22:21:07Z
Lists: pgsql-hackers
Attachments
- v2-0001-doc-clarify-OAuth-validator-authn_id-logging-on-a.patch (application/octet-stream) patch v2-0001
> On Jun 5, 2026, at 04:19, Daniel Gustafsson <daniel@yesql.se> wrote: > >> On 4 Jun 2026, at 14:33, Chao Li <li.evan.chao@gmail.com> wrote: > >> “Any result parameters are ignored” is no longer accurate; it should be something like “any result parameters except result->error_detail are ignored”. This patch just makes that tiny doc fix. > > That's true, but error_detail is explained in detail in the next paragraph so > I'm not sure this change is needed. Agreed. Adding the “exception for result->error_detail” sounds a bit redundant with the next paragraph. But “any result parameters are ignored” also seems to conflict with the next paragraph, so I think we can just delete that part. ValidatorModuleResult has three fields, so the logic is: * The first paragraph talks about authorized and authn_id when the validator succeeds. * The second paragraph talks about the validator’s return values. * The third paragraph talks about result->error_detail when the validator fails. > > Another thing we don't explicitly document which seems more interesting is that > authn_id is used even in case of failure if log_connections is enabled. Maybe > that deserves a mention? > This is a good point. I added that in v2. Best regards, -- Chao Li (Evan) HighGo Software Co., Ltd. https://www.highgo.com/
Commits
-
doc: Clarify OAuth validator authn_id logging
- 4cb2e2fe0aa8 19 (unreleased) landed