FlexQuery.NET.OpenApi 4.0.0-preview.2

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher.
This is a prerelease version of FlexQuery.NET.OpenApi.
There is a newer prerelease version of this package available.
See the version list below for details. 
dotnet add package FlexQuery.NET.OpenApi --version 4.0.0-preview.2
                    


                    

                
NuGet\Install-Package FlexQuery.NET.OpenApi -Version 4.0.0-preview.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="FlexQuery.NET.OpenApi" Version="4.0.0-preview.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="FlexQuery.NET.OpenApi" Version="4.0.0-preview.2" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="FlexQuery.NET.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 FlexQuery.NET.OpenApi --version 4.0.0-preview.2
                    


                    

                
#r "nuget: FlexQuery.NET.OpenApi, 4.0.0-preview.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 FlexQuery.NET.OpenApi@4.0.0-preview.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=FlexQuery.NET.OpenApi&version=4.0.0-preview.2&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=FlexQuery.NET.OpenApi&version=4.0.0-preview.2&prerelease
                    


                            Install as a Cake Tool

FlexQuery.NET.OpenApi

NuGet Version

OpenAPI/Swagger documentation and examples for FlexQuery.NET endpoints.

When to Use This Package

Install this package when you expose FlexQuery-enabled endpoints and want automatic OpenAPI schema descriptions, parameter documentation, and canonical request/response examples in your Swagger UI or OpenAPI document.

Installation

dotnet add package FlexQuery.NET.OpenApi

Registration

builder.Services.AddFlexQueryOpenApi();

This registers schema and operation transformers that enrich your OpenAPI document with:

  • Descriptions for all FlexQuery model types (FlexQueryRequest, FlexQueryParameters, QueryResult<T>, etc.)
  • Descriptions for query parameters (filter, select, sort, page, pageSize, includeCount)
  • Canonical, production-quality examples for FlexQueryRequest, FlexQueryParameters, and QueryResult<T>

Quick Start

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
builder.Services.AddFlexQueryOpenApi();

builder.Services.AddOpenApi(options =>
{
    options.AddFlexQuery();
});

var app = builder.Build();

app.MapOpenApi();
app.Run();

Features

  • Schema Descriptions — Human-readable descriptions for all FlexQuery model types (FlexQueryRequest, FlexQueryParameters, QueryResult<T>, FilterGroup, FilterCondition, SortNode, PagingOptions, AggregateModel, HavingCondition, IncludeNode, ProjectionMode, LogicOperator, AggregateFunction)
  • Parameter Documentation — Descriptions for query parameters (filter, select, sort, page, pageSize, includeCount)
  • Canonical Examples — Production-quality, strongly typed examples for FlexQueryRequest, FlexQueryParameters, and QueryResult<T> that immediately demonstrate FlexQuery capabilities
  • Zero Configuration — Single registration call, no options, no builders
  • Minimal Public API — Two extension methods, everything else internal

Documentation

Product Compatible and additional computed target framework versions.
.NET 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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

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
4.0.0-preview.3 43 7/18/2026
4.0.0-preview.2 51 7/14/2026
4.0.0-preview.1 51 7/12/2026

- chore(ci): remove azure-demo-api workflow
- refactor(options): introduce QueryGovernanceOptions as governance base
- Revert "merge feature branch docs-v4 to main branch (#9)"
- merge feature branch docs-v4 to main branch (#9)
- Merge branch 'main' into feature/docs-v4
- docs: update guide details
- docs: update readme file
- refactor: replace DSL symbolic logical operators with AND/OR keywords
- docs: unify example domain and restructure documentation
- docs: align v4 API references and fix broken doc links
- docs: added open api readme