Document the check result attributes #1331
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR documents the check result attributes found in an event.
Motivation and Context
Created in response to https://discourse.sensu.io/t/format-of-event-check-history-in-sensu-go/1121.
Review Instructions
I created the PR against 5.4 documentation, I can retroactively do it for older versions too.
Also, I wasn't sure where to put the actual documentation for these new attributes.