Upgrade Guide for v2

[martincostello]

Howdy folks - after a pointer from @captainsafia, I've just been having a quick look at what would happen if I tried to use Microsoft.OpenApi 2.0.0 in Swashbuckle.AspNetCore using the latest preview.

Support for OpenAPI 3.1 has been a populate ask from our users for quite some time: domaindrivendev/Swashbuckle.AspNetCore#2349.

Unsurprisingly, there's quite a lot of breaking changes to deal with:

Rather than me just blindly chip through those changes until it compiles (let alone tests pass), I figured a migration guide would be a useful starting point. Even if it's just a simple list of changes rather than a full-blown document, as clearly it would be a moving goal-post in the middle of your development, that would go a good way to understanding the effort that would be required for us in more detail.

This looks like it's going to be a non-trivial piece of work to adopt, and will put constraints on us/our users on what functionality will and will not be retained moving forwards compared to v1 and OpenAPI 2.0/3.0.

Things I've found so far:

• Removal of the JSON reader;
• Parsing documents is async;
• Removal of IOpenApiAny;
• JsonSchemaType replacing string for schema types;
• OpenApiDocument.ResolveReference() being removed.

Would someone be able to put something together to aid us in preparing to consume version 2? Ideally this is something we (Swashbuckle) can work on in the background so that we could land support for 3.1 relatively soon after you ship 2.0.0 as stable.

[darrelmiller]

@martincostello There is a blog post that we are trying to finish up that will show all the before and after stuff, and give some explanation as to the why we have made the changes we have. We can certainly make sure it contains all the necessary guidance for migration.

[RachitMalik12]

@martincostello We also have some release notes here: https://github.com/microsoft/OpenAPI.NET/releases/tag/2.0.0-preview1 that contain details on the breaking changes. Feel free to take a look and see if it helps you get started while we work on the blogpost.

[martincostello]

I've partially upgraded Swashbuckle.AspNetCore to v2 preview 5 here, though a lot of tests are current broken. It isn't yet clear which are mine to fix and which are possible Microsoft.OpenApi v2 bugs - that's something I need to dig into.

I saw there have been two new releases since yesterday when I was looking for migration notes in the release details (which alas only exist for preview 1), so thought upgrading might resolve some of these issues.

However, preview 6 introduced many more breaking changes, and I don't know what the appropriate migration path for them is.

Specifically, the changes in #2106 removed the Reference property from {I}OpenApiSchema which Swashbuckle uses heavily.

@baywet could you or someone on the team provide some additional migration assistance with the path forward here please? The upgrade is proving quite painful/challenging for Swashbuckle.AspNetCore.

[baywet]

Thanks for the nudge here @martincostello. We've already started working on an internal document for the blog post for the announcement of the release which contains a lot of the information you'd be looking for in an upgrade scenario.

I've asked @RachitMalik12 our dear PM to abstract the key information in a markdown document on this repo in a document similar to this one