Add xml-comments to nuget package

unchase · Feb 20, 2020 · cc21b52 · cc21b52
1 parent bcbb2ff
commit cc21b52
Show file tree

Hide file tree

Showing 4 changed files with 156 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@
 
 These are the changes to each version that has been released on the [nuget](https://www.nuget.org/packages/Unchase.Swashbuckle.AspNetCore.Extensions/).
 
+## v2.1.2 `(2020-02-20)`
+
+- [x] Add xml-comments to nuget package
+
 ## v2.1.1 `(2020-02-19)`
 
 - [x] Fix bug: use `System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping` encoder for responses examples

diff --git a/...Swashbuckle.AspNetCore.Extensions/Filters/ChangeResponseByHttpStatusCodeDocumentFilter.cs b/...Swashbuckle.AspNetCore.Extensions/Filters/ChangeResponseByHttpStatusCodeDocumentFilter.cs
@@ -93,12 +93,14 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
                                 case ResponseExampleOptions.AddNew:
                                     if (this._responseExample != null)
                                     {
-                                        jsonContent.Example = new OpenApiString(System.Text.Json.JsonSerializer.Serialize(this._responseExample, 
+                                        var jsonExample = new OpenApiString(System.Text.Json.JsonSerializer.Serialize(this._responseExample,
                                             new System.Text.Json.JsonSerializerOptions
                                             {
                                                 WriteIndented = true,
                                                 Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping
                                             }));
+
+                                        jsonContent.Example = jsonExample;
                                     }
                                     jsonContent.Schema = schema;
                                     break;
@@ -114,14 +116,15 @@ public void Apply(OpenApiDocument swaggerDoc, DocumentFilterContext context)
                                 case ResponseExampleOptions.AddNew:
                                     if (this._responseExample != null)
                                     {
+                                        var jsonExample = new OpenApiString(System.Text.Json.JsonSerializer.Serialize(this._responseExample,
+                                            new System.Text.Json.JsonSerializerOptions
+                                            {
+                                                WriteIndented = true,
+                                                Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping
+                                            }));
                                         response.Value.Content.Add("application/json", new OpenApiMediaType()
                                         {
-                                            Example = new OpenApiString(System.Text.Json.JsonSerializer.Serialize(this._responseExample, 
-                                                new System.Text.Json.JsonSerializerOptions 
-                                                { 
-                                                    WriteIndented = true, 
-                                                    Encoder = System.Text.Encodings.Web.JavaScriptEncoder.UnsafeRelaxedJsonEscaping 
-                                                })),
+                                            Example = jsonExample,
                                             Schema = schema
                                         });
                                     }

diff --git a/...nchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.csproj b/...nchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.csproj
@@ -14,10 +14,14 @@
     <NeutralLanguage></NeutralLanguage>
     <LangVersion>7.3</LangVersion>
     <PackageIconUrl>https://github.com/unchase/Unchase.Swashbuckle.AspNetCore.Extensions/blob/master/assets/icon.png?raw=true</PackageIconUrl>
-    <Version>2.1.0</Version>
+    <Version>2.1.2</Version>
     <AssemblyVersion>2.1.0.0</AssemblyVersion>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>Unchase.Swashbuckle.AspNetCore.Extensions.xml</DocumentationFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Swashbuckle.AspNetCore.SwaggerGen" Version="5.0.0" />
   </ItemGroup>

diff --git a/src/Unchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.xml b/src/Unchase.Swashbuckle.AspNetCore.Extensions/Unchase.Swashbuckle.AspNetCore.Extensions.xml