Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
134 lines (115 loc) · 9.4 KB

user.md

File metadata and controls

134 lines (115 loc) · 9.4 KB

User

petstore_api.components.schema.user

type: schemas.Schema

validate method

Input Type Return Type Notes
UserDictInput, UserDict UserDict

UserDictInput

type: typing.Mapping[str, schemas.INPUT_TYPES_ALL]
Key Type Description Notes
id int [optional] value must be a 64 bit integer
username str [optional]
firstName str [optional]
lastName str [optional]
email str [optional]
password str [optional]
phone str [optional]
userStatus int User Status [optional] value must be a 32 bit integer
objectWithNoDeclaredProps dict, schemas.immutabledict test code generation for objects Value must be a map of strings to values. It cannot be the 'null' value. [optional]
objectWithNoDeclaredPropsNullable None, dict, schemas.immutabledict test code generation for nullable objects. Value must be a map of strings to values or the 'null' value. [optional]
anyTypeProp dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader test code generation for any type Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See OAI/OpenAPI-Specification#1389 [optional]
anyTypeExceptNullProp dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader any type except 'null' Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. [optional]
anyTypePropNullable dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader test code generation for any type Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The 'nullable' attribute does not change the allowed values. [optional]
any_string_name dict, schemas.immutabledict, list, tuple, decimal.Decimal, float, int, str, datetime.date, datetime.datetime, uuid.UUID, bool, None, bytes, io.FileIO, io.BufferedReader, schemas.FileIO any string name can be used but the value must be the correct type [optional]

UserDict

base class: schemas.immutabledict[str, schemas.OUTPUT_BASE_TYPES]

__new__ method

Keyword Argument Type Description Notes
id int, schemas.Unset [optional] value must be a 64 bit integer
username str, schemas.Unset [optional]
firstName str, schemas.Unset [optional]
lastName str, schemas.Unset [optional]
email str, schemas.Unset [optional]
password str, schemas.Unset [optional]
phone str, schemas.Unset [optional]
userStatus int, schemas.Unset User Status [optional] value must be a 32 bit integer
objectWithNoDeclaredProps dict, schemas.immutabledict, schemas.Unset test code generation for objects Value must be a map of strings to values. It cannot be the 'null' value. [optional]
objectWithNoDeclaredPropsNullable None, dict, schemas.immutabledict, schemas.Unset test code generation for nullable objects. Value must be a map of strings to values or the 'null' value. [optional]
anyTypeProp dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset test code generation for any type Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See OAI/OpenAPI-Specification#1389 [optional]
anyTypeExceptNullProp dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset any type except 'null' Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. [optional]
anyTypePropNullable dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader, schemas.Unset test code generation for any type Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The 'nullable' attribute does not change the allowed values. [optional]
kwargs schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO any string name can be used but the value must be the correct type [optional] typed value is accessed with the get_additional_property_ method

properties

Property Type Description Notes
id int, schemas.Unset [optional] value must be a 64 bit integer
username str, schemas.Unset [optional]
firstName str, schemas.Unset [optional]
lastName str, schemas.Unset [optional]
email str, schemas.Unset [optional]
password str, schemas.Unset [optional]
phone str, schemas.Unset [optional]
userStatus int, schemas.Unset User Status [optional] value must be a 32 bit integer
objectWithNoDeclaredProps schemas.immutabledict, schemas.Unset test code generation for objects Value must be a map of strings to values. It cannot be the 'null' value. [optional]
objectWithNoDeclaredPropsNullable None, schemas.immutabledict, schemas.Unset test code generation for nullable objects. Value must be a map of strings to values or the 'null' value. [optional]
anyTypeProp schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset test code generation for any type Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See OAI/OpenAPI-Specification#1389 [optional]
anyTypeExceptNullProp schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset any type except 'null' Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. [optional]
anyTypePropNullable schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO, schemas.Unset test code generation for any type Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The 'nullable' attribute does not change the allowed values. [optional]

methods

Method Input Type Return Type Notes
from_dict_ UserDictInput, UserDict UserDict a constructor
get_additional_property_ str schemas.immutabledict, tuple, float, int, str, bool, None, bytes, schemas.FileIO, schemas.Unset provides type safety for additional properties

ObjectWithNoDeclaredProps

type: schemas.Schema

Description

test code generation for objects Value must be a map of strings to values. It cannot be the 'null' value.

validate method

Input Type Return Type Notes
dict, schemas.immutabledict schemas.immutabledict

ObjectWithNoDeclaredPropsNullable

type: schemas.Schema

Description

test code generation for nullable objects. Value must be a map of strings to values or the 'null' value.

validate method

Input Type Return Type Notes
None, dict, schemas.immutabledict None, schemas.immutabledict

AnyTypeExceptNullProp

type: schemas.Schema

Description

any type except 'null' Here the 'type' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object.

validate method

Input Type Return Type Notes
dict, schemas.immutabledict, str, datetime.date, datetime.datetime, uuid.UUID, int, float, bool, None, list, tuple, bytes, io.FileIO, io.BufferedReader schemas.immutabledict, str, float, int, bool, None, tuple, bytes, io.FileIO

Composed Schemas (allOf/anyOf/oneOf/not)

not

Schema Class Input Type Return Type
_Not None None

_Not

type: schemas.Schema

validate method

Input Type Return Type Notes
None None

[Back to top] [Back to Component Schemas] [Back to README]