Class ReferenceDocsSurface
Namespace: Cephalon.AspNetCore.Documentation
Assembly: Cephalon.AspNetCore.dll
Describes the operator-facing HTTP surface for hosted Cephalon reference documentation.
public sealed record ReferenceDocsSurface : IEquatable<ReferenceDocsSurface>Inheritance
Section titled “Inheritance”Implements
Section titled “Implements”IEquatable<ReferenceDocsSurface>
Inherited Members
Section titled “Inherited Members”object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object?, object?), object.ToString()
Constructors
Section titled “Constructors”ReferenceDocsSurface(bool, bool, string, string, string, string, string, string, string, string, string)
Section titled “ ReferenceDocsSurface(bool, bool, string, string, string, string, string, string, string, string, string)”Describes the operator-facing HTTP surface for hosted Cephalon reference documentation.
public ReferenceDocsSurface(bool Enabled, bool Available, string RoutePrefix, string DefaultDocument, string DefaultDocumentPath, string ReadmePath, string BrowserPath, string NamespaceIndexPath, string TypeIndexPath, string MemberIndexPath, string ManifestPath)Parameters
Section titled “Parameters”Enabled bool
Whether reference-doc hosting is enabled for the current host.
Available bool
Whether the configured documentation directory and default document were found and mapped.
RoutePrefix string
The route prefix where the documentation is served.
DefaultDocument string
The document opened when the route prefix is requested.
DefaultDocumentPath string
The hosted path to the configured default document.
ReadmePath string
The hosted path to the reference-doc landing page.
BrowserPath string
The hosted path to the interactive browser UI.
NamespaceIndexPath string
The hosted path to the namespace index.
TypeIndexPath string
The hosted path to the type index.
MemberIndexPath string
The hosted path to the member index.
ManifestPath string
The hosted path to the machine-readable manifest.
Properties
Section titled “Properties”Available
Section titled “ Available”Whether the configured documentation directory and default document were found and mapped.
public bool Available { get; init; }Property Value
Section titled “Property Value”BrowserPath
Section titled “ BrowserPath”The hosted path to the interactive browser UI.
public string BrowserPath { get; init; }Property Value
Section titled “Property Value”DefaultDocument
Section titled “ DefaultDocument”The document opened when the route prefix is requested.
public string DefaultDocument { get; init; }Property Value
Section titled “Property Value”DefaultDocumentPath
Section titled “ DefaultDocumentPath”The hosted path to the configured default document.
public string DefaultDocumentPath { get; init; }Property Value
Section titled “Property Value”Enabled
Section titled “ Enabled”Whether reference-doc hosting is enabled for the current host.
public bool Enabled { get; init; }Property Value
Section titled “Property Value”ManifestPath
Section titled “ ManifestPath”The hosted path to the machine-readable manifest.
public string ManifestPath { get; init; }Property Value
Section titled “Property Value”MemberIndexPath
Section titled “ MemberIndexPath”The hosted path to the member index.
public string MemberIndexPath { get; init; }Property Value
Section titled “Property Value”NamespaceIndexPath
Section titled “ NamespaceIndexPath”The hosted path to the namespace index.
public string NamespaceIndexPath { get; init; }Property Value
Section titled “Property Value”ReadmePath
Section titled “ ReadmePath”The hosted path to the reference-doc landing page.
public string ReadmePath { get; init; }Property Value
Section titled “Property Value”RoutePrefix
Section titled “ RoutePrefix”The route prefix where the documentation is served.
public string RoutePrefix { get; init; }Property Value
Section titled “Property Value”TypeIndexPath
Section titled “ TypeIndexPath”The hosted path to the type index.
public string TypeIndexPath { get; init; }