CheckFailure.to_json#
- CheckFailure.to_json(with_display: bool = True)[source]#
Return check failure as json.
Returned JSON string will have next structure:
>> class CheckFailureMetadata(TypedDict): >> check: CheckMetadata >> header: str >> display: List[Dict[str, str]]
>> class CheckMetadata(TypedDict): >> type: str >> name: str >> params: Dict[Any, Any] >> summary: str
- Parameters
- with_displaybool
controls if to serialize display or not
- Returns
- str