From: Chao Li <li.evan.chao@gmail.com>
Content-Type: multipart/mixed;
	boundary="Apple-Mail=_EDC0B7C8-ED56-45DD-9DB0-36949B1E41DB"
Mime-Version: 1.0 (Mac OS X Mail 16.0 \(3864.600.51.1.1\))
Subject: Fix OAuth validator docs for error_detail on internal errors
Message-Id: <0281836A-F5FF-41A5-9EE1-656C1FAAC6B2@gmail.com>
Date: Thu, 4 Jun 2026 20:33:39 +0800
Cc: Jacob Champion <jacob.champion@enterprisedb.com>
To: Postgres hackers <pgsql-hackers@lists.postgresql.org>
Archived-At: 
 <https://www.postgresql.org/message-id/0281836A-F5FF-41A5-9EE1-656C1FAAC6B2%40gmail.com>
Precedence: bulk


--Apple-Mail=_EDC0B7C8-ED56-45DD-9DB0-36949B1E41DB
Content-Transfer-Encoding: quoted-printable
Content-Type: text/plain;
	charset=utf-8

Hi,

While testing =E2=80=9C[d438a3659] oauth: Let validators provide failure =
DETAILs=E2=80=9D, I noticed a tiny doc issue.

With this feature, when a validator returns false, result->error_detail =
can carry an error message. However, it seems that the previous =
paragraph was not updated:
```
   <para>
    A validator may return <literal>false</literal> to signal an =
internal error,
    in which case any result parameters are ignored and the connection =
fails.

```

=E2=80=9CAny result parameters are ignored=E2=80=9D is no longer =
accurate; it should be something like =E2=80=9Cany result parameters =
except result->error_detail are ignored=E2=80=9D. This patch just makes =
that tiny doc fix.

Best regards,
--
Chao Li (Evan)
HighGo Software Co., Ltd.
https://www.highgo.com/


--Apple-Mail=_EDC0B7C8-ED56-45DD-9DB0-36949B1E41DB
Content-Disposition: attachment;
	filename=v1-0001-doc-Clarify-OAuth-validator-error_detail-handling.patch
Content-Type: application/octet-stream;
	x-unix-mode=0644;
	name="v1-0001-doc-Clarify-OAuth-validator-error_detail-handling.patch"
Content-Transfer-Encoding: quoted-printable

=46rom=207c70a33a07856df88071ac7991ced1e99fad0dea=20Mon=20Sep=2017=20=
00:00:00=202001=0AFrom:=20"Chao=20Li=20(Evan)"=20<lic@highgo.com>=0A=
Date:=20Thu,=204=20Jun=202026=2019:23:59=20+0800=0ASubject:=20[PATCH=20=
v1]=20doc:=20Clarify=20OAuth=20validator=20error_detail=20handling=0A=0A=
ValidatorModuleResult.error_detail=20is=20still=20consulted=20when=20=
validate_cb=0Areturns=20false=20to=20signal=20an=20internal=20error.=20=20=
Do=20not=20describe=20all=20result=0Aparameters=20as=20ignored=20in=20=
that=20case.=0A=0AAuthor:=20Chao=20Li=20<lic@highgo.com>=0A---=0A=20=
doc/src/sgml/oauth-validators.sgml=20|=207=20++++---=0A=201=20file=20=
changed,=204=20insertions(+),=203=20deletions(-)=0A=0Adiff=20--git=20=
a/doc/src/sgml/oauth-validators.sgml=20=
b/doc/src/sgml/oauth-validators.sgml=0Aindex=208aad470a464..7015664f26c=20=
100644=0A---=20a/doc/src/sgml/oauth-validators.sgml=0A+++=20=
b/doc/src/sgml/oauth-validators.sgml=0A@@=20-399,9=20+399,10=20@@=20=
typedef=20struct=20ValidatorModuleResult=0A=20=20=20=20</para>=0A=20=20=20=
=20<para>=0A=20=20=20=20=20A=20validator=20may=20return=20=
<literal>false</literal>=20to=20signal=20an=20internal=20error,=0A-=20=20=
=20=20in=20which=20case=20any=20result=20parameters=20are=20ignored=20=
and=20the=20connection=20fails.=0A-=20=20=20=20Otherwise=20the=20=
validator=20should=20return=20<literal>true</literal>=20to=20indicate=0A=
-=20=20=20=20that=20it=20has=20processed=20the=20token=20and=20made=20an=20=
authorization=20decision.=0A+=20=20=20=20in=20which=20case=20the=20=
connection=20fails.=20Except=20for=0A+=20=20=20=20=
<structfield>result->error_detail</structfield>,=20all=20result=20=
parameters=20are=0A+=20=20=20=20ignored.=20Otherwise=20the=20validator=20=
should=20return=20<literal>true</literal>=20to=0A+=20=20=20=20indicate=20=
that=20it=20has=20processed=20the=20token=20and=20made=20an=20=
authorization=20decision.=0A=20=20=20=20</para>=0A=20=20=20=20<para>=0A=20=
=20=20=20=20In=20either=20failure=20case=20(validation=20error=20or=20=
internal=20error)=20the=20module=20may=0A--=20=0A2.50.1=20(Apple=20=
Git-155)=0A=0A=

--Apple-Mail=_EDC0B7C8-ED56-45DD-9DB0-36949B1E41DB--