From 6730793668ac6a07a60b7f859e66fd35f02cf236 Mon Sep 17 00:00:00 2001
From: zzz <zzz@i2pmail.org>
Date: Thu, 11 Jan 2024 07:31:27 -0500
Subject: [PATCH] SAM: Add more info and guidance on error messages

---
 i2p2www/pages/site/docs/api/samv3.html | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/i2p2www/pages/site/docs/api/samv3.html b/i2p2www/pages/site/docs/api/samv3.html
index acc55982..7305588a 100644
--- a/i2p2www/pages/site/docs/api/samv3.html
+++ b/i2p2www/pages/site/docs/api/samv3.html
@@ -1823,6 +1823,22 @@ their meaning:
  TIMEOUT         Timeout while waiting for an event (e.g. peer answer)
 </pre>
 
+<p>
+Different implementations may not be consistent in which RESULT is returned
+in various scenarios.
+
+<p>
+Most responses with a RESULT, other than OK, will also include a MESSAGE with additional information.
+The MESSAGE will generally be helpful in debugging problems.
+However, MESSAGE strings are implementation-dependent,
+may or may not be translated by the SAM server to the current locale,
+may contain internal implementation-specific information such as exceptions,
+and are subject to change without notice.
+While SAM clients may choose to expose MESSAGE strings to users,
+they should not make programmatic decisions based on those strings,
+as that will be fragile.
+
+
 
 <h3 id="options">Tunnel, I2CP, and Streaming Options</h3>
 <p>
-- 
GitLab