Bielu.AspNetCore.AsyncApi.Overlay 2.0.2

Prefix Reserved
There is a newer version of this package available.
See the version list below for details.
dotnet add package Bielu.AspNetCore.AsyncApi.Overlay --version 2.0.2
                    
NuGet\Install-Package Bielu.AspNetCore.AsyncApi.Overlay -Version 2.0.2
                    
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.AspNetCore.AsyncApi.Overlay" Version="2.0.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Bielu.AspNetCore.AsyncApi.Overlay" Version="2.0.2" />
                    
Directory.Packages.props
<PackageReference Include="Bielu.AspNetCore.AsyncApi.Overlay" />
                    
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.AspNetCore.AsyncApi.Overlay --version 2.0.2
                    
#r "nuget: Bielu.AspNetCore.AsyncApi.Overlay, 2.0.2"
                    
#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.AspNetCore.AsyncApi.Overlay@2.0.2
                    
#: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.AspNetCore.AsyncApi.Overlay&version=2.0.2
                    
Install as a Cake Addin
#tool nuget:?package=Bielu.AspNetCore.AsyncApi.Overlay&version=2.0.2
                    
Install as a Cake Tool

Bielu.AspNetCore.AsyncApi.Overlay

Applies OpenAPI Overlays to your AsyncAPI document inside the generation pipeline, so the document served from /asyncapi/{documentName}.json is already transformed. No build step, and no second artifact to keep in sync.

An overlay is a small, reviewable JSON/YAML file of ordered actions that select nodes by JSONPath and then update, copy or remove them — the declarative alternative to writing transformation code in C#.

Installation

dotnet add package Bielu.AspNetCore.AsyncApi.Overlay

Usage

builder.Services.AddAsyncApi("v1", options =>
{
    options.AddOverlay("overlays/public.yaml");     // applied in declaration order
    options.ConfigureOverlays(o => o.Strict = true); // a zero-match target becomes an error
});

Overlays apply at both production points — the runtime endpoint (JSON and YAML) and build-time generation — so a checked-in document and the served one can never disagree about whether the overlay ran. Overlay files are resolved lazily and cached, so a missing file cannot break startup, and a failure surfaces as an error rather than a silently untransformed document.

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 (1)

Showing the top 1 NuGet packages that depend on Bielu.AspNetCore.AsyncApi.Overlay:

Package Downloads
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 50 11/4/2026
2.1.0-beta.20261104151236 49 11/4/2026
2.0.2 51 11/4/2026
2.0.2-beta.20261104133150 48 11/4/2026
2.0.2-beta.20261103095504 54 11/3/2026
2.0.1 92 11/3/2026
2.0.1-beta.20261103095358 48 11/3/2026
2.0.0 108 10/25/2026
2.0.0-beta.20261025083222 67 10/25/2026
2.0.0-beta.20261025073559 60 10/25/2026
2.0.0-beta.20261024233532 66 10/24/2026
2.0.0-beta.20261024230848 65 10/24/2026
2.0.0-beta.20261024191358 64 10/24/2026
2.0.0-beta.20261024185247 62 10/24/2026
2.0.0-beta.20261024184446 60 10/24/2026
2.0.0-beta.20261024163851 70 10/24/2026
2.0.0-beta.20261024153849 63 10/24/2026
2.0.0-beta.20261024142609 60 10/24/2026
2.0.0-beta.20261024142554 58 10/24/2026
2.0.0-beta.20261024140532 59 10/24/2026
Loading failed