Bielu.Overlay.NET 2.0.1

Prefix Reserved
.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Bielu.Overlay.NET --version 2.0.1
                    


                    

                
NuGet\Install-Package Bielu.Overlay.NET -Version 2.0.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Bielu.Overlay.NET" Version="2.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Bielu.Overlay.NET" Version="2.0.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Bielu.Overlay.NET" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Bielu.Overlay.NET --version 2.0.1
                    


                    

                
#r "nuget: Bielu.Overlay.NET, 2.0.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Bielu.Overlay.NET@2.0.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Bielu.Overlay.NET&version=2.0.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Bielu.Overlay.NET&version=2.0.1
                    


                            Install as a Cake Tool

Bielu.Overlay.NET

Object model, validation and apply engine for the OpenAPI Overlay Specification — 1.0.0 and 1.1.0.

An overlay is a small document of ordered actions, each selecting nodes with an RFC 9535 JSONPath target and then update-ing, copy-ing or remove-ing them. It turns "strip the internal endpoints before publishing" from imperative code into a reviewable artifact.

Not just OpenAPI

The engine operates on System.Text.Json.Nodes.JsonNode and nothing else. It has no dependency on any object model, so it applies equally to OpenAPI, AsyncAPI, Arazzo, or any other JSON/YAML description. That is the point: every other implementation is bound to a single document type.

Installation

dotnet add package Bielu.Overlay.NET

Usage

var result = OverlayApplier.Apply(document, overlay, new OverlayApplyOptions { Strict = true });

JsonNode? transformed = result.Document;

Actions apply sequentially against the mutated tree, as the specification requires, and the merge/copy/remove semantics are gated on the version the overlay declares — 1.1.0 added copy, primitive targets and array concatenation, and a 1.0.0 document still gets 1.0.0 behaviour.

Verified against the OpenAPI Initiative's own conformance suite. To read overlay files, add Bielu.Overlay.NET.Readers.

Documentation

Feedback & Contributing

Copyright (c) 2025 Arkadiusz Biel. Released under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (3)

Showing the top 3 NuGet packages that depend on Bielu.Overlay.NET:

Package Downloads
Bielu.Overlay.NET.Readers

JSON and YAML readers for the OpenAPI Overlay Specification, producing Bielu.Overlay.NET documents with diagnostics.
Bielu.AspNetCore.AsyncApi.Overlay

Applies OpenAPI Overlays to AsyncAPI documents inside the generation pipeline, so the document served by MapAsyncApi() (and produced by build-time generation) is already transformed — no post-processing step and no second artifact to keep in sync.
Bielu.AspNetCore.Arazzo.Overlay

Applies OpenAPI Overlays to Arazzo workflow documents inside the generation pipeline, so the document served by MapArazzo() is already transformed — no post-processing step and no second artifact to keep in sync.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.1.0 72 11/4/2026
2.1.0-beta.20261104151236 58 11/4/2026
2.0.2 84 11/4/2026
2.0.2-beta.20261104133150 61 11/4/2026
2.0.2-beta.20261103095504 62 11/3/2026
2.0.1 111 11/3/2026
2.0.1-beta.20261103095358 67 11/3/2026
2.0.0 132 10/25/2026
2.0.0-beta.20261025083222 74 10/25/2026
2.0.0-beta.20261025073559 71 10/25/2026
2.0.0-beta.20261024233532 70 10/24/2026
2.0.0-beta.20261024230848 78 10/24/2026
2.0.0-beta.20261024191358 74 10/24/2026
2.0.0-beta.20261024185247 66 10/24/2026
2.0.0-beta.20261024184446 67 10/24/2026
2.0.0-beta.20261024163851 75 10/24/2026
2.0.0-beta.20261024153849 68 10/24/2026
2.0.0-beta.20261024142609 65 10/24/2026
2.0.0-beta.20261024142554 67 10/24/2026
2.0.0-beta.20261024140532 59 10/24/2026
Loading failed