[DRAFT] 2.0 upgrade guide working doc

[RachitMalik12]

No description provided.

[RachitMalik12]

@martincostello Hi Martin! Please refer to this as a work in progress, upgrade guide. We will work on this in the open and keeping adding to it as we have more preview bits added. Please let us know if you have any feedback or questions or if we are missing anything you'd like more info on.
cc: @captainsafia @baywet

[martincostello]

Suggested change

	public virtual IList<JsonNode> Enum { get; set; } = new List<JsonNode>();
	public virtual IList<JsonNode> Enum { get; set; }

[martincostello]

@RachitMalik12 Thanks for providing this. I've made various suggested edits to the current content.

My main feedback so far based on my (still ongoing) move in Swashbuckle would be to have a dedicated section showing how the reference handling has changed with the type checks. For example the need to do things like:

public void ProcessSchema(IOpenApiSchema schema)
{
    if (schema is OpenApiSchema concrete)
    {
        // Do something
    }
    else if (scheme is OpenApiSchemaReference reference)
    {
        // Do something else
    }
}

I'll be sure to leave any additional feedback that might be useful once I've gotten Swashbuckle working with the preview7 (as that's what ASP.NET Core 10 preview 2 is compiled against).

[martincostello]

I've also been tripped up by IOpenApiSchema.Type now being a [Flags] enum and had to fix a few things like this:

- if (schema.Type == JsonSchemaTypes.Array)
+ if (schema.Type is { } type && type.HasFlag(JsonSchemaTypes.Array))

People might miss this and introduce subtle bugs if they just one-to-one map the strings to the values like:

- if (schema.Type == "array")
+ if (schema.Type == JsonSchemaTypes.Array)

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud