dotnet / dotnet/aspnetcore

Microsoft.Extensions.ApiDescription.Server - improve file name consistency with versioning

Open
#58,782 4 comments 5 reactions 0 assignees View on GitHub
area-minimal feature-openapi
Dominant language
C#
Stars
38.4k
Forks
10.9k
Avg merge
2d 6h
Merged PRs (30d)
290

Description

Currently if you have a versioned Web API project, and one version matches the name 'v1', it'll not emit the version number as part of the file name, anything else and it will get emitted, e.g. V1, v2, 1.0.

Would it not be better to omit the version number if only one file is to be generated, otherwise always append it? This would mean file names are consistent, e.g. my-project_v1.json, my-project_v2.json, rather than now, where it'll be my-project.json, my-project_v2.json

Alternatively, maybe pass in a flag to add in that behaviour and leave as-is for the default so as to be non-breaking?

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.