RsqlParserNet.Swashbuckle 1.0.3

.NET 10.0

dotnet add package RsqlParserNet.Swashbuckle --version 1.0.3

NuGet\Install-Package RsqlParserNet.Swashbuckle -Version 1.0.3

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="RsqlParserNet.Swashbuckle" Version="1.0.3" />

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

<PackageVersion Include="RsqlParserNet.Swashbuckle" Version="1.0.3" />
                    

                            Directory.Packages.props

<PackageReference Include="RsqlParserNet.Swashbuckle" />
                    

                            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 RsqlParserNet.Swashbuckle --version 1.0.3

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

#r "nuget: RsqlParserNet.Swashbuckle, 1.0.3"

#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 RsqlParserNet.Swashbuckle@1.0.3

#: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=RsqlParserNet.Swashbuckle&version=1.0.3
                    

                            Install as a Cake Addin

#tool nuget:?package=RsqlParserNet.Swashbuckle&version=1.0.3
                    

                            Install as a Cake Tool

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

RsqlParserNet.Swashbuckle

Swashbuckle (SwaggerGen) operation filters that document the filter, sort, page, and pageSize query parameters in generated OpenAPI documents. Builds on RsqlParserNet.AspNetCore.

Family

Part of the RsqlParserNet family. It documents the query contract bound by RsqlParserNet.AspNetCore, which in turn builds on the RsqlParserNet core parser. Use RsqlParserNet.OpenApi instead when your application uses ASP.NET Core's built-in OpenAPI document generation, or RsqlParserNet.NSwag when it generates documents through NSwag.

Installation

dotnet add package RsqlParserNet.Swashbuckle

Quick start

using RsqlParserNet.Swashbuckle;

builder.Services.AddSwaggerGen(options =>
{
    options.AddRsqlQueryParametersOperationFilter();
});

app.MapGet("/products", HandleProducts)
    .WithRsqlSwaggerQueryParameters();

This documents filter, sort, page, and pageSize as optional query parameters on the marked endpoint.

Custom parameter names and partial contracts are configured per endpoint. Keep names aligned with your AddRsqlQueryRequest(...) options:

app.MapGet("/products/search", HandleSearch)
    .WithRsqlSwaggerQueryParameters(options =>
    {
        options.FilterParameterName = "q";
        options.SortParameterName = "orderBy";
        options.IncludeSort = false;
        options.IncludePagination = false;
    });

For small APIs where every list endpoint shares the same contract, document all operations at once instead of marking each endpoint:

builder.Services.AddSwaggerGen(options =>
{
    options.AddRsqlQueryParametersToAllOperations();
});

Endpoint-scoped documentation is the safer default for larger APIs because it avoids advertising query parameters on endpoints that do not accept them.

API

Member	Kind	Description
`RsqlSwaggerGenOptionsExtensions.AddRsqlQueryParametersOperationFilter(this SwaggerGenOptions)`	Extension method	Registers the operation filter that documents only endpoints marked with `WithRsqlSwaggerQueryParameters()`.
`RsqlSwaggerGenOptionsExtensions.AddRsqlQueryParametersToAllOperations(this SwaggerGenOptions, Action<RsqlOpenApiQueryOptions>?)`	Extension method	Registers the operation filter that documents RSQL query parameters on every operation, with optional shared configuration.
`RsqlSwaggerEndpointConventionBuilderExtensions.WithRsqlSwaggerQueryParameters<TBuilder>(this TBuilder, Action<RsqlOpenApiQueryOptions>?)`	Extension method	Marks an endpoint so the scoped operation filter documents its query parameters, with optional per-endpoint configuration.
`RsqlSwaggerQueryParametersOperationFilter`	`IOperationFilter`	Documents query parameters for operations carrying `RsqlSwaggerQueryMetadata`.
`RsqlSwaggerAllQueryParametersOperationFilter`	`IOperationFilter`	Documents query parameters on every generated operation.
`RsqlSwaggerQueryMetadata`	Endpoint metadata record	Carries the per-endpoint `RsqlOpenApiQueryOptions` attached by `WithRsqlSwaggerQueryParameters()`.

Configuration is shared with RsqlParserNet.OpenApi through RsqlOpenApiQueryOptions: IncludeFilter, IncludeSort, IncludePagination, the *ParameterName properties, and the *Description properties.

Documentation

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.

net10.0
- RsqlParserNet.OpenApi (>= 1.0.3)
- Swashbuckle.AspNetCore.SwaggerGen (>= 10.0.1)

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.3	106	6/16/2026
1.0.2	105	5/23/2026
1.0.1	105	5/18/2026
1.0.0	104	5/10/2026
0.3.0-preview.1	54	5/6/2026
0.2.0-preview.1	125	5/5/2026

Maintenance release aligning the RsqlParserNet package family at 1.0.3 and adding a dedicated package README.