Pennington.DocSite.Api.Components.Reference.ApiDefinitionRow

namespace Pennington.DocSite.Api.Components.Reference;

/// One row in an ApiDefinitionList: a named definition with a type, an optional default value, an optional "required" flag, and a description.
public record ApiDefinitionRow
{
    /// One row in an ApiDefinitionList: a named definition with a type, an optional default value, an optional "required" flag, and a description.
    
public ApiDefinitionRow(string Name, string TypeDisplay, string DefaultValue, bool Required, string DescriptionHtml)
;

    /// Default value as it would appear in source, or null when no default applies.
    
public string DefaultValue { get; set; }


    /// Pre-rendered HTML for the description column (already escaped).
    
public string DescriptionHtml { get; set; }


    /// Identifier shown in the Name column.
    
public string Name { get; set; }


    /// When true, the row renders a "required" badge.
    
public bool Required { get; set; }


    /// Human-readable type, shown in the Type column.
    
public string TypeDisplay { get; set; }

}