SettingsCheckError

The CheckError structure contains fields that describe an error reported by CheckStatus


Properties

description Required

Description of what was the issue containing as much user-relevant context as possible. The user should be able to understand which sub-system failed and why.


resolution Optional

Possible resolution for the issue. This should contain actionable information that the user can use to resolve the issue. Can be left unset if no meaningful resolution exists.

JSON Example

{
	"description": {
		"args": [
			"string"
		],
		"default_message": "string",
		"id": "string"
	}
}

Feedback

Was this page helpful?