ApiDefinitionRow 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.

Properties

DefaultValue string?: Default: null
Default value as it would appear in source, or null when no default applies.
DescriptionHtml string: Pre-rendered HTML for the description column (already escaped).
Name string: Identifier shown in the Name column.
Required bool: Default: false
When true, the row renders a "required" badge.
TypeDisplay string: Human-readable type, shown in the Type column.

Constructors

.ctor

public sealed record ApiDefinitionRow(
    string Name,
    string TypeDisplay,
    string? DefaultValue,
    bool Required,
    string DescriptionHtml);

One row in an ApiDefinitionList: a named definition with a type, an optional default value, an optional "required" flag, and a description.

Parameters

Name string: Identifier shown in the Name column.
TypeDisplay string: Human-readable type, shown in the Type column.
DefaultValue string?: Default value as it would appear in source, or null when no default applies.
Required bool: When true, the row renders a "required" badge.
DescriptionHtml string: Pre-rendered HTML for the description column (already escaped).

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 sealed record 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.
    string? DefaultValue;

    /// Pre-rendered HTML for the description column (already escaped).
    string DescriptionHtml;

    /// Identifier shown in the Name column.
    string Name;

    /// When true, the row renders a "required" badge.
    bool Required;

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