[Swashbuckle 5.0] ResolveConflictingActions

[PeterZong]

Hi,

I noticed that the path object allows path templating - https://github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#pathsObject

So I am not very clear about this statement - "In contrast to WebApi, Swagger 2.0 does not include the query string component when mapping a URL to an action."

If there are 2 actions with same path, but they have different query parameters, 2 path objects should be generated and I don't need to use ResolveConfilictingActions.

E.g.
Path object 1 - /api/contract
Path object 2 - /api/contract?id={id}

If there are 2 actions with same path, and they have same query parameters, I thinks ApiExplorer will ignore both of them. So nothing will be generated for these 2 actions.

So for which scenario, I need to use the ResolveConflictingActions?

Thanks,
Peter

[domaindrivendev]

Hey there

It's not immediately obvious from the Swagger 2.0 specification, but the path MUST NOT contain the query string component. The second path object in your example above breaks the specification and hence the swagger tooling ... including the swagger-ui. See the following two issues in the swagger repo for more information around this "very limiting" constraint:

OAI/OpenAPI-Specification#195
OAI/OpenAPI-Specification#164

ApiExplorer on the other hand will have two ApiDescriptions for routes that differ only by query string component. You can look at the Swashbuckle dummy app for an example - https://github.com/domaindrivendev/Swashbuckle/blob/swagger_2.0/Swashbuckle.Dummy.Core/Controllers/ConflictingActionsController.cs.

Cheers

Richie

[PeterZong]

Hi Richie,

Thanks for your explanation. So this is also true of Swagger 1.2, correct?