openapi-generator/samples/server/petstore/java-micronaut-server/docs/controllers/UserController.md

UserController

All URIs are relative to "/v2"

The controller class is defined in UserController.java

Method	HTTP request	Description
createUser	POST /user	Create user
createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
deleteUser	DELETE /user/{username}	Delete user
getUserByName	GET /user/{username}	Get user by user name
loginUser	GET /user/login	Logs user into the system
logoutUser	GET /user/logout	Logs out current logged in user session
updateUser	PUT /user/{username}	Updated user

createUser

Mono<Object> UserController.createUser(user)

Create user

This can only be done by the logged in user.

Parameters

Name	Type	Description	Notes
user	User	Created user object

Authorization

• api_key

HTTP request headers

• Accepts Content-Type: application/json
• Produces Content-Type: Not defined

createUsersWithArrayInput

Mono<Object> UserController.createUsersWithArrayInput(user)

Creates list of users with given input array

Parameters

Name	Type	Description	Notes
user	List<User>	List of user object

Authorization

• api_key

HTTP request headers

• Accepts Content-Type: application/json
• Produces Content-Type: Not defined

createUsersWithListInput

Mono<Object> UserController.createUsersWithListInput(user)

Creates list of users with given input array

Parameters

Name	Type	Description	Notes
user	List<User>	List of user object

Authorization

• api_key

HTTP request headers

• Accepts Content-Type: application/json
• Produces Content-Type: Not defined

deleteUser

Mono<Object> UserController.deleteUser(username)

Delete user

This can only be done by the logged in user.

Parameters

Name	Type	Description	Notes
username	String	The name that needs to be deleted

Authorization

• api_key

HTTP request headers

• Accepts Content-Type: Not defined
• Produces Content-Type: Not defined

getUserByName

Mono<User> UserController.getUserByName(username)

Get user by user name

Parameters

Name	Type	Description	Notes
username	String	The name that needs to be fetched. Use user1 for testing.

Return type

User

HTTP request headers

• Accepts Content-Type: Not defined
• Produces Content-Type: application/xml, application/json

loginUser

Mono<String> UserController.loginUser(usernamepassword)

Logs user into the system

Parameters

Name	Type	Description	Notes
username	String	The user name for login
password	String	The password for login in clear text

Return type

String

HTTP request headers

• Accepts Content-Type: Not defined
• Produces Content-Type: application/xml, application/json

logoutUser

Mono<Object> UserController.logoutUser()

Logs out current logged in user session

Authorization

• api_key

HTTP request headers

• Accepts Content-Type: Not defined
• Produces Content-Type: Not defined

updateUser

Mono<Object> UserController.updateUser(usernameuser)

Updated user

This can only be done by the logged in user.

Parameters

Name	Type	Description	Notes
username	String	name that need to be deleted
user	User	Updated user object

Authorization

• api_key

HTTP request headers

• Accepts Content-Type: application/json
• Produces Content-Type: Not defined