Header

No overview available.

def Header(
    default: Any = Undefined,
    default_factory: Callable[[], Any] | None = _Unset,
    alias: str | None = None,
    alias_priority: int | None = _Unset,
    validation_alias: str | AliasPath | AliasChoices | None = None,
    serialization_alias: str | None = None,
    convert_underscores: bool = True,
    title: str | None = None,
    description: str | None = None,
    gt: float | None = None,
    ge: float | None = None,
    lt: float | None = None,
    le: float | None = None,
    min_length: int | None = None,
    max_length: int | None = None,
    pattern: str | None = None,
    regex: str | None = None,
    discriminator: str | None = None,
    strict: bool | None = _Unset,
    multiple_of: float | None = _Unset,
    allow_inf_nan: bool | None = _Unset,
    max_digits: int | None = _Unset,
    decimal_places: int | None = _Unset,
    examples: list[Any] | None = None,
    example: Any | None = _Unset,
    openapi_examples: dict[str, Example] | None = None,
    deprecated: deprecated | str | bool | None = None,
    include_in_schema: bool = True,
    json_schema_extra: dict[str, Any] | None = None,
    extra: Any
) - > Any

Creates a Header parameter that can be used to define request header fields for an API endpoint. This function allows you to specify default values, aliases, validation rules, and OpenAPI documentation details for the header.

Parameters

Name	Type	Description
default	Any = Undefined	The default value to use if the header parameter field is not provided in the request.
default_factory	`Callable[[], Any]	None` = _Unset
alias	`str	None` = None
alias_priority	`int	None` = _Unset
validation_alias	`str	AliasPath
serialization_alias	`str	None` = None
convert_underscores	bool = True	A boolean indicating whether to automatically convert underscores in the header parameter field name to hyphens. This is a common practice for HTTP header names.
title	`str	None` = None
description	`str	None` = None
gt	`float	None` = None
ge	`float	None` = None
lt	`float	None` = None
le	`float	None` = None
min_length	`int	None` = None
max_length	`int	None` = None
pattern	`str	None` = None
regex	`str	None` = None
discriminator	`str	None` = None
strict	`bool	None` = _Unset
multiple_of	`float	None` = _Unset
allow_inf_nan	`bool	None` = _Unset
max_digits	`int	None` = _Unset
decimal_places	`int	None` = _Unset
examples	`list[Any]	None` = None
example	`Any	None` = _Unset
openapi_examples	`dict[str, Example]	None` = None
deprecated	`deprecated	str
include_in_schema	bool = True	A boolean indicating whether to include this header parameter field in the generated OpenAPI schema.
json_schema_extra	`dict[str, Any]	None` = None
extra	Any	Additional fields used by the JSON Schema. This parameter is deprecated; use json_schema_extra instead.

Returns

Type	Description
Any	The configured Header parameter object.