forked from loafle/openapi-generator-original

Jonathan Ballet 063865973d

python: simplify module imports (#17507 )

In #16624, I introduced a new mechanism to record imports to other
modules, instead of having specialized datetime/typing/pydantic objects
to manage imports for these modules.

This change reuses the mechanism from #16624 and replace the specialized
import managers by the generic one. Unused imports from various
.mustache templates are also cleaned up.

2024-01-03 21:22:53 +08:00

15 KiB

Raw Blame History

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(user)

Create user

This can only be done by the logged in user.

Example

import petstore_api
from petstore_api.models.user import User
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    user = petstore_api.User() # User | Created user object

    try:
        # Create user
        await api_instance.create_user(user)
    except Exception as e:
        print("Exception when calling UserApi->create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	User	Created user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
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(user)

Creates list of users with given input array

Example

import petstore_api
from petstore_api.models.user import User
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    user = [petstore_api.User()] # List[User] | List of user object

    try:
        # Creates list of users with given input array
        await api_instance.create_users_with_array_input(user)
    except Exception as e:
        print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	List[User]	List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
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(user)

Creates list of users with given input array

Example

import petstore_api
from petstore_api.models.user import User
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    user = [petstore_api.User()] # List[User] | List of user object

    try:
        # Creates list of users with given input array
        await api_instance.create_users_with_list_input(user)
    except Exception as e:
        print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
user	List[User]	List of user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
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

import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    username = 'username_example' # str | The name that needs to be deleted

    try:
        # Delete user
        await api_instance.delete_user(username)
    except Exception 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

import petstore_api
from petstore_api.models.user import User
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    username = 'username_example' # str | The name that needs to be fetched. Use user1 for testing.

    try:
        # Get user by user name
        api_response = await api_instance.get_user_by_name(username)
        print("The response of UserApi->get_user_by_name:\n")
        pprint(api_response)
    except Exception 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

User

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

import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    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 = await api_instance.login_user(username, password)
        print("The response of UserApi->login_user:\n")
        pprint(api_response)
    except Exception 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

import petstore_api
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)

    try:
        # Logs out current logged in user session
        await api_instance.logout_user()
    except Exception 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, user)

Updated user

This can only be done by the logged in user.

Example

import petstore_api
from petstore_api.models.user import User
from petstore_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://petstore.swagger.io:80/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = petstore_api.Configuration(
    host = "http://petstore.swagger.io:80/v2"
)


# Enter a context with an instance of the API client
async with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = petstore_api.UserApi(api_client)
    username = 'username_example' # str | name that need to be deleted
    user = petstore_api.User() # User | Updated user object

    try:
        # Updated user
        await api_instance.update_user(username, user)
    except Exception 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
user	User	Updated user object

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
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]

15 KiB Raw Blame History

petstore_api.UserApi

create_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_users_with_array_input

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_users_with_list_input

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_user_by_name

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

login_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

logout_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

update_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

15 KiB

Raw Blame History