Skip to main content

Parameter

No overview available.

Attributes

AttributeTypeDescription
namestrThe unique identifier of the parameter used to reference it within the API specification.
in_[ParameterInType](parameterintype.md?sid=fastapi_openapi_models_parameterintype)The location of the parameter, such as 'query', 'header', 'path', or 'cookie', mapped from the 'in' field in the specification.

Constructor

Signature

def Parameter(
name: string,
in_: [ParameterInType](parameterintype.md?sid=fastapi_openapi_models_parameterintype)
) - > null

Parameters

NameTypeDescription
namestringThe name of the parameter.
in_[ParameterInType](parameterintype.md?sid=fastapi_openapi_models_parameterintype)The location of the parameter (e.g., query, header, path, cookie), mapped from the 'in' alias.

Signature

def Parameter(
name: str,
in_: [ParameterInType](parameterintype.md?sid=fastapi_openapi_models_parameterintype)
) - > null

Parameters

NameTypeDescription
namestrThe unique identifier for the parameter as defined in the API specification.
in_[ParameterInType](parameterintype.md?sid=fastapi_openapi_models_parameterintype)The location of the parameter, such as 'query', 'header', 'path', or 'cookie', mapped from the 'in' field.