= Cheatsheets

[[CheckResult]]
== CheckResult

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[data]]`@data`|`Json object`|-
|[[id]]`@id`|`String`|-
|[[up]]`@up`|`Boolean`|-
|===

[[Status]]
== Status

++++
Represents the outcome of a health check procedure. Each procedure produces a link indicating either OK
or KO. Optionally, it can also provide additional data.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[data]]`@data`|`Json object`|+++
Sets the metadata.
+++
|[[ok]]`@ok`|`Boolean`|+++
Sets whether or not the current status is positive (UP) or negative (DOWN).
+++
|[[procedureInError]]`@procedureInError`|`Boolean`|+++
Sets whether or not the procedure attached to this status has failed (timeout, error...).
+++
|===