SwaggerSchema Class
The swagger schema.
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)Keyword-Only Parameters
| Name | Description |
|---|---|
|
ref
|
The reference. Default value: None
|
|
type
|
The type. Possible values include: "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null". Default value: None
|
|
title
|
The title. Default value: None
|
|
items
|
The items schema. Default value: None
|
|
properties
|
The object properties. Default value: None
|
|
additional_properties
|
The additional properties. Default value: None
|
|
required
|
The object required properties. Default value: None
|
|
max_properties
|
The maximum number of allowed properties. Default value: None
|
|
min_properties
|
The minimum number of allowed properties. Default value: None
|
|
all_of
|
The schemas which must pass validation when this schema is used. Default value: None
|
|
discriminator
|
The discriminator. Default value: None
|
|
read_only
|
Indicates whether this property must be present in the a request. Default value: None
|
|
xml
|
The xml representation format for a property. Default value: None
|
|
external_docs
|
The external documentation. Default value: None
|
|
example
|
The example value. Default value: None
|
|
notification_url_extension
|
Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook. Default value: None
|
|
dynamic_schema_old
|
The dynamic schema configuration. Default value: None
|
|
dynamic_schema_new
|
The dynamic schema configuration. Default value: None
|
|
dynamic_list_new
|
The dynamic list. Default value: None
|
|
dynamic_tree
|
The dynamic values tree configuration. Default value: None
|
Variables
| Name | Description |
|---|---|
|
ref
|
The reference. |
|
type
|
The type. Possible values include: "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null". |
|
title
|
The title. |
|
items
|
The items schema. |
|
properties
|
The object properties. |
|
additional_properties
|
The additional properties. |
|
required
|
The object required properties. |
|
max_properties
|
The maximum number of allowed properties. |
|
min_properties
|
The minimum number of allowed properties. |
|
all_of
|
The schemas which must pass validation when this schema is used. |
|
discriminator
|
The discriminator. |
|
read_only
|
Indicates whether this property must be present in the a request. |
|
xml
|
The xml representation format for a property. |
|
external_docs
|
The external documentation. |
|
example
|
The example value. |
|
notification_url_extension
|
Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook. |
|
dynamic_schema_old
|
The dynamic schema configuration. |
|
dynamic_schema_new
|
The dynamic schema configuration. |
|
dynamic_list_new
|
The dynamic list. |
|
dynamic_tree
|
The dynamic values tree configuration. |
