Skip to content

get_response_schema

faststream.asyncapi.message.get_response_schema #

get_response_schema(
    call: Optional[CallModel[Any, Any]], prefix: str = ""
) -> Optional[Dict[str, Any]]

Get the response schema for a given call.

PARAMETER DESCRIPTION
call

The call model.

TYPE: Optional[CallModel[Any, Any]]

prefix

A prefix to add to the schema keys.

TYPE: str DEFAULT: ''

RETURNS DESCRIPTION
Optional[Dict[str, Any]]

The response schema as a dictionary.
Source code in faststream/asyncapi/message.py 
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def get_response_schema(
    call: Optional[CallModel[Any, Any]],
    prefix: str = "",
) -> Optional[Dict[str, Any]]:
    """Get the response schema for a given call.

    Args:
        call: The call model.
        prefix: A prefix to add to the schema keys.

    Returns:
        The response schema as a dictionary.

    """
    return get_model_schema(
        getattr(
            call, "response_model", None
        ),  # NOTE: FastAPI Dependant object compatibility
        prefix=prefix,
    )