JavaDoc updates

blakemcbride · Nov 2, 2023 · 49234dc · 49234dc
1 parent f92d330
commit 49234dc
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/main/core/org/kissweb/RestServer.java b/src/main/core/org/kissweb/RestServer.java
@@ -27,6 +27,8 @@
  * (2) Be sure to set the <code>urlPattern</code>.
  * <br><br>
  * (3) If basic authentication is being used, enable it by setting <code></code> and set the <code>username</code> and <code>password</code>.
+ * <br><br>
+ * (4) Since this will be Java code, Kiss will have to be rebuilt.
  */
 @WebServlet(urlPatterns="/myservice")
 @MultipartConfig

diff --git a/src/main/core/org/kissweb/RestServerBase.java b/src/main/core/org/kissweb/RestServerBase.java
@@ -23,6 +23,10 @@ public abstract class RestServerBase extends HttpServlet {
 
     /**
      * Support for Basic Authentication.
+     * <br><br>
+     * The way basic authentication works is that the client uses a URL with the following format:<br>
+     * <code>https://[username]:[password]@[full-URL]</code><br>
+     * The <code>username</code> and <code>password</code> are validated against what is passed in.
      *
      * @param request
      * @param response