CoreSystem.Idempotency.OpenApi 1.0.0

.NET 8.0

dotnet add package CoreSystem.Idempotency.OpenApi --version 1.0.0

NuGet\Install-Package CoreSystem.Idempotency.OpenApi -Version 1.0.0

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="CoreSystem.Idempotency.OpenApi" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="CoreSystem.Idempotency.OpenApi" Version="1.0.0" />
                    

                            Directory.Packages.props

<PackageReference Include="CoreSystem.Idempotency.OpenApi" />
                    

                            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 CoreSystem.Idempotency.OpenApi --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: CoreSystem.Idempotency.OpenApi, 1.0.0"

#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 CoreSystem.Idempotency.OpenApi@1.0.0

#: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=CoreSystem.Idempotency.OpenApi&version=1.0.0
                    

                            Install as a Cake Addin

#tool nuget:?package=CoreSystem.Idempotency.OpenApi&version=1.0.0
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

⚡ CoreSystem.Idempotency.OpenApi

OpenAPI/Swagger integration for CoreSystem.Idempotency that documents the Idempotency-Key header on idempotent operations.

OpenAPI/Swagger integration for CoreSystem.Idempotency. Documents the Idempotency-Key header on idempotent operations so consumers of your API discover the header from the generated spec.

✨ Features

✅ Adds the Idempotency-Key header parameter to operations whose HTTP method is configured as idempotent.
✅ Respects IdempotencyOptions.Enabled and AllowedMethods.
✅ Works with Swashbuckle (IOperationFilter).
✅ Multi-targets net8.0, net9.0 and net10.0.

📦 Installation

dotnet add package CoreSystem.Idempotency.OpenApi

🚀 Quick Start

builder.Services.AddSwaggerGen(options =>
{
    options.OperationFilter<IdempotencyHeaderOperationFilter>();
});

The filter resolves IOptions<IdempotencyOptions> from the service provider, so ensure idempotency is configured:

builder.Services.AddIdempotency(options =>
{
    options.Enabled = true;
});

🏗 Architecture

IdempotencyHeaderOperationFilter implements Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter. It inspects OperationFilterContext.ApiDescription.HttpMethod and, when the method is in AllowedMethods, appends an OpenApiParameter named Idempotency-Key (header, string/uuid) to the operation.

📚 Documentation

Full documentation site: https://federin.github.io/CoreSystem.Idempotency/
Core package: CoreSystem.Idempotency

🤝 Contributing

Contributions are welcome. Please open an issue or pull request.

📄 License

Released under the MIT License.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. 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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net10.0
- CoreSystem.Http (>= 1.2.0)
- CoreSystem.Idempotency (>= 2.1.1)
- CoreSystem.Observability.Abstractions (>= 1.1.0)
- CoreSystem.Serialization (>= 1.3.0)
- OpenTelemetry.Extensions.Hosting (>= 1.20.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 9.0.6)
net8.0
- CoreSystem.Http (>= 1.2.0)
- CoreSystem.Idempotency (>= 2.1.1)
- CoreSystem.Observability.Abstractions (>= 1.1.0)
- CoreSystem.Serialization (>= 1.3.0)
- OpenTelemetry.Extensions.Hosting (>= 1.20.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 9.0.6)
net9.0
- CoreSystem.Http (>= 1.2.0)
- CoreSystem.Idempotency (>= 2.1.1)
- CoreSystem.Observability.Abstractions (>= 1.1.0)
- CoreSystem.Serialization (>= 1.3.0)
- OpenTelemetry.Extensions.Hosting (>= 1.20.1)
- Swashbuckle.AspNetCore.SwaggerGen (>= 9.0.6)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.0	0	11/4/2026