Additional response examples are not honoured

[Stefan-Z-Camilleri]

Hi

First of all, thank you for your great library.

In my case, I've been working with this and even modified it a bit. Yet either I am doing something wrong, or I don't know, but examples for additional responses are not being generated for me.

I am using v2.1.1

To the left is the minor modification I made to your library, which simply swaps out the StatusCode with a version that has a descriptive version (ex. (200) OK).

As you can see from the screenshot, the examples are being provided using default values... yet whilst debugging the IOperationFilter I can clearly see the example set correctly on the Response.Examples object.

p.s. this works fine for the request body.

Additional info

The action

One of the examples that is not output

The example is clearly there during debug

What am I missing?

[Stefan-Z-Camilleri]

Ok... so some debugging later, I realize the error is apparently in Swagger-UI or I believe SwashBuckle itself (//TODO: I'll have to check the swagger spec to see who is actually wrong here)

The examples for responses are generated as an examples property on the response (in line with the actual Response model that SwashBuckle uses.

If we move this example to the actual schema definition (and rename it from examples to example, then everyone is happy:

Giving (pardon the styling... will clean that up later)

I'm working on a fix on the same lines as you use the ISchemaRegistry in the Request part of the filter.

[Stefan-Z-Camilleri]

This is a swagger-ui bug:

swagger-api/swagger-ui#1213
swagger-api/swagger-ui#1248
swagger-api/swagger-ui#1213

This was fixed in 3.x ... alas SwashBuckle has not upgraded to 3.x yet, bar one fork on myget by another developer.

The temporary workaround for this is to add an example schema on the fly, using an IOperationFilter which is just for the example and modifying the schema ref on the response.

[mattfrear]

Hi Stefan,

Yes I noticed the bug you're describing a few months ago, and also found the same related swagger-ui bugs as you have found. However, I didn't find a workaround as you have done - nice work.

If you want to submit a PR for your workaround then I will accept it - but for me, personally, it's not a big issue and I'm happy to wait for the swagger-ui fix to be imported into Swashbuckle.

[Stefan-Z-Camilleri]

I'm not sure if I should submit a PR here @mattfrear as it is more of a hack than a fix. What I am doing is the following:

1- I fetch the schema for the type
2- I clone the schema and rename the ref to a guid
3- I inject the examples into the new schema and add it to the collection using the new guid as key
4- I set the response schema ref to the ref the new schema

I also added a little hack for Swagger's limitation in rendering arrays, I create an ExpandoObject on the fly and add that as a schema... this is handy for example validation responses.

If you want this PR, I'll create it.. it's your call sir.

[mattfrear]

Ah ok, thanks - I'll leave it as-is then. Hopefully Swashbuckle will get the swagger-ui fix soon and then it'll all work correctly.

[freeranger]

@Stefan-Z-Camilleri could you post your hack here or a link to a fork so others can benefit from it while we wait for swashbuckle to catch up? Thanks

[mattfrear]

I think this is fixed as of Swashbuckle 2.0 which shipped with the new swagger-ui.