Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

YamlPatchReport

OfficeIMO.Yaml

Namespace
OfficeIMO.Yaml
Assembly
OfficeIMO.Yaml
Source revision
ba882f6b0d07 with working tree changes
Modifiers
sealed

What a JSON Patch or JSON Merge Patch changed in a document, as paths in the grammar YamlNode.Select reads, plus the findings the edits recorded, such as edits of nodes that aliases share.

Inheritance

  • object
  • YamlPatchReport

Usage

Explore 2 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 2

Properties

public IReadOnlyList<string> Added { get; } #

Gets the paths of entries, items and documents the patch added, in the order they were added: add, copy and the target of move where nothing was, and new keys of a merge patch.

public IReadOnlyList<string> Replaced { get; } #

Gets the paths whose value the patch changed: replace, and add, copy or move onto an existing key. A merge patch lists only values that differ from the patch.

public IReadOnlyList<string> Removed { get; } #

Gets the paths the patch removed: remove, the source of move, and merge patch nulls.

public IReadOnlyList<OfficeDiagnostic> Diagnostics { get; } #

Gets the findings the patch recorded; they are also added to the document's YamlDocument.Diagnostics.