forked from loafle/openapi-generator-original

Adds not to CodegenComposedSchemas and uses it in python-exp (#12146 )

Updates docs

2022-04-17 09:36:09 -07:00

28 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.api import user_api
from petstore_api.model.user import User
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    body = User(
        id=1,
        username="username_example",
        first_name="first_name_example",
        last_name="last_name_example",
        email="email_example",
        password="password_example",
        phone="phone_example",
        user_status=1,
        object_with_no_declared_props=dict(),
        object_with_no_declared_props_nullable=dict(),
        any_type_prop=None,
        any_type_except_null_prop=None,
        any_type_prop_nullable=None,
    )
    try:
        # Create user
        api_response = api_instance.create_user(
            body=body,
        )
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->create_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	typing.Union[SchemaForRequestBodyApplicationJson]	required
content_type	str	optional, default is 'application/json'	Selects the schema and serialization of the request body
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

body

SchemaForRequestBodyApplicationJson

Type	Description	Notes
User

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
default	ApiResponseForDefault	successful operation

ApiResponseForDefault

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

void (empty response body)

Authorization

No authorization required

[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.api import user_api
from petstore_api.model.user import User
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    body = [
        User(
            id=1,
            username="username_example",
            first_name="first_name_example",
            last_name="last_name_example",
            email="email_example",
            password="password_example",
            phone="phone_example",
            user_status=1,
            object_with_no_declared_props=dict(),
            object_with_no_declared_props_nullable=dict(),
            any_type_prop=None,
            any_type_except_null_prop=None,
            any_type_prop_nullable=None,
        )
    ]
    try:
        # Creates list of users with given input array
        api_response = api_instance.create_users_with_array_input(
            body=body,
        )
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->create_users_with_array_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	typing.Union[SchemaForRequestBodyApplicationJson]	required
content_type	str	optional, default is 'application/json'	Selects the schema and serialization of the request body
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

body

SchemaForRequestBodyApplicationJson

Type	Description	Notes
[User]

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
default	ApiResponseForDefault	successful operation

ApiResponseForDefault

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

void (empty response body)

Authorization

No authorization required

[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.api import user_api
from petstore_api.model.user import User
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    body = [
        User(
            id=1,
            username="username_example",
            first_name="first_name_example",
            last_name="last_name_example",
            email="email_example",
            password="password_example",
            phone="phone_example",
            user_status=1,
            object_with_no_declared_props=dict(),
            object_with_no_declared_props_nullable=dict(),
            any_type_prop=None,
            any_type_except_null_prop=None,
            any_type_prop_nullable=None,
        )
    ]
    try:
        # Creates list of users with given input array
        api_response = api_instance.create_users_with_list_input(
            body=body,
        )
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->create_users_with_list_input: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	typing.Union[SchemaForRequestBodyApplicationJson]	required
content_type	str	optional, default is 'application/json'	Selects the schema and serialization of the request body
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

body

SchemaForRequestBodyApplicationJson

Type	Description	Notes
[User]

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
default	ApiResponseForDefault	successful operation

ApiResponseForDefault

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

void (empty response body)

Authorization

No authorization required

[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.api import user_api
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    path_params = {
        'username': "username_example",
    }
    try:
        # Delete user
        api_response = api_instance.delete_user(
            path_params=path_params,
        )
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->delete_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
path_params	RequestPathParams
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

path_params

RequestPathParams

Name	Type	Description	Notes
username	UsernameSchema

UsernameSchema

Type	Description	Notes
str

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
400	ApiResponseFor400	Invalid username supplied
404	ApiResponseFor404	User not found

ApiResponseFor400

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

ApiResponseFor404

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

void (empty response body)

Authorization

No authorization required

[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.api import user_api
from petstore_api.model.user import User
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    path_params = {
        'username': "username_example",
    }
    try:
        # Get user by user name
        api_response = api_instance.get_user_by_name(
            path_params=path_params,
        )
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->get_user_by_name: %s\n" % e)

Parameters

Name	Type	Description	Notes
path_params	RequestPathParams
accept_content_types	typing.Tuple[str]	default is ('application/xml', 'application/json', )	Tells the server the content type(s) that are accepted by the client
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

path_params

RequestPathParams

Name	Type	Description	Notes
username	UsernameSchema

UsernameSchema

Type	Description	Notes
str

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
200	ApiResponseFor200	successful operation
400	ApiResponseFor400	Invalid username supplied
404	ApiResponseFor404	User not found

ApiResponseFor200

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	typing.Union[SchemaFor200ResponseBodyApplicationXml, SchemaFor200ResponseBodyApplicationJson, ]
headers	Unset	headers were not defined

SchemaFor200ResponseBodyApplicationXml

Type	Description	Notes
User

SchemaFor200ResponseBodyApplicationJson

Type	Description	Notes
User

ApiResponseFor400

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

ApiResponseFor404

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

User

Authorization

No authorization required

[Back to top] [Back to API list] [Back to Model list] [Back to README]

login_user

str login_user(usernamepassword)

Logs user into the system

Example

import petstore_api
from petstore_api.api import user_api
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    query_params = {
        'username': "username_example",
        'password': "password_example",
    }
    try:
        # Logs user into the system
        api_response = api_instance.login_user(
            query_params=query_params,
        )
        pprint(api_response)
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->login_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
query_params	RequestQueryParams
accept_content_types	typing.Tuple[str]	default is ('application/xml', 'application/json', )	Tells the server the content type(s) that are accepted by the client
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

query_params

RequestQueryParams

Name	Type	Description	Notes
username	UsernameSchema
password	PasswordSchema

UsernameSchema

Type	Description	Notes
str

PasswordSchema

Type	Description	Notes
str

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
200	ApiResponseFor200	successful operation
400	ApiResponseFor400	Invalid username/password supplied

ApiResponseFor200

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	typing.Union[SchemaFor200ResponseBodyApplicationXml, SchemaFor200ResponseBodyApplicationJson, ]
headers	ResponseHeadersFor200

SchemaFor200ResponseBodyApplicationXml

Type	Description	Notes
str

SchemaFor200ResponseBodyApplicationJson

Type	Description	Notes
str

ResponseHeadersFor200

Name	Type	Description	Notes
X-Rate-Limit	XRateLimitSchema		optional
X-Expires-After	XExpiresAfterSchema		optional

XRateLimitSchema

calls per hour allowed by the user

Type	Description	Notes
int	calls per hour allowed by the user

XExpiresAfterSchema

date in UTC when token expires

Type	Description	Notes
datetime	date in UTC when token expires

ApiResponseFor400

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

str

Authorization

No authorization required

[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.api import user_api
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Logs out current logged in user session
        api_response = api_instance.logout_user()
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->logout_user: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
default	ApiResponseForDefault	successful operation

ApiResponseForDefault

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

void (empty response body)

Authorization

No authorization required

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_user

update_user(usernameuser)

Updated user

This can only be done by the logged in user.

Example

import petstore_api
from petstore_api.api import user_api
from petstore_api.model.user import User
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
with petstore_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_api.UserApi(api_client)

    # example passing only required values which don't have defaults set
    path_params = {
        'username': "username_example",
    }
    body = User(
        id=1,
        username="username_example",
        first_name="first_name_example",
        last_name="last_name_example",
        email="email_example",
        password="password_example",
        phone="phone_example",
        user_status=1,
        object_with_no_declared_props=dict(),
        object_with_no_declared_props_nullable=dict(),
        any_type_prop=None,
        any_type_except_null_prop=None,
        any_type_prop_nullable=None,
    )
    try:
        # Updated user
        api_response = api_instance.update_user(
            path_params=path_params,
            body=body,
        )
    except petstore_api.ApiException as e:
        print("Exception when calling UserApi->update_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	typing.Union[SchemaForRequestBodyApplicationJson]	required
path_params	RequestPathParams
content_type	str	optional, default is 'application/json'	Selects the schema and serialization of the request body
stream	bool	default is False	if True then the response.content will be streamed and loaded from a file like object. When downloading a file, set this to True to force the code to deserialize the content to a FileSchema file
timeout	typing.Optional[typing.Union[int, typing.Tuple]]	default is None	the timeout used by the rest client
skip_deserialization	bool	default is False	when True, headers and body will be unset and an instance of api_client.ApiResponseWithoutDeserialization will be returned

body

SchemaForRequestBodyApplicationJson

Type	Description	Notes
User

path_params

RequestPathParams

Name	Type	Description	Notes
username	UsernameSchema

UsernameSchema

Type	Description	Notes
str

Return Types, Responses

Code	Class	Description
n/a	api_client.ApiResponseWithoutDeserialization	When skip_deserialization is True this response is returned
400	ApiResponseFor400	Invalid user supplied
404	ApiResponseFor404	User not found

ApiResponseFor400

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

ApiResponseFor404

Name	Type	Description
response	urllib3.HTTPResponse	Raw response
body	Unset	body was not defined
headers	Unset	headers were not defined

void (empty response body)

Authorization

No authorization required

[Back to top] [Back to API list] [Back to Model list] [Back to README]

28 KiB Raw Blame History

petstore_api.UserApi

create_user

Example

Parameters

body

SchemaForRequestBodyApplicationJson

Return Types, Responses

ApiResponseForDefault

Authorization

create_users_with_array_input

Example

Parameters

body

SchemaForRequestBodyApplicationJson

Return Types, Responses

ApiResponseForDefault

Authorization

create_users_with_list_input

Example

Parameters

body

SchemaForRequestBodyApplicationJson

Return Types, Responses

ApiResponseForDefault

Authorization

delete_user

Example

Parameters

path_params

RequestPathParams

UsernameSchema

Return Types, Responses

ApiResponseFor400

ApiResponseFor404

Authorization

get_user_by_name

Example

Parameters

path_params

RequestPathParams

UsernameSchema

Return Types, Responses

ApiResponseFor200

SchemaFor200ResponseBodyApplicationXml

SchemaFor200ResponseBodyApplicationJson

ApiResponseFor400

ApiResponseFor404

Authorization

login_user

Example

Parameters

query_params

RequestQueryParams

UsernameSchema

PasswordSchema

Return Types, Responses

ApiResponseFor200

SchemaFor200ResponseBodyApplicationXml

SchemaFor200ResponseBodyApplicationJson

ResponseHeadersFor200

XRateLimitSchema

XExpiresAfterSchema

ApiResponseFor400

Authorization

logout_user

Example

Parameters

Return Types, Responses

ApiResponseForDefault

Authorization

update_user

Example

Parameters

body

SchemaForRequestBodyApplicationJson

path_params

RequestPathParams

UsernameSchema

Return Types, Responses

28 KiB

Raw Blame History