MediaType
This class represents a media type object that provides a schema and examples for the content of an HTTP request or response. It allows for the definition of data structures using schemas, single or multiple examples, and specific encoding rules for properties.
Attributes
| Attribute | Type | Description |
|---|---|---|
| schema_ | `Schema | Reference |
| example | `Any | None` = null |
| examples | `dict[str, Example | Reference] |
| encoding | `dict[str, Encoding] | None` = null |
Constructor
Signature
def MediaType(
schema_: Schema | Reference | None = None,
example: Any | None = None,
examples: dict[str, Example | Reference]| None = None,
encoding: dict[str, [Encoding](encoding.md?sid=fastapi_openapi_models_encoding)]| None = None
) - > null
Parameters
| Name | Type | Description |
|---|---|---|
| schema_ | `Schema | Reference |
| example | `Any | None` = None |
| examples | `dict[str, Example | Reference] |
| encoding | `dict[str, Encoding] | None` = None |
Signature
def MediaType(
schema_: Schema | Reference | None = None,
example: Any | None = None,
examples: dict[str, Example | Reference]| None = None,
encoding: dict[str, [Encoding](encoding.md?sid=fastapi_openapi_models_encoding)]| None = None
) - > null
Parameters
| Name | Type | Description |
|---|---|---|
| schema_ | `Schema | Reference |
| example | `Any | None` = None |
| examples | `dict[str, Example | Reference] |
| encoding | `dict[str, Encoding] | None` = None |