Pennington.DocSite.Api.ApiReferenceRegistration

namespace Pennington.DocSite.Api;

/// One named API-reference tree: a provider key and the public URL prefix under which its pages are served.
public record ApiReferenceRegistration
{
    /// One named API-reference tree: a provider key and the public URL prefix under which its pages are served.
    
public ApiReferenceRegistration(string Name, string RoutePrefix, string TocTitle, string TocSectionLabel, int SearchPriority)
;

    /// Registration name. Matches the name argument passed to the metadata backend's AddApiMetadataFrom* call.
    
public string Name { get; set; }


    /// Normalized URL prefix with leading and trailing slashes, e.g. "/api/" or "/reference/api/spectre/".
    
public string RoutePrefix { get; set; }


    /// Search-index priority applied to every page under RoutePrefix; lower ranks later.
    
public int SearchPriority { get; set; }


    /// Section label the TOC entry groups under, or null to keep it unsectioned.
    
public string TocSectionLabel { get; set; }


    /// Sidebar title for the index page's TOC entry, or null to suppress the entry.
    
public string TocTitle { get; set; }

}