Skip to content
Documentation

SwaggerGenOptionsExtensions Class

Provides extension methods for the generation of OpenAPI documentation about types in this module.

public static class SwaggerGenOptionsExtensions

Inheritance System.Object 🡒 SwaggerGenOptionsExtensions

SwaggerGenOptionsExtensions.AddOrderFilter<TResult>(this SwaggerGenOptions) Method

Section titled “SwaggerGenOptionsExtensions.AddOrderFilter<TResult>(this SwaggerGenOptions) Method”

Adds a Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter that properly documents query parameters of type Order<TResult>.

public static Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions AddOrderFilter<TResult>(this Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions options);

TResult

The type of data for which Order<TResult> parameters should be documented.

options Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions

The Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions to configure.

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions
The options for chaining of additional configuration.

SwaggerGenOptionsExtensions.AddRangeFilter<TResult>(this SwaggerGenOptions) Method

Section titled “SwaggerGenOptionsExtensions.AddRangeFilter<TResult>(this SwaggerGenOptions) Method”

Adds a Swashbuckle.AspNetCore.SwaggerGen.IOperationFilter that properly documents range headers.

public static Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions AddRangeFilter<TResult>(this Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions options);

TResult

The type of data for which Range<TResult> parameters should be documented.

options Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions

The Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions to configure.

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions
The options for chaining of additional configuration.

SwaggerGenOptionsExtensions.AddReferenceSchemaFilter(this SwaggerGenOptions) Method

Section titled “SwaggerGenOptionsExtensions.AddReferenceSchemaFilter(this SwaggerGenOptions) Method”

Adds a Swashbuckle.AspNetCore.SwaggerGen.ISchemaFilter that properly documents IReference in body and response.

public static Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions AddReferenceSchemaFilter(this Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions options);

options Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions

The Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions to configure.

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions
The options for chaining of additional configuration.

SwaggerGenOptionsExtensions.AddReferenceStorageInformationNullableSchemaFilter<TReference>(this SwaggerGenOptions) Method

Section titled “SwaggerGenOptionsExtensions.AddReferenceStorageInformationNullableSchemaFilter<TReference>(this SwaggerGenOptions) Method”

Adds a Swashbuckle.AspNetCore.SwaggerGen.ISchemaFilter that marks the StorageInformation property as nullable in the OpenAPI schema for implementations of IReference.

public static Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions AddReferenceStorageInformationNullableSchemaFilter<TReference>(this Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions options)
where TReference : HAKOM.Persistence.Core.Net.Api.References.IReference;

TReference

The type of reference implementation for which the storage information property should be marked as nullable.

options Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions

The Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions to configure.

Swashbuckle.AspNetCore.SwaggerGen.SwaggerGenOptions
The options for chaining of additional configuration.

This filter is useful when documenting API endpoints that return TReference instances where the StorageInformation property should be nullable in the OpenAPI specification.

The filter automatically unwraps Result<TValue> types to apply the schema modification to the wrapped reference type.

© 2026 Volue.Version v0.6.38017 November 2026