ApiReferenceRegistration Pennington.DocSite.Api

One named API-reference tree: a provider key and the public URL prefix under which its pages are served.

Properties

Name string: Registration name. Matches the name argument passed to the metadata backend's AddApiMetadataFrom* call.
RoutePrefix string: Normalized URL prefix with leading and trailing slashes, e.g. "/api/" or "/reference/api/spectre/".
TocSectionLabel string?: Default: null
Section label the TOC entry groups under, or null to keep it unsectioned.
TocTitle string?: Default: null
Sidebar title for the index page's TOC entry, or null to suppress the entry.

Constructors

.ctor

public sealed record ApiReferenceRegistration(string Name, string RoutePrefix, string? TocTitle, string? TocSectionLabel);

One named API-reference tree: a provider key and the public URL prefix under which its pages are served.

Parameters

Name string: Registration name. Matches the name argument passed to the metadata backend's AddApiMetadataFrom* call.
RoutePrefix string: Normalized URL prefix with leading and trailing slashes, e.g. "/api/" or "/reference/api/spectre/".
TocTitle string?: Sidebar title for the index page's TOC entry, or null to suppress the entry.
TocSectionLabel string?: Section label the TOC entry groups under, or null to keep it unsectioned.

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 sealed record ApiReferenceRegistration(string Name, string RoutePrefix, string? TocTitle, string? TocSectionLabel);

    /// Registration name. Matches the name argument passed to the metadata backend's AddApiMetadataFrom* call.
    string Name;

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

    /// Section label the TOC entry groups under, or null to keep it unsectioned.
    string? TocSectionLabel;

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