.

com-lihaoyi · Jan 4, 2024 · 0b17c25 · 0b17c25
1 parent d251252
commit 0b17c25
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/example/queryParams/app/src/QueryParams.scala b/example/queryParams/app/src/QueryParams.scala
@@ -1,7 +1,7 @@
 package app
 object QueryParams extends cask.MainRoutes{
 
-  @cask.get("/article/:articleId") // Mandatory query param
+  @cask.get("/article/:articleId") // Mandatory query param, e.g. HOST/article/foo?param=bar
   def getArticle(articleId: Int, param: String) = { 
     s"Article $articleId $param"
   }
@@ -16,7 +16,7 @@ object QueryParams extends cask.MainRoutes{
     s"Article $articleId $param"
   }
 
-  @cask.get("/article4/:articleId") // 1-or-more query param
+  @cask.get("/article4/:articleId") // 1-or-more param, e.g. HOST/article/foo?param=bar&param=qux
   def getArticleSeq(articleId: Int, param: Seq[String]) = {
     s"Article $articleId $param"
   }
@@ -26,7 +26,7 @@ object QueryParams extends cask.MainRoutes{
     s"Article $articleId $param"
   }
 
-  @cask.get("/user2/:userName") // allow unknown query params
+  @cask.get("/user2/:userName") // allow unknown params, e.g. HOST/article/foo?foo=bar&qux=baz
   def getUserProfileAllowUnknown(userName: String, params: cask.QueryParams) = {
     s"User $userName " + params.value
   }

diff --git a/example/variableRoutes/app/src/VariableRoutes.scala b/example/variableRoutes/app/src/VariableRoutes.scala
@@ -1,6 +1,6 @@
 package app
 object VariableRoutes extends cask.MainRoutes{
-  @cask.get("/user/:userName") // variable path segment
+  @cask.get("/user/:userName") // variable path segment, e.g. HOST/user/lihaoyi
   def getUserProfile(userName: String) = {
     s"User $userName"
   }