SwaggerSchema Class

The swagger schema.

Inheritance

msrest.serialization.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)

Keyword-Only Parameters

Name	Description
ref	str The reference.
type	str or SwaggerSchemaType The type. Possible values include: "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null".
title	str The title.
items	SwaggerSchema The items schema.
properties	dict[str, SwaggerSchema] The object properties.
additional_properties	any The additional properties.
required	list[str] The object required properties.
max_properties	int The maximum number of allowed properties.
min_properties	int The minimum number of allowed properties.
all_of	list[SwaggerSchema] The schemas which must pass validation when this schema is used.
discriminator	str The discriminator.
read_only	bool Indicates whether this property must be present in the a request.
xml	SwaggerXml The xml representation format for a property.
external_docs	SwaggerExternalDocumentation The external documentation.
example	any The example value.
notification_url_extension	bool Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.
dynamic_schema_old	SwaggerCustomDynamicSchema The dynamic schema configuration.
dynamic_schema_new	SwaggerCustomDynamicProperties The dynamic schema configuration.
dynamic_list_new	SwaggerCustomDynamicList The dynamic list.
dynamic_tree	SwaggerCustomDynamicTree The dynamic values tree configuration.

Variables

Name	Description
ref	str The reference.
type	str or SwaggerSchemaType The type. Possible values include: "String", "Number", "Integer", "Boolean", "Array", "File", "Object", "Null".
title	str The title.
items	SwaggerSchema The items schema.
properties	dict[str, SwaggerSchema] The object properties.
additional_properties	any The additional properties.
required	list[str] The object required properties.
max_properties	int The maximum number of allowed properties.
min_properties	int The minimum number of allowed properties.
all_of	list[SwaggerSchema] The schemas which must pass validation when this schema is used.
discriminator	str The discriminator.
read_only	bool Indicates whether this property must be present in the a request.
xml	SwaggerXml The xml representation format for a property.
external_docs	SwaggerExternalDocumentation The external documentation.
example	any The example value.
notification_url_extension	bool Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook.
dynamic_schema_old	SwaggerCustomDynamicSchema The dynamic schema configuration.
dynamic_schema_new	SwaggerCustomDynamicProperties The dynamic schema configuration.
dynamic_list_new	SwaggerCustomDynamicList The dynamic list.
dynamic_tree	SwaggerCustomDynamicTree The dynamic values tree configuration.