From: Nick Porter <nick@portercomputing.co.uk>
Date: Wed, 7 Aug 2024 08:22:40 +0000 (+0100)
Subject: Add notes on when actions are used
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=904236bd5fba52079d6843c6ec043f1f075ac47e;p=thirdparty%2Ffreeradius-server.git

Add notes on when actions are used
---

diff --git a/raddb/mods-available/rest b/raddb/mods-available/rest
index c6d4fbf6e8a..a252763bb6d 100644
--- a/raddb/mods-available/rest
+++ b/raddb/mods-available/rest
@@ -360,6 +360,8 @@ rest {
 	#
 	#  ### Authorize { ... }
 	#
+	#  Default action when called in `recv` sections except `recv Accounting-Request`.
+	#
 	#  [options="header,autowidth"]
 	#  |===
 	#  | Code | Meaning      | Process body? | Module code
@@ -384,7 +386,9 @@ rest {
 	#
 	#  ### Authenticate { ... }
 	#
-	#  Same as `Authorize { ... }`
+	#  Default action when called in `authenticate` sections.
+	#
+	#  Return codes handled the same as `Authorize { ... }`
 	#
 	authenticate {
 		request {
@@ -397,6 +401,8 @@ rest {
 	#
 	#  ### Accounting { ... }
 	#
+	#  Default action when called in `recv Accounting-Request` or `accounting` sections.
+	#
 	#  [options="header,autowidth"]
 	#  |===
 	#  | Code | Meaning      | Process body? | Module code
@@ -417,7 +423,9 @@ rest {
 	#
 	#  ### Post-Auth { ... }
 	#
-	#  Same as `Accounting { ... }`
+	#  Default action when called in `send` sections.
+	#
+	#  Return codes handled the same as `Accounting { ... }`
 	#
 	post-auth {
 		request {