forked from loafle/openapi-generator-original
73c55c11dd
* Changes python-experimental types to classes, adds additionalalproperties handling Adds model_utils update, updates model.mustache Updates api.mustache and uses model_to_dict in model_normal.mustache Updates requirements.mustache for PythonClientExperimental Passes through check_type when deserializing models Converts types from strings to classes in PythonClientExperimentalCodegen.java and PythonTest.java Creates PythonClientExperimentalTest.java Updates toInstantiationType to use ModelUtils.xxx Corrects docstring descriptions of response_type Updates python-experimental typing, partially fixes deserialization tests Adds fixes for some of the deserialization tests Fixes deserialization tests Switches model teplates to use allVars so allof props will be included Fixes tests.test_enum_arrays Fixes test_to_str Adds additional_properties_type, fixes teast_todict in test_map_test.py Correctly check the type of _request_timeout values Fixes test_upload_file test Turns off coercion when instantiating model types with client data Updates file handling to input and output an open file object Fixes linting errors Adds fixes for python2 tests, linting fixes Adds additionalproperties to docs + tests Regenerates python-experimatal client * Regenerates python-experimental client * Updates windows python-experimental bat file * Fixes addModelImport so client generation will work with the v2 spec * Reverts PythonClientCodegen.java * Acutally revert PythonClientCodegen.java * Updates the sample example for file_type in docs * Silences line too long error for python models so CI tests pass * Fixes handling of file uploads, adds tests for uploading files * Removes comment * Fixes mock installation in python2 * Limit mock addition to python-experimental test requirements only * Removes SmartBear copyright line
12 KiB
12 KiB
petstore_api.UserApi
All URIs are relative to http://petstore.swagger.io:80/v2
| Method | HTTP request | Description |
|---|---|---|
| create_user | POST /user | Create user |
| create_users_with_array_input | POST /user/createWithArray | Creates list of users with given input array |
| create_users_with_list_input | POST /user/createWithList | Creates list of users with given input array |
| delete_user | DELETE /user/{username} | Delete user |
| get_user_by_name | GET /user/{username} | Get user by user name |
| login_user | GET /user/login | Logs user into the system |
| logout_user | GET /user/logout | Logs out current logged in user session |
| update_user | PUT /user/{username} | Updated user |
create_user
create_user(body)
Create user
This can only be done by the logged in user.
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
body = petstore_api.User() # User | Created user object
try:
# Create user
api_instance.create_user(body)
except ApiException as e:
print("Exception when calling UserApi->create_user: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | User | Created user object |
Return type
void (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 0 | successful operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_users_with_array_input
create_users_with_array_input(body)
Creates list of users with given input array
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
body = [petstore_api.User()] # [User] | List of user object
try:
# Creates list of users with given input array
api_instance.create_users_with_array_input(body)
except ApiException as e:
print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | [User] | List of user object |
Return type
void (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 0 | successful operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
create_users_with_list_input
create_users_with_list_input(body)
Creates list of users with given input array
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
body = [petstore_api.User()] # [User] | List of user object
try:
# Creates list of users with given input array
api_instance.create_users_with_list_input(body)
except ApiException as e:
print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| body | [User] | List of user object |
Return type
void (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 0 | successful operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
delete_user
delete_user(username)
Delete user
This can only be done by the logged in user.
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
username = 'username_example' # str | The name that needs to be deleted
try:
# Delete user
api_instance.delete_user(username)
except ApiException as e:
print("Exception when calling UserApi->delete_user: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | str | The name that needs to be deleted |
Return type
void (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 400 | Invalid username supplied | - |
| 404 | User not found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
get_user_by_name
User get_user_by_name(username)
Get user by user name
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
username = 'username_example' # str | The name that needs to be fetched. Use user1 for testing.
try:
# Get user by user name
api_response = api_instance.get_user_by_name(username)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->get_user_by_name: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | str | 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
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | - |
| 400 | Invalid username supplied | - |
| 404 | User not found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
login_user
str login_user(username, password)
Logs user into the system
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
username = 'username_example' # str | The user name for login
password = 'password_example' # str | The password for login in clear text
try:
# Logs user into the system
api_response = api_instance.login_user(username, password)
pprint(api_response)
except ApiException as e:
print("Exception when calling UserApi->login_user: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | str | The user name for login | |
| password | str | The password for login in clear text |
Return type
str
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: application/xml, application/json
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | successful operation | * X-Rate-Limit - calls per hour allowed by the user * X-Expires-After - date in UTC when token expires |
| 400 | Invalid username/password supplied | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
logout_user
logout_user()
Logs out current logged in user session
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
try:
# Logs out current logged in user session
api_instance.logout_user()
except ApiException as e:
print("Exception when calling UserApi->logout_user: %s\n" % e)
Parameters
This endpoint does not need any parameter.
Return type
void (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 0 | successful operation | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
update_user
update_user(username, body)
Updated user
This can only be done by the logged in user.
Example
from __future__ import print_function
import time
import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint
# Create an instance of the API class
api_instance = petstore_api.UserApi()
username = 'username_example' # str | name that need to be deleted
body = petstore_api.User() # User | Updated user object
try:
# Updated user
api_instance.update_user(username, body)
except ApiException as e:
print("Exception when calling UserApi->update_user: %s\n" % e)
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| username | str | name that need to be deleted | |
| body | User | Updated user object |
Return type
void (empty response body)
Authorization
No authorization required
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 400 | Invalid user supplied | - |
| 404 | User not found | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]