mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-13 13:10:53 +00:00
53eff43184
* Replace typeMapping kotlin.Array with kotlin.collections.List, because its doesn't work with Kotlin Data Classes(required manually implementing hashCode&equals) Replace typeMapping kotlin.Array<kotlin.Byte> with efficient primitive implementation kotlin.ByteArray Replace instantiationTypes array to kotlin.collections.ArrayList, for extending Array we should provide element count to its constructor. * Fixed path(removed slash on begin path) for Jvm Kotlin Retrofit * Fixed handling optional bodyParams for Jvm Kotlin Retrofit * Fix kotlin tests * Fixed code format for detekt inspections #2 * revert formatting * Added ability to generate optional @Query params. * Update Kotlin docs. * Update Kotlin openapi3 client samples * Update Kotlin client samples * Update Kotlin openapi3 client samples after merge with master * Revert hardcoding List instead Array * Set List as default collectionType * Update Kotlin samples * Fixed Kotlin multiplatform api template. fix mapper for Array type. Fixed Kotlin multiplatform api template Code style. * Update Kotlin multiplatform sample * Fix Kotlin multiplatform template code style * Update Kotlin multiplatform sample * Fix Kotlin multiplatform converting Array to List in Api. * Update Kotlin multiplatform sample #3 * Fix Kotlin tests * Fix Kotlin jackson Application.kt * Fix Kotlin tests #2 * Fix merge conflict with master * Generate samples after merge with master * Generate samples after merge with master #2 * Generate samples after merge with master #3 * Generate samples after merge with master #4 * update kotlin samples * update all samples Co-authored-by: William Cheng <wing328hk@gmail.com>
7.4 KiB
7.4 KiB
UserApi
All URIs are relative to http://petstore.swagger.io/v2
| 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 |
Create user
This can only be done by the logged in user.
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val body : User = // User | Created user object
webService.createUser(body)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | User | Created user object |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Creates list of users with given input array
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val body : kotlin.collections.List<User> = // kotlin.collections.List<User> | List of user object
webService.createUsersWithArrayInput(body)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | kotlin.collections.List<User> | List of user object |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Creates list of users with given input array
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val body : kotlin.collections.List<User> = // kotlin.collections.List<User> | List of user object
webService.createUsersWithListInput(body)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | kotlin.collections.List<User> | List of user object |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Delete user
This can only be done by the logged in user.
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val username : kotlin.String = username_example // kotlin.String | The name that needs to be deleted
webService.deleteUser(username)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | kotlin.String | The name that needs to be deleted |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Get user by user name
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val username : kotlin.String = username_example // kotlin.String | The name that needs to be fetched. Use user1 for testing.
val result : User = webService.getUserByName(username)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | kotlin.String | The name that needs to be fetched. Use user1 for testing. |
Return type
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
Logs user into the system
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val username : kotlin.String = username_example // kotlin.String | The user name for login
val password : kotlin.String = password_example // kotlin.String | The password for login in clear text
val result : kotlin.String = webService.loginUser(username, password)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | kotlin.String | The user name for login | |
| password | kotlin.String | The password for login in clear text |
Return type
kotlin.String
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
Logs out current logged in user session
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
webService.logoutUser()
Parameters
This endpoint does not need any parameter.
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
Updated user
This can only be done by the logged in user.
Example
// Import classes:
//import org.openapitools.client.*
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*
val apiClient = ApiClient()
val webService = apiClient.createWebservice(UserApi::class.java)
val username : kotlin.String = username_example // kotlin.String | name that need to be deleted
val body : User = // User | Updated user object
webService.updateUser(username, body)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | kotlin.String | name that need to be deleted | |
| body | User | Updated user object |
Return type
null (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined