SwaggerSchema Clase

Esquema swagger.

Herencia

Model

SwaggerSchema

Constructor

SwaggerSchema(*, ref: str | None = None, type: str | SwaggerSchemaType | None = None, title: str | None = None, items: SwaggerSchema | None = None, properties: Dict[str, SwaggerSchema] | None = None, additional_properties: Any | None = None, required: List[str] | None = None, max_properties: int | None = None, min_properties: int | None = None, all_of: List[SwaggerSchema] | None = None, discriminator: str | None = None, read_only: bool | None = None, xml: SwaggerXml | None = None, external_docs: SwaggerExternalDocumentation | None = None, example: Any | None = None, notification_url_extension: bool | None = None, dynamic_schema_old: SwaggerCustomDynamicSchema | None = None, dynamic_schema_new: SwaggerCustomDynamicProperties | None = None, dynamic_list_new: SwaggerCustomDynamicList | None = None, dynamic_tree: SwaggerCustomDynamicTree | None = None, **kwargs)

Parámetros

ref

str

Referencia.

type

str o SwaggerSchemaType

Tipo. Entre los valores posibles se incluyen: "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null".

title

str

Título.

items

SwaggerSchema

Esquema de elementos.

properties

dict[str, SwaggerSchema]

Propiedades del objeto.

additional_properties

any

Propiedades adicionales.

required

list[str]

Propiedades necesarias para el objeto.

max_properties

int

Número máximo de propiedades permitidas.

min_properties

int

Número mínimo de propiedades permitidas.

all_of

list[SwaggerSchema]

Esquemas que deben pasar la validación cuando se usa este esquema.

discriminator

str

El discriminador.

read_only

bool

Indica si esta propiedad debe estar presente en una solicitud.

xml

SwaggerXml

Formato de representación xml para una propiedad.

external_docs

SwaggerExternalDocumentation

Documentación externa.

example

any

Valor de ejemplo.

notification_url_extension

bool

Indica la extensión url de notificación. Si se establece, el valor de la propiedad debe ser una dirección URL de devolución de llamada para un webhook.

dynamic_schema_old

SwaggerCustomDynamicSchema

Configuración de esquema dinámico.

dynamic_schema_new

SwaggerCustomDynamicProperties

Configuración de esquema dinámico.

dynamic_list_new

SwaggerCustomDynamicList

Lista dinámica.

dynamic_tree

SwaggerCustomDynamicTree

Configuración del árbol de valores dinámicos.

Variables

ref

str

Referencia.

type

str o SwaggerSchemaType

Tipo. Entre los valores posibles se incluyen: "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null".

title

str

Título.

items

SwaggerSchema

Esquema de elementos.

properties

dict[str, SwaggerSchema]

Propiedades del objeto.

additional_properties

any

Propiedades adicionales.

required

list[str]

Propiedades necesarias para el objeto.

max_properties

int

Número máximo de propiedades permitidas.

min_properties

int

Número mínimo de propiedades permitidas.

all_of

list[SwaggerSchema]

Esquemas que deben pasar la validación cuando se usa este esquema.

discriminator

str

El discriminador.

read_only

bool

Indica si esta propiedad debe estar presente en una solicitud.

xml

SwaggerXml

Formato de representación xml para una propiedad.

external_docs

SwaggerExternalDocumentation

Documentación externa.

example

any

Valor de ejemplo.

notification_url_extension

bool

Indica la extensión url de notificación. Si se establece, el valor de la propiedad debe ser una dirección URL de devolución de llamada para un webhook.

dynamic_schema_old

SwaggerCustomDynamicSchema

Configuración de esquema dinámico.

dynamic_schema_new

SwaggerCustomDynamicProperties

Configuración de esquema dinámico.

dynamic_list_new

SwaggerCustomDynamicList

Lista dinámica.

dynamic_tree

SwaggerCustomDynamicTree

Configuración del árbol de valores dinámicos.