RicoSuter/NSwag

Versioning does not work properly when the same action implements more than one version

Open

#1,283 opened on Apr 19, 2018

View on GitHub
 (2 comments) (3 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedtype: enhancement

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

If you have a controller or action with more than one ApiVersion attribute or MapToApiVersion attribute the spec only selects the first one.

For example, we should have versions 1.0 and 2.0 for every action in this controller:

[Route("api/v{version:apiVersion}/[controller]")]
[ApiController]
[ApiVersion("1.0")]
[ApiVersion("2.0")]
public class CityController : ControllerBase

And in this case, GET should have versions 2.0 and 3.0:

[HttpGet]
[MapToApiVersion("2.0")]
[MapToApiVersion("3.0")]
public async Task<ActionResult<IEnumerable<City>>> Get()

But only the first one shows up on the swagger docs.

This is important because sometimes you roll your service forward, but some operations are not updated, but you still want to roll their version forward with the others.

Right now the workaround would be creating a method that calls the other one and attribute it. This is less than ideal.

Contributor guide

Research direction
Investigate how NSwag handles multiple ApiVersion and MapToApiVersion attributes on controllers and actions. Look at the code that generates the Swagger document and trace how versions are collected and merged.
Tech stack
csharp
Domain
apitooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#.NET
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60