Umbraco-CMS/src/Umbraco.Core/HealthChecks/HealthCheckStatus.cs

using System.Runtime.Serialization;

namespace Umbraco.Cms.Core.HealthChecks;

/// <summary>
///     The status returned for a health check when it performs it check
///     TODO: This model will be used in the WebApi result so needs attributes for JSON usage
/// </summary>
[DataContract(Name = "healthCheckStatus", Namespace = "")]
public class HealthCheckStatus
{
    public HealthCheckStatus(string message)
    {
        Message = message;
        Actions = Enumerable.Empty<HealthCheckAction>();
    }

    /// <summary>
    ///     The status message
    /// </summary>
    [DataMember(Name = "message")]
    public string Message { get; private set; }

    /// <summary>
    ///     The status description if one is necessary
    /// </summary>
    [DataMember(Name = "description")]
    public string? Description { get; set; }

    /// <summary>
    ///     This is optional but would allow a developer to specify a path to an angular HTML view
    ///     in order to either show more advanced information and/or to provide input for the admin
    ///     to configure how an action is executed
    /// </summary>
    [DataMember(Name = "view")]
    public string? View { get; set; }

    /// <summary>
    ///     The status type
    /// </summary>
    [DataMember(Name = "resultType")]
    public StatusResultType ResultType { get; set; }

    /// <summary>
    ///     The potential actions to take (in any)
    /// </summary>
    [DataMember(Name = "actions")]
    public IEnumerable<HealthCheckAction> Actions { get; set; }

    /// <summary>
    ///     This is optional but would allow a developer to specify a link that is shown as a "read more" button.
    /// </summary>
    [DataMember(Name = "readMoreLink")]
    public string? ReadMoreLink { get; set; }
}