v1-0001-doc-Clarify-OAuth-validator-error_detail-handling.patch
application/octet-stream
Filename: v1-0001-doc-Clarify-OAuth-validator-error_detail-handling.patch
Type: application/octet-stream
Part: 0
Patch
Format: format-patch
Series: patch v1-0001
Subject: doc: Clarify OAuth validator error_detail handling
| File | + | − |
|---|---|---|
| doc/src/sgml/oauth-validators.sgml | 4 | 3 |
From 7c70a33a07856df88071ac7991ced1e99fad0dea Mon Sep 17 00:00:00 2001
From: "Chao Li (Evan)" <lic@highgo.com>
Date: Thu, 4 Jun 2026 19:23:59 +0800
Subject: [PATCH v1] doc: Clarify OAuth validator error_detail handling
ValidatorModuleResult.error_detail is still consulted when validate_cb
returns false to signal an internal error. Do not describe all result
parameters as ignored in that case.
Author: Chao Li <lic@highgo.com>
---
doc/src/sgml/oauth-validators.sgml | 7 ++++---
1 file changed, 4 insertions(+), 3 deletions(-)
diff --git a/doc/src/sgml/oauth-validators.sgml b/doc/src/sgml/oauth-validators.sgml
index 8aad470a464..7015664f26c 100644
--- a/doc/src/sgml/oauth-validators.sgml
+++ b/doc/src/sgml/oauth-validators.sgml
@@ -399,9 +399,10 @@ typedef struct ValidatorModuleResult
</para>
<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.
- Otherwise the validator should return <literal>true</literal> to indicate
- that it has processed the token and made an authorization decision.
+ in which case the connection fails. Except for
+ <structfield>result->error_detail</structfield>, all result parameters are
+ ignored. Otherwise the validator should return <literal>true</literal> to
+ indicate that it has processed the token and made an authorization decision.
</para>
<para>
In either failure case (validation error or internal error) the module may
--
2.50.1 (Apple Git-155)