API Reference Language: C# Component: AppSurface Docs Audience: developer

Models

Type

AppSurfaceDocsRouteInspectorResponse

Source

Redacted response for the AppSurface Docs route inspector HTML and JSON surfaces.

bool SourcePathIsMarkdown { get; init; } Source

RoutePath

string RoutePath { get; init; } Source

Gets the docs-root-relative alias route path.

Property

LiveUrl

string LiveUrl { get; init; } Source

Gets the app-relative live URL for the alias.

Property

Kind

string Kind { get; init; } Source

Gets the alias source category.

Remarks

Values currently include MarkdownSource and MarkdownSourceHtml for implicit source-shaped recovery aliases, and DeclaredRedirect for aliases declared by documentation metadata. Consumers should treat unknown values as alias categories from newer servers rather than as parse failures.

Type

AppSurfaceDocsRouteProbeResponse

Source

Explains how one requested route-inspector path resolves against the current route identity catalog.

Property

InputPath

string InputPath { get; init; } Source

DocPublicSectionCatalog

Source

Defines the canonical public-section labels, slugs, purpose copy, and alias lookup rules used by AppSurface Docs.

Method

GetLabel

string GetLabel(DocPublicSection section) Source

Gets the canonical display label for the specified public section.

Parameters

sectionThe section whose label should be returned.

Returns

The reader-facing label, such as Start Here or API Reference.

Method

GetSlug

string GetSlug(DocPublicSection section) Source

Gets the canonical stable route slug for the specified public section.

Parameters

sectionThe section whose slug should be returned.

Returns

A lower-case hyphenated slug suitable for {DocsRootPath}/sections/{slug} routes.

Method

GetPurpose

string GetPurpose(DocPublicSection section) Source

Gets the short purpose statement used to explain why a public section exists.

Parameters

sectionThe section whose purpose copy should be returned.

Returns

The summary text shown in section-first navigation surfaces.

Method

GetHref

2 overloads

string GetHref(DocPublicSection section) Source

Gets the default stable public route for the specified section.

Parameters

sectionThe section whose href should be returned.

Returns

The default /docs/sections/{slug} route for the section.

Remarks

This overload always roots the returned href at the default /docs surface. Callers that are rendering links on the current live surface should prefer GetHref(DocPublicSection, string) so custom route roots and preview roots are honored. The route slug is always produced by GetSlug(DocPublicSection).

string GetHref(DocPublicSection section, string docsRootPath) Source

Gets the canonical public-section route rooted at the caller's current docs surface.

Parameters

sectionThe section whose href should be returned.
docsRootPathThe pre-normalized, app-relative docs root path to anchor the section route under. Callers are expected to pass the validated live docs root from AppSurfaceDocsRoutingOptions.DocsRootPath or Services.DocsUrlBuilder.CurrentDocsRootPath, not an arbitrary or unvalidated value.

Returns

The canonical {docsRootPath}/sections/{slug} route for the section, or /sections/{slug} when docsRootPath is exactly /.

Remarks

This overload exists for mounted live docs surfaces such as /docs/next or root-mounted docs at /. It special-cases / so root-mounted hosts emit /sections/{slug} instead of //sections/{slug}. The slug portion is always derived from GetSlug(DocPublicSection). Passing a non-normalized value such as /docs/ can produce incorrect hard-coded links, so callers should normalize and validate docsRootPath before invoking this overload.

Method

TryResolve

bool TryResolve(string? value, out DocPublicSection section) Source

Resolves an authored section value using canonical labels, canonical slugs, or known aliases.

Parameters

valueThe authored value to resolve.
sectionWhen this method returns true, contains the resolved public section.

Returns

true when value matches a known label, slug, or alias after normalization; otherwise, false.

Remarks

Resolution is case-insensitive and ignores surrounding whitespace plus non-alphanumeric separators so values such as Start Here, start-here, and start_here all resolve to the same section.

Method

TryResolveSlug

bool TryResolveSlug(string? slug, out DocPublicSection section) Source

Resolves only canonical section-route slugs for /docs/sections/{slug} URLs.

Parameters

slugThe incoming route slug to resolve.
sectionWhen this method returns true, contains the resolved public section.

string NormalizeKey(string? value) Source

Normalizes authored section metadata so labels, slugs, and aliases can share one lookup table.

Parameters

valueThe authored value to normalize.

Returns

A lowercase alphanumeric key, or an empty string when value is blank.

Method

NormalizeSlug

string NormalizeSlug(string? value) Source

Normalizes an incoming section-route slug while preserving the canonical hyphenated slug contract.

Parameters

valueThe incoming route slug.

Returns

The trimmed lowercase slug, or an empty string when value is blank.

Property

OrderedSections

IReadOnlyList<DocPublicSection> OrderedSections { get; } Source

Gets the public sections in their intended presentation order for docs home and sidebar surfaces.

Type

Definition

Source

Describes one built-in public section, including its canonical display label, stable route slug, and accepted aliases.

Type

AppSurfaceDocsHarvestHealthResponse

Source

Redacted operator-facing AppSurface Docs harvest health response shared by the HTML and JSON health surfaces.

Remarks

This contract intentionally omits repository roots, raw exception messages, stack traces, and other host-local details. Diagnostic cause text is centrally redacted to repository-relative, operator-safe evidence before it reaches this response. Use DocAggregator.GetHarvestHealthAsync(System.Threading.CancellationToken) for server-side inspection when trusted code needs the full snapshot.

Method

FromSnapshot

AppSurfaceDocsHarvestHealthResponse FromSnapshot(DocHarvestHealthSnapshot health) Source

Creates a redacted response from the full server-side harvest health snapshot.

Parameters

healthThe server-side harvest health snapshot.

AppSurfaceDocsHarvestRebuildForm? RebuildForm { get; init; } Source

Gets the trusted operator rebuild form metadata used by the HTML health page.

string Problem { get; init; } Source

Gets the operator-facing problem statement.

Property

Cause

string Cause { get; init; } Source

Gets the operator-facing, redacted explanation for why AppSurface Docs reported the diagnostic.

Remarks

This field carries repository-relative evidence or general recovery context. Response mapping centrally redacts raw host-local exception messages, absolute filesystem paths, stack traces, tokens, and other machine-local details before serialization.

Property

Fix

string Fix { get; init; } Source

Gets the suggested operator or docs-author recovery action.

Type

SearchPageViewModel

Source

Describes the server-rendered shell for the dedicated docs search workspace.

Parameters

TitleThe primary page heading shown above the workspace controls.
OrientationA short orientation sentence that explains what users can discover from the workspace.
StarterHintHelper copy shown in the starter state before a query or filter is applied.
SearchPlaceholderPlaceholder text for the advanced search input.
SuggestedQueriesStarter-state suggestions rendered as query-string anchors and enhanced by JavaScript when the search runtime is available. Empty lists are allowed, but the shell is designed around a curated set of useful first queries.
FailureFallbackLinksOrdered server-derived browse links shown before the search runtime loads and preserved when the runtime or index cannot be loaded. Include at least one non-search path that still helps users continue through the docs set.

Remarks

This model is rendered before the client-side search index is available so the page can show stable loading, starter, browse-recovery, and failure states even when the search payload is slow or unavailable. All members are required and should be supplied as non-null values. The list properties render in the order provided. Use SearchPageViewModel for the server-rendered shell contract and recovery guidance, not for live search results or client-side facet state. Callers should prefer empty lists over null for SuggestedQueries and FailureFallbackLinks. Suggested queries render as real search-state anchors before JavaScript and may be enhanced by the client runtime. Fallback links render as the shared server-derived browse navigation used both before the index loads and after an index-load failure, not as server-side search results. The search surface may combine representative docs selected from the current snapshot with static route-contract-backed recovery entries such as public section routes and docs home. Both lists are displayed in the supplied order, so place the highest-signal actions first. Avoid relying on client-side mutation of this model after render, and avoid using external absolute URLs in SearchPageFallbackLink.Href because the shell assumes app-relative navigation semantics.

Type

SearchPageFallbackLink

Source

Represents one server-rendered browse recovery action for the dedicated docs search workspace.

Parameters

TitleShort, action-oriented label used as the visible link title.
HrefThe app-relative destination URL to open when the user follows the recovery action.
DescriptionSupporting context that explains what the destination contains and why it helps recover from the failed search flow.
UsesDocsFrameA value indicating whether the destination should stay inside the docs content frame. Set this to true only when the destination is known to be another docs page rather than a top-level recovery surface such as the docs home or version archive.

Remarks

These links are rendered before the client search payload is available and remain useful after index-fetch failure, so each entry should be complete enough to stand on its own. They are navigation aids, not server-side search results. Some entries may be adapted from neutral harvest-free docs recovery links; search-only representative document fallback should stay in this type rather than moving into the standalone 404 page. UsesDocsFrame determines whether the destination should continue navigating inside the docs content frame or escalate to a top-level page navigation. Keep Href app-relative and already URL-safe, and assume the UI will HTML-escape the visible text in Title and Description. Prefer concise copy that fits comfortably in a compact recovery card, and do not depend on client search indexing to make the destination discoverable.

Type

DocPageTypeBadgePresentation

Source

Presentation metadata for one normalized documentation page-type badge.

Property

Value

string Value { get; init; } Source

Gets the normalized machine-readable page-type value.

Property

Label

string Label { get; init; } Source

Gets the human-readable badge label.

Property

Variant

string Variant { get; init; } Source

Gets the badge variant suffix used by built-in AppSurface Docs CSS classes such as docs-page-badge--guide.

Type

DocMetadataPresentation

Source

valueRaw metadata token that may contain whitespace, underscores, dashes, or line breaks.

Returns

A normalized token, or null when value is null, whitespace, or produces no non-delimiter segments after trimming and splitting.

Remarks

AppSurface Docs trims the input, splits on spaces, tabs, carriage returns, line feeds, underscores, and hyphens, removes empty segments, lowercases each remaining segment, and rejoins them with -.

Type

DocsRecoveryLink

Source

Describes one route-contract-backed recovery link for browser-facing docs recovery surfaces.

Parameters

TitleShort visible label for the recovery action.
HrefApp-relative, route-contract-backed destination.
DescriptionShort explanation of why the destination helps the reader recover.
KindPresentation hint used to distinguish the primary action from secondary browse links.
IgnoreDuringStaticExportA value indicating whether static exporters may ignore this href when validating or crawling the containing page. Use this for optional recovery links that are helpful at runtime but should not force sparse exports to include additional pages.

Remarks

These links are intentionally harvest-free: callers can render them before a docs snapshot exists, during search index failure, or from a standalone browser status page. The href is produced from DocsUrlBuilder rather than from the missing request path, so stale or hostile paths never influence the recovery destination. Search-specific callers should keep using SearchPageFallbackLink for search workspace behavior and adapt these neutral links only when they need static entry points.

Enum

DocsRecoveryLinkKind

Source

Identifies how a neutral docs recovery link should be visually emphasized.

Remarks

The enum is deliberately small because it is not a navigation taxonomy. Recovery surfaces should use Primary for the one safest next step and Secondary for the small set of route-safe browse alternatives.

Type

AppSurfaceDocsHarvestingViewModel

Source

View model for the AppSurface Docs live harvest observatory.

Property

Progress

AppSurfaceDocsHarvestProgressSnapshot Progress { get; init; } Source

Gets the current redacted harvest progress snapshot rendered by the observatory.

Property

ReturnUrl

string ReturnUrl { get; init; } Source

Gets the app-relative URL the browser should open after harvest completion.

Remarks

Controllers must validate this value with DocsController.IsSafeAppRelativeUrl before assigning request-derived input. The harvesting Razor view emits this value only through Razor-encoded attributes and links; raw progress fragments do not receive it.

Property

CompletionNavigationDelayMilliseconds

int CompletionNavigationDelayMilliseconds { get; init; } Source

AppSurfaceDocsVersionArchiveViewModel

Source

View model for the public AppSurface Docs version archive and degraded entry surface.

string? AvailabilityMessage { get; init; } Source

Gets optional explanatory copy shown when the stable route-root alias cannot mount a recommended released tree.

Remarks

This is typically null on the dedicated archive page and populated only for the degraded route-root recovery experience.

Property

PreviewHref

string PreviewHref { get; init; } Source

Gets the live preview docs URL.

Remarks

This points at the configured source-backed preview surface, such as /docs/next for the default route family or /foo/bar/next for a custom one.

Property

VersionsHref

string VersionsHref { get; init; } Source

Gets the stable archive URL.

Property

Versions

IReadOnlyList<AppSurfaceDocsVersionArchiveEntryViewModel> Versions { get; init; } Source

Gets the available published versions shown in the archive.

Type

AppSurfaceDocsVersionArchiveEntryViewModel

Source

Represents one release entry in the public AppSurface Docs version archive.

string? Href { get; init; } Source

Gets the exact-version URL when the release is available.

string? AdvisoryLabel { get; init; } Source

Gets the human-readable advisory label when a release warning should be surfaced.

Remarks

This is null when no release-level warning badge should be rendered.

Property

AvailabilityMessage

string? AvailabilityMessage { get; init; } Source

Gets the availability explanation when the release tree is unavailable.

string? Component { get; init; } Source

Gets the product component associated with the page.

Property

CodeLanguage

string? CodeLanguage { get; init; } Source

Gets the programming or source language for generated code documentation.

Remarks

This value describes extracted API documentation such as C# namespace pages or JavaScript runtime doclets. It is intentionally separate from Localization and from Markdown code-fence language tokens, because those describe reader locale and inline example highlighting rather than the source language of the documented API.

Property

Namespace

string? Namespace { get; init; } Source

Gets the generated namespace page that namespace-intro source content should merge into.

string? SequenceKey { get; init; } Source

Gets the explicit sequence identifier used to connect pages into one proof path.

Localization

DocLocalizationMetadata? Localization { get; init; } Source

Gets optional localization metadata used to connect translated variants of the same conceptual document.

Authors can provide this metadata directly under localization, or with friendly flat front matter keys such as locale, translation_key, localized_title, and locale_fallback. The metadata does not make a page public on its own; the locale-aware document graph combines it with configured locales and route identity.

Method

Merge

DocLocalizationMetadata? Merge(DocLocalizationMetadata? primary, DocLocalizationMetadata? fallback) Source

Merges primary and fallback localization metadata using the same precedence rules as document metadata overlays.

int Level { get; init; } Source

Gets the normalized heading level for this entry.

Type

DocOutlineMetadata

Source

Markdown page-local outline behavior supplied through front matter or paired sidecar metadata.

Remarks

MaxHeadingLevel accepts 2 or 3 and has precedence over RepeatedHeadingPolicy. RepeatedHeadingPolicy accepts auto, include, or h2_only. Invalid authored values are normalized away by the Markdown metadata parser so a paired fallback can still contribute the valid child field.

Method

Merge

DocOutlineMetadata? Merge(DocOutlineMetadata? primary, DocOutlineMetadata? fallback) Source

Merges page outline metadata from a primary source and a fallback source.

Parameters

primaryThe preferred outline metadata. When this value is null, the fallback value is returned.
fallbackThe fallback outline metadata. When this value is null, the primary value is returned.

Returns

The merged outline metadata, or null when both merged properties collapse to null.

DocTrustLink? Migration { get; init; } Source

Gets an optional safe browser-facing link to migration or upgrade guidance.

Remarks

Markdown metadata normalization treats blank hrefs as absent and rejects nonblank values whose scheme is not relative, root-relative, fragment-only, http, or https. Rejected hrefs are omitted and reported through harvest diagnostics with DocHarvestDiagnosticCodes.MetadataUnsafeTrustMigrationHref.

Property

Sources

IReadOnlyList<string>? Sources { get; init; } Source

Gets optional provenance notes or upstream sources that support the page.

Type

DocTrustLink

Source

Link metadata used by trust-bar actions such as migration guidance.

Property

Label

string? Label { get; init; } Source

Gets the reader-facing link label.

Property

Href

string? Href { get; init; } Source

Gets the browser-facing destination URL.

Remarks

For trust migration links authored in Markdown front matter or paired sidecar metadata, AppSurface Docs accepts relative URLs, root-relative URLs, fragment links, and absolute http or https URLs. Blank hrefs are treated as missing; executable, protocol-relative, control-character, and other absolute-scheme hrefs are rejected before the trust bar renders.

Type

DocContributorMetadata

Source

Page-level contributor provenance metadata used to override or suppress source, edit, and freshness evidence.

Method

Merge

DocContributorMetadata? Merge(DocContributorMetadata? primary, DocContributorMetadata? fallback) Source

Merges contributor metadata by preferring authored primary values and filling missing values from fallback metadata.

Remarks

Precedence rules:

HideContributorInfo uses nullable-boolean precedence, so explicit false is preserved.
SourcePathOverride, SourceUrlOverride, and EditUrlOverride prefer the first non-blank string; whitespace-only values are treated as missing.
LastUpdatedOverride uses null coalescing and therefore keeps the primary timestamp when present.

Pitfalls:

Setting a string override to the empty string does not clear a fallback value; it falls back instead.
Callers that need to suppress inherited contributor rendering should use HideContributorInfo instead of relying on blank string overrides.

Parameters

TitleThe display title of the document.
PathThe relative path to the documentation source.
ContentThe rendered HTML content of the documentation.
ParentPathThe optional parent path for hierarchical organization.
IsDirectoryIndicates if this node represents a directory container.
CanonicalPathThe browser-facing docs route path used for linking and lookup.
MetadataStructured metadata associated with the documentation node.
OutlineStructured in-page outline entries captured during harvesting.
SymbolSourceProvenanceOptional source declarations keyed by rendered C# API symbol anchor IDs.

Type

DocHarvestHealthSnapshot

Source

Captures the structured health of one AppSurface Docs harvest snapshot.

Parameters

StatusOverall health rollup for the snapshot.
GeneratedUtcUTC timestamp when the snapshot was generated.
RepositoryRootRepository root passed to active harvesters. Treat this as server-only operational data because it can contain sensitive or environment-specific filesystem paths; redact or omit it before sending snapshots to clients.
TotalHarvestersNumber of active harvesters that participated in strict aggregate health for the snapshot.
SuccessfulHarvestersNumber of strict-health harvesters that completed with either docs or a valid empty result.
FailedHarvestersNumber of strict-health harvesters that failed, timed out, or canceled.
TotalDocsNumber of documentation nodes published by the final cached docs snapshot.
HarvestersPer-harvester health entries. Never null in AppSurface Docs-created snapshots.
DiagnosticsStructured diagnostics for failed, degraded, or noteworthy states. Never null in AppSurface Docs-created snapshots.

Property

Intent

string? Intent { get; init; } Source

Gets the stable reader-intent identifier for the group.

Remarks

Authors may omit this value when Label is present. AppSurface Docs derives a normalized intent from the label during metadata parsing so downstream resolvers can still identify the group consistently.

Property

Label

string? Label { get; init; } Source

Gets the reader-facing group heading.

string? SourceFieldPath { get; init; } Source

Gets the parser-populated metadata field path for group-level diagnostics.

Remarks

This internal value is for diagnostics and source attribution only. Authored metadata and consumers should not depend on it as stable content because the parser path format may change.

Type

DocFeaturedPageDefinition

Source

Defines one authored featured-page entry for a docs landing surface.

Property

Question

string? Question { get; init; } Source

Gets the reader-facing evaluator question or label for the card.

Remarks

When this value is omitted on the built-in docs landing, AppSurface Docs falls back to the resolved destination page title so the card still renders with a sensible label.

Property

Path

string? Path { get; init; } Source

Gets the source or canonical path of the destination page to feature.

string? SourceFieldPath { get; init; } Source

Gets the parser-populated metadata field path for page-level diagnostics.

Source

View model for one resolved reader-intent group on a docs landing page.

DocSidebarHarvestHealthViewModel? HarvestHealth { get; init; } Source

Gets the legacy harvest health sidebar entry when the current host should show health chrome.

Remarks

Prefer Diagnostics for built-in sidebar rendering. This property remains available for callers that inspect the component model directly and need the pre-diagnostics health status shape.

Type

DocSidebarDiagnosticsViewModel

Source

View model for the AppSurface Docs maintainer diagnostics sidebar disclosure.

IReadOnlyList<DocSidebarDiagnosticsToolViewModel> Tools { get; init; } Source

Gets the maintainer tools currently available from the diagnostics disclosure.

Remarks

Defaults to an empty list. A diagnostics disclosure can still be meaningful with no tools when Status carries a health summary, but built-in rendering normally omits the disclosure when both Status is null and this list is empty. Tool membership is environment- and option-dependent; do not infer that a missing tool means the underlying route is absent in every host.

Type

DocSidebarDiagnosticsStatusViewModel

Source

View model for the diagnostics disclosure status badge.

Remarks

Use the status badge for a compact aggregate state such as Healthy, Degraded, or Health unavailable. Label defaults to an empty string so callers that construct the model manually should provide a reader-facing label. Ok is a presentation hint for pass/fail styling only; it does not expose route availability or permission state. The badge should be derived from the same snapshot used for any harvest-health tool row so concurrent harvest refreshes do not show mismatched status and tool summaries.

Property

Label

string Label { get; init; } Source

Gets the status text shown in the compact badge.

Property

Ok

bool Ok { get; init; } Source

Gets a value indicating whether the status should pass local or CI verification.

Type

DocSidebarDiagnosticsToolViewModel

Source

View model for one maintainer diagnostics destination in the sidebar disclosure.

Remarks

A tool row can be linked or status-only. Set Href to an app-relative URL such as /docs/_health or /docs/_routes only when the corresponding route is exposed for the current environment and options. Leave Href null when chrome is visible but the route should not be advertised, or when a fallback row such as Health unavailable has no destination. JsonAction is optional and should be present only when there is a secondary machine-readable route paired with the human HTML destination. Do not use the presence of chrome alone as an authorization signal; route exposure is resolved independently and can differ between development, production, and explicit configuration.

Property

Label

string Label { get; init; } Source

Gets the human-readable tool label.

Property

Href

string? Href { get; init; } Source

Gets the app-relative HTML destination when the tool route is exposed; otherwise null for a status-only row.

Property

Summary

string? Summary { get; init; } Source

Gets optional supporting text for the tool row.

Property

JsonAction

DocSidebarDiagnosticsActionViewModel? JsonAction { get; init; } Source

Gets the optional secondary JSON action for automation-oriented diagnostics.

Type

DocSidebarDiagnosticsActionViewModel

Source

View model for a secondary diagnostics action.

string CanonicalUrl { get; init; } Source

Gets the app-relative canonical URL for the current details page.

bool IsApiSurfaceDoc { get; init; } Source

Gets a value indicating whether the page should use the API reference reading surface.

string? CodeLanguage { get; init; } Source

Gets the normalized programming language value shown and filtered by generated API documentation surfaces.

Remarks

Values are stable programmatic identifiers such as csharp or javascript. A null value means the source language is unknown or not applicable, and callers should treat blank values the same way. Use this property for matching, indexing, URL filters, and other machine-readable behavior; use CodeLanguageLabel for reader-facing UI. Do not match on the label, because labels may contain punctuation, casing, or future localization choices that are not part of the canonical metadata contract.

Property

CodeLanguageLabel

string? CodeLanguageLabel { get; init; } Source

Gets the reader-facing programming language label shown for generated API documentation.

Task<IReadOnlyList<DocNode>> HarvestAsync(string rootPath, CancellationToken cancellationToken = default) Source

Asynchronously scans the specified root path and returns a collection of documentation nodes harvested from sources under that path.

Parameters

rootPathThe filesystem root path to scan for documentation sources.
cancellationTokenAn optional token to observe for cancellation requests.

Returns

A collection of DocNode representing the harvested documentation.

Enum

DocHarvestHealthStatus

Source

Property

Summary

DocHarvestFailureSummary Summary { get; } Source

Gets the redacted strict-harvest failure summary.

Type

DocHarvestFailureSummary

Source

Redacted strict-harvest failure summary safe for public exception messages and export output.

Parameters

StatusThe aggregate harvest-health status that triggered strict failure.
GeneratedUtcThe timestamp for the cached harvest snapshot generation.
TotalHarvestersNumber of active harvesters that participated in strict aggregate health for the failed snapshot.
SuccessfulHarvestersNumber of strict-health harvesters that completed with docs or an intentional empty result.
FailedHarvestersNumber of strict-health harvesters that failed, timed out, or canceled.
TotalDocsNumber of final docs in the failed snapshot.
DiagnosticsRedacted diagnostic entries copied from the failed snapshot.

Method

FromSnapshot

DocHarvestFailureSummary FromSnapshot(DocHarvestHealthSnapshot health) Source

Creates a redacted strict-harvest failure summary from a harvest-health snapshot.

Parameters

healthThe harvest-health snapshot to summarize.

Returns

A redacted summary that omits repository roots, raw exception details, and diagnostic cause text.

Type

DocHarvestFailureDiagnostic

Source

Redacted strict-harvest diagnostic safe for public exception messages and export output.

Parameters

CodeStable diagnostic code for machine-readable branching and tests.
SeverityDiagnostic severity copied from the source diagnostic.
HarvesterTypeConcrete harvester type when the diagnostic belongs to one harvester.
ProblemOperator-facing problem statement.
FixSuggested recovery action.

Method

FromDiagnostic

DocHarvestFailureDiagnostic FromDiagnostic(DocHarvestDiagnostic diagnostic) Source

Creates a redacted strict-harvest diagnostic from a harvest-health diagnostic.

Parameters

diagnosticThe source diagnostic to redact.

Returns

A diagnostic that omits cause text and raw exception details.