API(App, User, Reversion): Add PATCH endpoints

- Suppress unused warning for more controllers
- Update SPEC
- Update SPEC JSON
- Add default content type (json) for Spectrum
- Add XmlTransient for User private fields

Signed-off-by: duangsuse <fedora-opensuse@outlook.com>

Author: duangsuse

.idea/misc.xml

@@ -70,43 +70,43 @@ DELETE@removeComment(cid-path:CommentId) -> [$cid:number, $deletedSubComments:nu
 ## GeekApk Categories section
 
 categoryList() -> array:Category
-  = category/all
+  = /category/all
 
 categoryName(id-path:CategoryId) -> plain
-  = category/{id}
+  = /category/{id}
 
 
 
 ## GeekApk Users section
 
 readUser(id-path:UserId) -> object:GeekUser
-  = user/{id}
+  = /user/{id}
 
 
 ### Requires user permission
 PUT@updateUser(id-path:UserId, prop:String{username, nickname, avatar, bio, metaApp}, value-body:String)
   -> [$user:number, $prop:string, $old:string, $new:string]
-  = user/{id}
+  = /user/{id}
 
 PUT@resetHash(id-path:UserId, shash:String, hash:String)
   -> [$id:number, $newShash:string, $newHash:string]
-  = user/{id}/hash
+  = /user/{id}/hash
 
 checkHash(id-path:UserId, hash:String)
   -> [$valid:boolean, $message:string]
-  = user/{id}/checkHash
+  = /user/{id}/checkHash
 
 listUser(sort:String?{created, followers}, sliceFrom:UserSize?, sliceTo:UserSize?) -> array:GeekUser
-  = user/all
+  = /user/all
 
 listMetaUser(sort:String?{created, followers}, sliceFrom:UserSize?, sliceTo:UserSize?) -> array:GeekUser
-  = user/allHasMetaApp
+  = /user/allHasMetaApp
 
 searchUser(type:String?{username, nickname, bio}, kw-path:String, sort:String?{created, followers}) -> array:GeekUser
-  = user/search/{kw}
+  = /user/search/{kw}
 
 PUT@updateOnlineTime(id-path:UserId)
-  = user/{id}/online
+  = /user/{id}/online
 
 ## GeekApk Timeline section
 
@@ -254,3 +254,13 @@ stargazers(aid-path:AppId) -> array:App
 
 stars(uid-path:UserId) -> array:App
   = /star/user/{uid}
+
+## PATCH APIs
+PATCH@patchUser(uid-path:UserId, obj-body:GeekUser) -> object:GeekUser
+  = /user/{uid}
+
+PATCH@patchApp(aid-path:AppId, obj-body:App) -> object:App
+  = /app/{aid}
+
+PATCH@patchReversion(aid-path:AppId, rev-path:Int, obj-body:AppUpdate) -> object:AppUpdate
+  = /appUpdate/{aid}/{rev}

geekapk_v1b_api.geekspec

@@ -271,6 +271,7 @@ def initialize(interfaces)
       @conn = Faraday.new(url: 'http://127.0.0.1:8080')
       @apis = if interfaces.is_a? Array then interfaces else [interfaces] end
       @auth = GeekAuth.new(-1, '')
+      @conn.headers['Content-Type'] = 'application/json;charset=UTF-8'
     end
 
     def instance_api_methods

spectrum.rb

@@ -293,7 +293,7 @@
       "of": "Category"
     },
     "method": "GET",
-    "url": "category/all"
+    "url": "/category/all"
   },
   {
     "name": "categoryName",
@@ -306,7 +306,7 @@
     ],
     "return": "plain",
     "method": "GET",
-    "url": "category/{id}"
+    "url": "/category/{id}"
   },
   {
     "name": "readUser",
@@ -322,7 +322,7 @@
       "of": "GeekUser"
     },
     "method": "GET",
-    "url": "user/{id}"
+    "url": "/user/{id}"
   },
   {
     "name": "updateUser",
@@ -368,7 +368,7 @@
       }
     ],
     "method": "PUT",
-    "url": "user/{id}"
+    "url": "/user/{id}"
   },
   {
     "name": "resetHash",
@@ -404,7 +404,7 @@
       }
     ],
     "method": "PUT",
-    "url": "user/{id}/hash"
+    "url": "/user/{id}/hash"
   },
   {
     "name": "checkHash",
@@ -431,7 +431,7 @@
       }
     ],
     "method": "GET",
-    "url": "user/{id}/checkHash"
+    "url": "/user/{id}/checkHash"
   },
   {
     "name": "listUser",
@@ -460,7 +460,7 @@
       "of": "GeekUser"
     },
     "method": "GET",
-    "url": "user/all"
+    "url": "/user/all"
   },
   {
     "name": "listMetaUser",
@@ -489,7 +489,7 @@
       "of": "GeekUser"
     },
     "method": "GET",
-    "url": "user/allHasMetaApp"
+    "url": "/user/allHasMetaApp"
   },
   {
     "name": "searchUser",
@@ -522,7 +522,7 @@
       "of": "GeekUser"
     },
     "method": "GET",
-    "url": "user/search/{kw}"
+    "url": "/user/search/{kw}"
   },
   {
     "name": "updateOnlineTime",
@@ -535,7 +535,7 @@
     ],
     "return": null,
     "method": "PUT",
-    "url": "user/{id}/online"
+    "url": "/user/{id}/online"
   },
   {
     "name": "readUserTimeline",
@@ -1425,5 +1425,73 @@
     },
     "method": "GET",
     "url": "/star/user/{uid}"
+  },
+  {
+    "name": "patchUser",
+    "args": [
+      {
+        "name": "uid-path:UserId",
+        "required": true,
+        "options": null
+      },
+      {
+        "name": "obj-body:GeekUser",
+        "required": true,
+        "options": null
+      }
+    ],
+    "return": {
+      "type": "object",
+      "of": "GeekUser"
+    },
+    "method": "PATCH",
+    "url": "/user/{uid}"
+  },
+  {
+    "name": "patchApp",
+    "args": [
+      {
+        "name": "aid-path:AppId",
+        "required": true,
+        "options": null
+      },
+      {
+        "name": "obj-body:App",
+        "required": true,
+        "options": null
+      }
+    ],
+    "return": {
+      "type": "object",
+      "of": "App"
+    },
+    "method": "PATCH",
+    "url": "/app/{aid}"
+  },
+  {
+    "name": "patchReversion",
+    "args": [
+      {
+        "name": "aid-path:AppId",
+        "required": true,
+        "options": null
+      },
+      {
+        "name": "rev-path:Int",
+        "required": true,
+        "options": null
+      },
+      {
+        "name": "obj-body:AppUpdate",
+        "required": true,
+        "options": null
+      }
+    ],
+    "return": {
+      "type": "object",
+      "of": "AppUpdate"
+    },
+    "method": "PATCH",
+    "url": "/appUpdate/{aid}/{rev}"
   }
 ]

spectrum_geekapk_v1b_api.json

@@ -31,6 +31,12 @@ class AppController {
     TODO()
   }
 
+  @PatchMapping("/{aid}")
+  @ResponseBody
+  fun patchApp(@PathVariable("aid") aid: AppId, @RequestBody obj: App): App {
+    TODO()
+  }
+
 
   @PostMapping("/")
   @ResponseBody

src/main/kotlin/org/duangsuse/geekapk/controller/AppController.kt

@@ -49,6 +49,12 @@ class AppReversionController {
     TODO()
   }
 
+  @PatchMapping("/{aid}/{rev}")
+  @ResponseBody
+  fun patchReversion(@PathVariable("aid") aid: AppId, @PathVariable("rev") rev: Int, @RequestBody obj: AppUpdate): AppUpdate {
+    TODO()
+  }
+
 
   @DeleteMapping("/{aid}/{rev}")
   @ResponseBody

src/main/kotlin/org/duangsuse/geekapk/controller/AppReversionController.kt

@@ -29,6 +29,12 @@ class UserController {
     TODO()
   }
 
+  @PatchMapping("/{uid}")
+  @ResponseBody
+  fun patchUser(@PathVariable("uid") uid: UserId, @RequestBody obj: GeekUser): GeekUser {
+    TODO()
+  }
+
   @PutMapping("/{id}/hash")
   @ResponseBody fun resetHash(@PathVariable("id") id: UserId, @RequestParam("shash") shash: String, @RequestParam("hash") hash: String): Map<String, String> {
     TODO()

src/main/kotlin/org/duangsuse/geekapk/controller/UserController.kt

@@ -13,6 +13,7 @@ import java.io.Serializable
 import java.util.*
 import javax.persistence.*
 import javax.validation.constraints.Size
+import javax.xml.bind.annotation.XmlTransient
 import kotlin.math.roundToInt
 
 /**
@@ -79,13 +80,15 @@ data class GeekUser (
    */
   @UserPrivate
   @JsonIgnore
+  @XmlTransient
   var sharedHash: String = makeSharedHash(20), /* static server-computed size */
 
   /**
    * Password for the user
    */
   @UserPrivate /* should be set to another value in controller level */
   @JsonIgnore
+  @XmlTransient
   @Size(min = 256 / 4, max = 256 / 4) /* SHA-256 hex representation hash */
   var hash: String = "68e656b251e67e8358bef8483ab0d51c6619f3e7a1a9f0e75838d41ff368f728",