Package cn.sliew.carp.module.application.vela.api.v1

Interface UsersApi

public interface UsersApi

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<V1UserBase>	createUser(V1CreateUserRequest body)
org.springframework.http.ResponseEntity<V1EmptyResponse>	deleteUser(String username)
org.springframework.http.ResponseEntity<V1DetailUserResponse>	detailUser(String username)
org.springframework.http.ResponseEntity<V1EmptyResponse>	disableUser(String username)
org.springframework.http.ResponseEntity<V1EmptyResponse>	enableUser(String username)
org.springframework.http.ResponseEntity<V1ListUserResponse>	listUser(Integer page, Integer pageSize, String name, String email, String alias)
org.springframework.http.ResponseEntity<V1UserBase>	updateUser(String username, V1UpdateUserRequest body)

Method Details

listUser

@GetMapping("/api/v1/users")
org.springframework.http.ResponseEntity<V1ListUserResponse> listUser(@RequestParam("page")
 Integer page,
 @RequestParam("pageSize")
 Integer pageSize,
 @RequestParam("name")
 String name,
 @RequestParam("email")
 String email,
 @RequestParam("alias")
 String alias)

detailUser

@GetMapping("/api/v1/users/{username}")
org.springframework.http.ResponseEntity<V1DetailUserResponse> detailUser(@PathVariable("username")
 String username)

createUser

@PostMapping("/api/v1/users")
org.springframework.http.ResponseEntity<V1UserBase> createUser(@RequestBody
 V1CreateUserRequest body)

updateUser

@PutMapping("/api/v1/users/{username}")
org.springframework.http.ResponseEntity<V1UserBase> updateUser(@PathVariable("username")
 String username,
 @RequestBody
 V1UpdateUserRequest body)

deleteUser

@DeleteMapping("/api/v1/users/{username}")
org.springframework.http.ResponseEntity<V1EmptyResponse> deleteUser(@PathVariable("username")
 String username)

disableUser

@GetMapping("/api/v1/users/{username}/disable")
org.springframework.http.ResponseEntity<V1EmptyResponse> disableUser(@PathVariable("username")
 String username)

enableUser

@GetMapping("/api/v1/users/{username}/enable")
org.springframework.http.ResponseEntity<V1EmptyResponse> enableUser(@PathVariable("username")
 String username)