Skip to content

Commit

Permalink
Use 3.0 GA packages from Microsoft (#2457)
Browse files Browse the repository at this point in the history
* Move to 3.0.0 GA version of Microsoft.Extensions.ApiDescription.* packages

* Change only `$(OpenApiGenerateDocumentsOnBuild)` to control doc generation on build
- document generation feature still does nothing by default
- however, with this change, a user can gen documents on demand without changing their project

* Bump npm version in lock file
  • Loading branch information
dougbu authored and RicoSuter committed Oct 17, 2019
1 parent 08f2918 commit 1a6c959
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<repository type="git" url="https://github.com/RicoSuter/NSwag.git"/>
<developmentDependency>true</developmentDependency>
<dependencies>
<dependency id="Microsoft.Extensions.ApiDescription.Client" version="0.3.0-preview7.19365.7" />
<dependency id="Microsoft.Extensions.ApiDescription.Client" version="3.0.0" />
<dependency id="NSwag.MSBuild" version="13.1.3" />
</dependencies>
<references />
Expand Down
2 changes: 1 addition & 1 deletion src/NSwag.AspNetCore/NSwag.AspNetCore.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<MicrosoftAspNetCoreMvcCorePackageVersion>1.0.3</MicrosoftAspNetCoreMvcCorePackageVersion>
<MicrosoftAspNetCoreMvcFormattersJsonPackageVersion>1.0.3</MicrosoftAspNetCoreMvcFormattersJsonPackageVersion>
<MicrosoftAspNetCoreStaticFilesPackageVersion>1.0.2</MicrosoftAspNetCoreStaticFilesPackageVersion>
<MicrosoftExtensionsApiDescriptionServerPackageVersion>0.3.0-preview7.19365.7</MicrosoftExtensionsApiDescriptionServerPackageVersion>
<MicrosoftExtensionsApiDescriptionServerPackageVersion>3.0.0</MicrosoftExtensionsApiDescriptionServerPackageVersion>
<MicrosoftExtensionsFileProvidersEmbeddedPackageVersion>1.0.1</MicrosoftExtensionsFileProvidersEmbeddedPackageVersion>
<NETStandardLibraryPackageVersion>1.6.1</NETStandardLibraryPackageVersion>
<SystemIOFileSystemPackageVersion>4.3.0</SystemIOFileSystemPackageVersion>
Expand Down
5 changes: 2 additions & 3 deletions src/NSwag.AspNetCore/build/NSwag.AspNetCore.props
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,9 @@
<Project>
<PropertyGroup>
<!--
Disable document generation by default in NSwag.AspNetCore.targets. These settings help distinguish user settings
from changes made in Microsoft.Extensions.ApiDescription.Server.targets.
Disable document generation on build if property maintains this value into NSwag.AspNetCore.targets. This setting
helps distinguish user settings from changes made in Microsoft.Extensions.ApiDescription.Server.targets.
-->
<OpenApiGenerateDocuments Condition=" '$(OpenApiGenerateDocuments)' == '' ">default-false</OpenApiGenerateDocuments>
<OpenApiGenerateDocumentsOnBuild
Condition=" '$(OpenApiGenerateDocumentsOnBuild)' == '' ">default-false</OpenApiGenerateDocumentsOnBuild>

Expand Down
17 changes: 8 additions & 9 deletions src/NSwag.AspNetCore/build/NSwag.AspNetCore.targets
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<Project>
<PropertyGroup Condition=" '$(OpenApiGenerateDocuments)' == 'default-false' ">
<PropertyGroup Condition=" '$(OpenApiGenerateDocumentsOnBuild)' == 'default-false' ">
<!--
If user changed $(OpenApiDocumentsDirectory) but not $(OpenApiGenerateDocuments), enable document generation.
Otherwise, disable document generation.
Disable document generation on build by default. If user changed $(OpenApiDocumentsDirectory) but not
$(OpenApiGenerateDocumentsOnBuild) and feature is supported, enable document generation on build.
Changing $(OpenApiDocumentsDirectory) does nothing when $(OpenApiGenerateDocuments) is false.
-->
<OpenApiGenerateDocuments>false</OpenApiGenerateDocuments>
<OpenApiGenerateDocuments
Condition=" '$(OpenApiDocumentsDirectory)' != '$(BaseIntermediateOutputPath)' ">true</OpenApiGenerateDocuments>
</PropertyGroup>
<PropertyGroup Condition=" '$(OpenApiGenerateDocumentsOnBuild)' == 'default-false' ">
<OpenApiGenerateDocumentsOnBuild>$(OpenApiGenerateDocuments)</OpenApiGenerateDocumentsOnBuild>
<OpenApiGenerateDocumentsOnBuild>false</OpenApiGenerateDocumentsOnBuild>
<OpenApiGenerateDocumentsOnBuild
Condition=" '$(OpenApiDocumentsDirectory)' != '$(BaseIntermediateOutputPath)' ">$(OpenApiGenerateDocuments)</OpenApiGenerateDocuments>
</PropertyGroup>
</Project>
2 changes: 1 addition & 1 deletion src/NSwag.Npm/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 1a6c959

Please sign in to comment.