Skip to content

docs: Add Swashbuckle.AspNetCore v10 upgrade section to v10.1 migration guide#24962

Merged
EngincanV merged 2 commits intorel-10.1from
copilot/update-migration-guide-v10-1
Feb 26, 2026
Merged

docs: Add Swashbuckle.AspNetCore v10 upgrade section to v10.1 migration guide#24962
EngincanV merged 2 commits intorel-10.1from
copilot/update-migration-guide-v10-1

Conversation

Copy link
Contributor

Copilot AI commented Feb 26, 2026

ABP v10.1 upgraded Swashbuckle.AspNetCore to v10, which pulls in Microsoft.OpenApi v2.x — a breaking change for any app with custom Swagger filters, schema customizations, or security requirements.

Changes

  • Added "Swashbuckle.AspNetCore Upgraded to v10" section to the v10.1 migration guide under the Open-Source (Framework) heading.

Documented required migration actions:

  • Add using Microsoft.OpenApi; — interfaces (e.g. IOpenApiSchema) moved there; concrete types (e.g. OpenApiSchema) stay in Microsoft.OpenApi.Models
  • Update filter signatures to use interfaces; cast to concrete type to mutate properties:
    public void Apply(IOpenApiSchema schema, SchemaFilterContext context)
    {
        if (schema is OpenApiSchema openApiSchema)
            openApiSchema.Type = JsonSchemaType.String;
    }
  • Replace string-based OpenApiSchema.Type with JsonSchemaType flags enum
  • Replace OpenApiSchema.Nullable with schema.Type |= JsonSchemaType.Null
  • Update .Reference properties to new *Reference classes (e.g. OpenApiSchemaReference)
  • Update AddSecurityRequirement() to accept Func<OpenApiDocument, OpenApiSecurityRequirement>
  • Links to the official Swashbuckle v10 migration guide for the full list of changes

Checklist

  • I fully tested it as developer / designer and created unit / integration tests
  • I documented it (or no need to document or I will create a separate documentation issue)

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Copilot AI changed the title [WIP] Update v10.1 migration guide with missing section docs: Add Swashbuckle.AspNetCore v10 upgrade section to v10.1 migration guide Feb 26, 2026
@EngincanV EngincanV self-requested a review February 26, 2026 12:16
@EngincanV EngincanV marked this pull request as ready for review February 26, 2026 12:16
Copilot AI review requested due to automatic review settings February 26, 2026 12:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds migration documentation for the ABP v10.1 upgrade to Swashbuckle.AspNetCore v10 / Microsoft.OpenApi v2.x, focusing on the breaking API changes that affect custom Swagger filters and security configuration.

Changes:

  • Documented required namespace and signature updates (new Microsoft.OpenApi interfaces like IOpenApiSchema).
  • Added guidance for migrating schema type/nullability and security requirement configuration.
  • Linked to the official Swashbuckle v10 migration guide and the related ABP PR for details.

@EngincanV EngincanV self-requested a review February 26, 2026 12:20
@EngincanV EngincanV merged commit ae9891a into rel-10.1 Feb 26, 2026
6 checks passed
@EngincanV EngincanV deleted the copilot/update-migration-guide-v10-1 branch February 26, 2026 12:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants