Request Parameters

Here's the reference information for the request parameters.

These are the special functions that you can put in path operation function parameters or dependency functions with Annotated to get data from the request.

It includes:

• Path()
• Query()
• Body()
• Event()
• Context()

You can import them all directly from nexify:

from nexify import Path, Query, Body, Event, Context

nexify.Path

Path(
    default=...,
    *,
    default_factory=Undefined,
    alias=None,
    alias_priority=Undefined,
    validation_alias=None,
    serialization_alias=None,
    title=None,
    description=None,
    gt=None,
    ge=None,
    lt=None,
    le=None,
    min_length=None,
    max_length=None,
    pattern=None,
    discriminator=None,
    strict=Undefined,
    multiple_of=Undefined,
    allow_inf_nan=Undefined,
    max_digits=Undefined,
    decimal_places=Undefined,
    examples=None,
    openapi_examples=None,
    deprecated=None,
    include_in_schema=True,
    json_schema_extra=None,
)

Declare a path parameter for a path operation.

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. This doesn't affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Any DEFAULT: ...
default_factory	A callable to generate the default value. This doesn't affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Callable[[], Any] | None DEFAULT: Undefined
alias	An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can't use the name you want because it is a Python reserved keyword or similar. TYPE: str | None DEFAULT: None
alias_priority	Priority of the alias. This affects whether an alias generator is used. TYPE: int | None DEFAULT: Undefined
validation_alias	'Whitelist' validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: str | AliasPath | AliasChoices | None DEFAULT: None
serialization_alias	'Blacklist' validation step. The vanilla parameter field will be the single one of the alias' or set of aliases' fields and all the other fields will be ignored at serialization time. TYPE: str | None DEFAULT: None
title	Human-readable title. TYPE: str | None DEFAULT: None
description	Human-readable description. TYPE: str | None DEFAULT: None
gt	Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: SupportsGt | None DEFAULT: None
ge	Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: SupportsGe | None DEFAULT: None
lt	Less than. If set, value must be less than this. Only applicable to numbers. TYPE: SupportsLt | None DEFAULT: None
le	Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: SupportsLe | None DEFAULT: None
min_length	Minimum length for strings. TYPE: int | None DEFAULT: None
max_length	Maximum length for strings. TYPE: int | None DEFAULT: None
pattern	RegEx pattern for strings. TYPE: str | None DEFAULT: None
discriminator	Parameter field name for discriminating the type in a tagged union. TYPE: str | None DEFAULT: None
strict	If True, strict validation is applied to the field. TYPE: bool | None DEFAULT: Undefined
multiple_of	Value must be a multiple of this. Only applicable to numbers. TYPE: float | None DEFAULT: Undefined
allow_inf_nan	Allow inf, -inf, nan. Only applicable to numbers. TYPE: bool | None DEFAULT: Undefined
max_digits	Maximum number of allow digits for strings. TYPE: int | None DEFAULT: Undefined
decimal_places	Maximum number of decimal places allowed for numbers. TYPE: int | None DEFAULT: Undefined
examples	Example values for this field. TYPE: list[Any] | None DEFAULT: None
openapi_examples	OpenAPI-specific examples. It will be added to the generated OpenAPI. Swagger UI has better support for the OpenAPI-specific examples than the JSON Schema examples, that's the main use case for this. TYPE: dict[str, Example] | None DEFAULT: None
deprecated	Mark this parameter field as deprecated. It will affect the generated OpenAPI. TYPE: deprecated | str | bool | None DEFAULT: None
include_in_schema	To include (or not) this parameter field in the generated OpenAPI. You probably don't need it, but it's available. This affects the generated OpenAPI. TYPE: bool DEFAULT: True
json_schema_extra	Any additional JSON schema data. TYPE: dict[str, Any] | None DEFAULT: None

Source code in nexify/param_functions.py

def Path(  # noqa: N802
    default: Annotated[
        Any,
        Doc(
            """
            Default value if the parameter field is not set.

            This doesn't affect `Path` parameters as the value is always required.
            The parameter is available only for compatibility.
            """
        ),
    ] = ...,
    *,
    default_factory: Annotated[
        Callable[[], Any] | None,
        Doc(
            """
            A callable to generate the default value.

            This doesn't affect `Path` parameters as the value is always required.
            The parameter is available only for compatibility.
            """
        ),
    ] = Undefined,
    alias: Annotated[
        str | None,
        Doc(
            """
            An alternative name for the parameter field.

            This will be used to extract the data and for the generated OpenAPI.
            It is particularly useful when you can't use the name you want because it
            is a Python reserved keyword or similar.
            """
        ),
    ] = None,
    alias_priority: Annotated[
        int | None,
        Doc(
            """
            Priority of the alias. This affects whether an alias generator is used.
            """
        ),
    ] = Undefined,
    validation_alias: Annotated[
        str | AliasPath | AliasChoices | None,
        Doc(
            """
            'Whitelist' validation step. The parameter field will be the single one
            allowed by the alias or set of aliases defined.
            """
        ),
    ] = None,
    serialization_alias: Annotated[
        str | None,
        Doc(
            """
            'Blacklist' validation step. The vanilla parameter field will be the
            single one of the alias' or set of aliases' fields and all the other
            fields will be ignored at serialization time.
            """
        ),
    ] = None,
    title: Annotated[
        str | None,
        Doc(
            """
            Human-readable title.
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            Human-readable description.
            """
        ),
    ] = None,
    gt: Annotated[
        SupportsGt | None,
        Doc(
            """
            Greater than. If set, value must be greater than this. Only applicable to
            numbers.
            """
        ),
    ] = None,
    ge: Annotated[
        SupportsGe | None,
        Doc(
            """
            Greater than or equal. If set, value must be greater than or equal to
            this. Only applicable to numbers.
            """
        ),
    ] = None,
    lt: Annotated[
        SupportsLt | None,
        Doc(
            """
            Less than. If set, value must be less than this. Only applicable to numbers.
            """
        ),
    ] = None,
    le: Annotated[
        SupportsLe | None,
        Doc(
            """
            Less than or equal. If set, value must be less than or equal to this.
            Only applicable to numbers.
            """
        ),
    ] = None,
    min_length: Annotated[
        int | None,
        Doc(
            """
            Minimum length for strings.
            """
        ),
    ] = None,
    max_length: Annotated[
        int | None,
        Doc(
            """
            Maximum length for strings.
            """
        ),
    ] = None,
    pattern: Annotated[
        str | None,
        Doc(
            """
            RegEx pattern for strings.
            """
        ),
    ] = None,
    discriminator: Annotated[
        str | None,
        Doc(
            """
            Parameter field name for discriminating the type in a tagged union.
            """
        ),
    ] = None,
    strict: Annotated[
        bool | None,
        Doc(
            """
            If `True`, strict validation is applied to the field.
            """
        ),
    ] = Undefined,
    multiple_of: Annotated[
        float | None,
        Doc(
            """
            Value must be a multiple of this. Only applicable to numbers.
            """
        ),
    ] = Undefined,
    allow_inf_nan: Annotated[
        bool | None,
        Doc(
            """
            Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
            """
        ),
    ] = Undefined,
    max_digits: Annotated[
        int | None,
        Doc(
            """
            Maximum number of allow digits for strings.
            """
        ),
    ] = Undefined,
    decimal_places: Annotated[
        int | None,
        Doc(
            """
            Maximum number of decimal places allowed for numbers.
            """
        ),
    ] = Undefined,
    examples: Annotated[
        list[Any] | None,
        Doc(
            """
            Example values for this field.
            """
        ),
    ] = None,
    openapi_examples: Annotated[
        dict[str, Example] | None,
        Doc(
            """
            OpenAPI-specific examples.

            It will be added to the generated OpenAPI.

            Swagger UI has better support for the
            OpenAPI-specific examples than the JSON Schema `examples`, that's the main
            use case for this.
            """
        ),
    ] = None,
    deprecated: Annotated[
        deprecated | str | bool | None,
        Doc(
            """
            Mark this parameter field as deprecated.

            It will affect the generated OpenAPI.
            """
        ),
    ] = None,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            To include (or not) this parameter field in the generated OpenAPI.
            You probably don't need it, but it's available.

            This affects the generated OpenAPI.
            """
        ),
    ] = True,
    json_schema_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Any additional JSON schema data.
            """
        ),
    ] = None,
) -> Any:
    """
    Declare a path parameter for a *path operation*.
    """
    return params.Path(
        default=default,
        default_factory=default_factory,
        alias=alias,
        alias_priority=alias_priority,
        validation_alias=validation_alias,
        serialization_alias=serialization_alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        openapi_examples=openapi_examples,
        deprecated=deprecated,
        include_in_schema=include_in_schema,
        json_schema_extra=json_schema_extra,
    )

nexify.Query

Query(
    default=Undefined,
    *,
    default_factory=Undefined,
    alias=None,
    alias_priority=Undefined,
    validation_alias=None,
    serialization_alias=None,
    title=None,
    description=None,
    gt=None,
    ge=None,
    lt=None,
    le=None,
    min_length=None,
    max_length=None,
    pattern=None,
    discriminator=None,
    strict=Undefined,
    multiple_of=Undefined,
    allow_inf_nan=Undefined,
    max_digits=Undefined,
    decimal_places=Undefined,
    examples=None,
    openapi_examples=None,
    deprecated=None,
    include_in_schema=True,
    json_schema_extra=None,
)

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	A callable to generate the default value. This doesn't affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Callable[[], Any] | None DEFAULT: Undefined
alias	An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can't use the name you want because it is a Python reserved keyword or similar. TYPE: str | None DEFAULT: None
alias_priority	Priority of the alias. This affects whether an alias generator is used. TYPE: int | None DEFAULT: Undefined
validation_alias	'Whitelist' validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: str | AliasPath | AliasChoices | None DEFAULT: None
serialization_alias	'Blacklist' validation step. The vanilla parameter field will be the single one of the alias' or set of aliases' fields and all the other fields will be ignored at serialization time. TYPE: str | None DEFAULT: None
title	Human-readable title. TYPE: str | None DEFAULT: None
description	Human-readable description. TYPE: str | None DEFAULT: None
gt	Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: SupportsGt | None DEFAULT: None
ge	Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: SupportsGe | None DEFAULT: None
lt	Less than. If set, value must be less than this. Only applicable to numbers. TYPE: SupportsLt | None DEFAULT: None
le	Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: SupportsLe | None DEFAULT: None
min_length	Minimum length for strings. TYPE: int | None DEFAULT: None
max_length	Maximum length for strings. TYPE: int | None DEFAULT: None
pattern	RegEx pattern for strings. TYPE: str | None DEFAULT: None
discriminator	Parameter field name for discriminating the type in a tagged union. TYPE: str | None DEFAULT: None
strict	If True, strict validation is applied to the field. TYPE: bool | None DEFAULT: Undefined
multiple_of	Value must be a multiple of this. Only applicable to numbers. TYPE: float | None DEFAULT: Undefined
allow_inf_nan	Allow inf, -inf, nan. Only applicable to numbers. TYPE: bool | None DEFAULT: Undefined
max_digits	Maximum number of allow digits for strings. TYPE: int | None DEFAULT: Undefined
decimal_places	Maximum number of decimal places allowed for numbers. TYPE: int | None DEFAULT: Undefined
examples	Example values for this field. TYPE: list[Any] | None DEFAULT: None
openapi_examples	OpenAPI-specific examples. It will be added to the generated OpenAPI. Swagger UI has better support for the OpenAPI-specific examples than the JSON Schema examples, that's the main use case for this. TYPE: dict[str, Example] | None DEFAULT: None
deprecated	Mark this parameter field as deprecated. It will affect the generated OpenAPI. TYPE: deprecated | str | bool | None DEFAULT: None
include_in_schema	To include (or not) this parameter field in the generated OpenAPI. You probably don't need it, but it's available. This affects the generated OpenAPI. TYPE: bool DEFAULT: True
json_schema_extra	Any additional JSON schema data. TYPE: dict[str, Any] | None DEFAULT: None

Source code in nexify/param_functions.py

def Query(  # noqa: N802
    default: Annotated[
        Any,
        Doc(
            """
            Default value if the parameter field is not set.
            """
        ),
    ] = Undefined,
    *,
    default_factory: Annotated[
        Callable[[], Any] | None,
        Doc(
            """
            A callable to generate the default value.

            This doesn't affect `Path` parameters as the value is always required.
            The parameter is available only for compatibility.
            """
        ),
    ] = Undefined,
    alias: Annotated[
        str | None,
        Doc(
            """
            An alternative name for the parameter field.

            This will be used to extract the data and for the generated OpenAPI.
            It is particularly useful when you can't use the name you want because it
            is a Python reserved keyword or similar.
            """
        ),
    ] = None,
    alias_priority: Annotated[
        int | None,
        Doc(
            """
            Priority of the alias. This affects whether an alias generator is used.
            """
        ),
    ] = Undefined,
    validation_alias: Annotated[
        str | AliasPath | AliasChoices | None,
        Doc(
            """
            'Whitelist' validation step. The parameter field will be the single one
            allowed by the alias or set of aliases defined.
            """
        ),
    ] = None,
    serialization_alias: Annotated[
        str | None,
        Doc(
            """
            'Blacklist' validation step. The vanilla parameter field will be the
            single one of the alias' or set of aliases' fields and all the other
            fields will be ignored at serialization time.
            """
        ),
    ] = None,
    title: Annotated[
        str | None,
        Doc(
            """
            Human-readable title.
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            Human-readable description.
            """
        ),
    ] = None,
    gt: Annotated[
        SupportsGt | None,
        Doc(
            """
            Greater than. If set, value must be greater than this. Only applicable to
            numbers.
            """
        ),
    ] = None,
    ge: Annotated[
        SupportsGe | None,
        Doc(
            """
            Greater than or equal. If set, value must be greater than or equal to
            this. Only applicable to numbers.
            """
        ),
    ] = None,
    lt: Annotated[
        SupportsLt | None,
        Doc(
            """
            Less than. If set, value must be less than this. Only applicable to numbers.
            """
        ),
    ] = None,
    le: Annotated[
        SupportsLe | None,
        Doc(
            """
            Less than or equal. If set, value must be less than or equal to this.
            Only applicable to numbers.
            """
        ),
    ] = None,
    min_length: Annotated[
        int | None,
        Doc(
            """
            Minimum length for strings.
            """
        ),
    ] = None,
    max_length: Annotated[
        int | None,
        Doc(
            """
            Maximum length for strings.
            """
        ),
    ] = None,
    pattern: Annotated[
        str | None,
        Doc(
            """
            RegEx pattern for strings.
            """
        ),
    ] = None,
    discriminator: Annotated[
        str | None,
        Doc(
            """
            Parameter field name for discriminating the type in a tagged union.
            """
        ),
    ] = None,
    strict: Annotated[
        bool | None,
        Doc(
            """
            If `True`, strict validation is applied to the field.
            """
        ),
    ] = Undefined,
    multiple_of: Annotated[
        float | None,
        Doc(
            """
            Value must be a multiple of this. Only applicable to numbers.
            """
        ),
    ] = Undefined,
    allow_inf_nan: Annotated[
        bool | None,
        Doc(
            """
            Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
            """
        ),
    ] = Undefined,
    max_digits: Annotated[
        int | None,
        Doc(
            """
            Maximum number of allow digits for strings.
            """
        ),
    ] = Undefined,
    decimal_places: Annotated[
        int | None,
        Doc(
            """
            Maximum number of decimal places allowed for numbers.
            """
        ),
    ] = Undefined,
    examples: Annotated[
        list[Any] | None,
        Doc(
            """
            Example values for this field.
            """
        ),
    ] = None,
    openapi_examples: Annotated[
        dict[str, Example] | None,
        Doc(
            """
            OpenAPI-specific examples.

            It will be added to the generated OpenAPI.

            Swagger UI has better support for the
            OpenAPI-specific examples than the JSON Schema `examples`, that's the main
            use case for this.
            """
        ),
    ] = None,
    deprecated: Annotated[
        deprecated | str | bool | None,
        Doc(
            """
            Mark this parameter field as deprecated.

            It will affect the generated OpenAPI.
            """
        ),
    ] = None,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            To include (or not) this parameter field in the generated OpenAPI.
            You probably don't need it, but it's available.

            This affects the generated OpenAPI.
            """
        ),
    ] = True,
    json_schema_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Any additional JSON schema data.
            """
        ),
    ] = None,
) -> Any:
    return params.Query(
        default=default,
        default_factory=default_factory,
        alias=alias,
        alias_priority=alias_priority,
        validation_alias=validation_alias,
        serialization_alias=serialization_alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        openapi_examples=openapi_examples,
        deprecated=deprecated,
        include_in_schema=include_in_schema,
        json_schema_extra=json_schema_extra,
    )

nexify.Body

Body(
    default=Undefined,
    *,
    default_factory=Undefined,
    embed=None,
    media_type="application/json",
    alias=None,
    alias_priority=Undefined,
    validation_alias=None,
    serialization_alias=None,
    title=None,
    description=None,
    gt=None,
    ge=None,
    lt=None,
    le=None,
    min_length=None,
    max_length=None,
    pattern=None,
    discriminator=None,
    strict=Undefined,
    multiple_of=Undefined,
    allow_inf_nan=Undefined,
    max_digits=Undefined,
    decimal_places=Undefined,
    examples=None,
    openapi_examples=None,
    deprecated=None,
    include_in_schema=True,
    json_schema_extra=None,
)

PARAMETER	DESCRIPTION
default	Default value if the parameter field is not set. TYPE: Any DEFAULT: Undefined
default_factory	A callable to generate the default value. This doesn't affect Path parameters as the value is always required. The parameter is available only for compatibility. TYPE: Callable[[], Any] | None DEFAULT: Undefined
embed	When embed is True, the parameter will be expected in a JSON body as a key instead of being the JSON body itself. This happens automatically when more than one Body parameter is declared. TYPE: bool | None DEFAULT: None
media_type	The media type of this parameter field. Changing it would affect the generated OpenAPI, but currently it doesn't affect the parsing of the data. TYPE: str DEFAULT: 'application/json'
alias	An alternative name for the parameter field. This will be used to extract the data and for the generated OpenAPI. It is particularly useful when you can't use the name you want because it is a Python reserved keyword or similar. TYPE: str | None DEFAULT: None
alias_priority	Priority of the alias. This affects whether an alias generator is used. TYPE: int | None DEFAULT: Undefined
validation_alias	'Whitelist' validation step. The parameter field will be the single one allowed by the alias or set of aliases defined. TYPE: str | AliasPath | AliasChoices | None DEFAULT: None
serialization_alias	'Blacklist' validation step. The vanilla parameter field will be the single one of the alias' or set of aliases' fields and all the other fields will be ignored at serialization time. TYPE: str | None DEFAULT: None
title	Human-readable title. TYPE: str | None DEFAULT: None
description	Human-readable description. TYPE: str | None DEFAULT: None
gt	Greater than. If set, value must be greater than this. Only applicable to numbers. TYPE: SupportsGt | None DEFAULT: None
ge	Greater than or equal. If set, value must be greater than or equal to this. Only applicable to numbers. TYPE: SupportsGe | None DEFAULT: None
lt	Less than. If set, value must be less than this. Only applicable to numbers. TYPE: SupportsLt | None DEFAULT: None
le	Less than or equal. If set, value must be less than or equal to this. Only applicable to numbers. TYPE: SupportsLe | None DEFAULT: None
min_length	Minimum length for strings. TYPE: int | None DEFAULT: None
max_length	Maximum length for strings. TYPE: int | None DEFAULT: None
pattern	RegEx pattern for strings. TYPE: str | None DEFAULT: None
discriminator	Parameter field name for discriminating the type in a tagged union. TYPE: str | None DEFAULT: None
strict	If True, strict validation is applied to the field. TYPE: bool | None DEFAULT: Undefined
multiple_of	Value must be a multiple of this. Only applicable to numbers. TYPE: float | None DEFAULT: Undefined
allow_inf_nan	Allow inf, -inf, nan. Only applicable to numbers. TYPE: bool | None DEFAULT: Undefined
max_digits	Maximum number of allow digits for strings. TYPE: int | None DEFAULT: Undefined
decimal_places	Maximum number of decimal places allowed for numbers. TYPE: int | None DEFAULT: Undefined
examples	Example values for this field. TYPE: list[Any] | None DEFAULT: None
openapi_examples	OpenAPI-specific examples. It will be added to the generated OpenAPI. Swagger UI has better support for the OpenAPI-specific examples than the JSON Schema examples, that's the main use case for this. TYPE: dict[str, Example] | None DEFAULT: None
deprecated	Mark this parameter field as deprecated. It will affect the generated OpenAPI. TYPE: deprecated | str | bool | None DEFAULT: None
include_in_schema	To include (or not) this parameter field in the generated OpenAPI. You probably don't need it, but it's available. This affects the generated OpenAPI. TYPE: bool DEFAULT: True
json_schema_extra	Any additional JSON schema data. TYPE: dict[str, Any] | None DEFAULT: None

Source code in nexify/param_functions.py

def Body(  # noqa: N802
    default: Annotated[
        Any,
        Doc(
            """
            Default value if the parameter field is not set.
            """
        ),
    ] = Undefined,
    *,
    default_factory: Annotated[
        Callable[[], Any] | None,
        Doc(
            """
            A callable to generate the default value.

            This doesn't affect `Path` parameters as the value is always required.
            The parameter is available only for compatibility.
            """
        ),
    ] = Undefined,
    embed: Annotated[
        bool | None,
        Doc(
            """
            When `embed` is `True`, the parameter will be expected in a JSON body as a
            key instead of being the JSON body itself.

            This happens automatically when more than one `Body` parameter is declared.
            """
        ),
    ] = None,
    media_type: Annotated[
        str,
        Doc(
            """
            The media type of this parameter field. Changing it would affect the
            generated OpenAPI, but currently it doesn't affect the parsing of the data.
            """
        ),
    ] = "application/json",
    alias: Annotated[
        str | None,
        Doc(
            """
            An alternative name for the parameter field.

            This will be used to extract the data and for the generated OpenAPI.
            It is particularly useful when you can't use the name you want because it
            is a Python reserved keyword or similar.
            """
        ),
    ] = None,
    alias_priority: Annotated[
        int | None,
        Doc(
            """
            Priority of the alias. This affects whether an alias generator is used.
            """
        ),
    ] = Undefined,
    validation_alias: Annotated[
        str | AliasPath | AliasChoices | None,
        Doc(
            """
            'Whitelist' validation step. The parameter field will be the single one
            allowed by the alias or set of aliases defined.
            """
        ),
    ] = None,
    serialization_alias: Annotated[
        str | None,
        Doc(
            """
            'Blacklist' validation step. The vanilla parameter field will be the
            single one of the alias' or set of aliases' fields and all the other
            fields will be ignored at serialization time.
            """
        ),
    ] = None,
    title: Annotated[
        str | None,
        Doc(
            """
            Human-readable title.
            """
        ),
    ] = None,
    description: Annotated[
        str | None,
        Doc(
            """
            Human-readable description.
            """
        ),
    ] = None,
    gt: Annotated[
        SupportsGt | None,
        Doc(
            """
            Greater than. If set, value must be greater than this. Only applicable to
            numbers.
            """
        ),
    ] = None,
    ge: Annotated[
        SupportsGe | None,
        Doc(
            """
            Greater than or equal. If set, value must be greater than or equal to
            this. Only applicable to numbers.
            """
        ),
    ] = None,
    lt: Annotated[
        SupportsLt | None,
        Doc(
            """
            Less than. If set, value must be less than this. Only applicable to numbers.
            """
        ),
    ] = None,
    le: Annotated[
        SupportsLe | None,
        Doc(
            """
            Less than or equal. If set, value must be less than or equal to this.
            Only applicable to numbers.
            """
        ),
    ] = None,
    min_length: Annotated[
        int | None,
        Doc(
            """
            Minimum length for strings.
            """
        ),
    ] = None,
    max_length: Annotated[
        int | None,
        Doc(
            """
            Maximum length for strings.
            """
        ),
    ] = None,
    pattern: Annotated[
        str | None,
        Doc(
            """
            RegEx pattern for strings.
            """
        ),
    ] = None,
    discriminator: Annotated[
        str | None,
        Doc(
            """
            Parameter field name for discriminating the type in a tagged union.
            """
        ),
    ] = None,
    strict: Annotated[
        bool | None,
        Doc(
            """
            If `True`, strict validation is applied to the field.
            """
        ),
    ] = Undefined,
    multiple_of: Annotated[
        float | None,
        Doc(
            """
            Value must be a multiple of this. Only applicable to numbers.
            """
        ),
    ] = Undefined,
    allow_inf_nan: Annotated[
        bool | None,
        Doc(
            """
            Allow `inf`, `-inf`, `nan`. Only applicable to numbers.
            """
        ),
    ] = Undefined,
    max_digits: Annotated[
        int | None,
        Doc(
            """
            Maximum number of allow digits for strings.
            """
        ),
    ] = Undefined,
    decimal_places: Annotated[
        int | None,
        Doc(
            """
            Maximum number of decimal places allowed for numbers.
            """
        ),
    ] = Undefined,
    examples: Annotated[
        list[Any] | None,
        Doc(
            """
            Example values for this field.
            """
        ),
    ] = None,
    openapi_examples: Annotated[
        dict[str, Example] | None,
        Doc(
            """
            OpenAPI-specific examples.

            It will be added to the generated OpenAPI.

            Swagger UI has better support for the
            OpenAPI-specific examples than the JSON Schema `examples`, that's the main
            use case for this.
            """
        ),
    ] = None,
    deprecated: Annotated[
        deprecated | str | bool | None,
        Doc(
            """
            Mark this parameter field as deprecated.

            It will affect the generated OpenAPI.
            """
        ),
    ] = None,
    include_in_schema: Annotated[
        bool,
        Doc(
            """
            To include (or not) this parameter field in the generated OpenAPI.
            You probably don't need it, but it's available.

            This affects the generated OpenAPI.
            """
        ),
    ] = True,
    json_schema_extra: Annotated[
        dict[str, Any] | None,
        Doc(
            """
            Any additional JSON schema data.
            """
        ),
    ] = None,
) -> Any:
    return params.Body(
        default=default,
        default_factory=default_factory,
        embed=embed,
        media_type=media_type,
        alias=alias,
        alias_priority=alias_priority,
        validation_alias=validation_alias,
        serialization_alias=serialization_alias,
        title=title,
        description=description,
        gt=gt,
        ge=ge,
        lt=lt,
        le=le,
        min_length=min_length,
        max_length=max_length,
        pattern=pattern,
        discriminator=discriminator,
        strict=strict,
        multiple_of=multiple_of,
        allow_inf_nan=allow_inf_nan,
        max_digits=max_digits,
        decimal_places=decimal_places,
        examples=examples,
        openapi_examples=openapi_examples,
        deprecated=deprecated,
        include_in_schema=include_in_schema,
        json_schema_extra=json_schema_extra,
    )

nexify.Event

Event()

Source code in nexify/param_functions.py

def Event():
    return params.Event()

nexify.Context

Context()

Source code in nexify/param_functions.py

def Context():
    return params.Context()