SwaggerUI Middleware documentUrls... bug?

[pinkfloydx33]

I'm not hitting any issues personally, but I was reviewing the notes/changelog for the just released 10.1.1 and I saw this in the RespondWithDocumentUrls method:

        string json = "[]";

        if (_jsonSerializerOptions is null)
        {
            var l = new List<UrlDescriptor>(_options.ConfigObject.Urls);
            json = JsonSerializer.Serialize(l, SwaggerUIOptionsJsonContext.Default.ListUrlDescriptor);
        }

        json ??= JsonSerializer.Serialize(_options.ConfigObject, _jsonSerializerOptions);

If the user does not pass in their own serializer options, this will serialize the Urls object using the internal JSON context. If that somehow fails and returns null, then the entire ConfigObject would be serialized when it hits the null-coalescing assignment.

But, if the user does pass in serializer options, then this method will always only ever return [] because the null-coalescing assignment to the json variable would never do anything. Right?

So there are two potentially odds things here:

• Falling back to the entire config object if the URL serialization returned null, but only if you don't pass in your own options
• Always returning [] if you use your own serializer options

I am not opening this as an issue because I'm not entirely sure what the intent of this code is... but I think someone should review it because something seems off

@martincostello

[martincostello]

Yep, this is a bug.

Looks like it's been wrong since it was implemented in #3263 due to a copy-paste error and was missed during review.

Would you like to submit a PR to fix it @pinkfloydx33?

[martincostello]

Fixed in #3772 as I was working in the same area anyway for a different bug.