CheckResult.to_json#

CheckResult.to_json(with_display: bool = True) str[source]#

Return check result as json.

Returned JSON string will have next structure:

>> class CheckResultMetadata(TypedDict): >> type: str >> check: CheckMetadata >> value: Any >> header: str >> conditions_results: List[Dict[Any, Any]] >> display: List[Dict[str, Any]]

>> class CheckMetadata(TypedDict): >> name: str >> params: Dict[Any, Any] >> summary: str

Parameters
with_displaybool

controls if to serialize display or not

Returns
str