Remove description from OpenApiResponse when serializing for Swagger …

…v2 (#4314) * Remove description from OpenApiResponse when serializing for Swagger v2 to prevent error "Structural error at paths.somepath.get.responses.304 should NOT have additional properties additionalProperty: description" [PR]. * Remove description from OpenApiResponse when serializing for Swagger v2 to prevent error "Structural error at paths.somepath.get.responses.304 should NOT have additional properties additionalProperty: description" [PR].
RicoSuter · Jan 17, 2023 · 3ee148a · 3ee148a
1 parent 7767e71
commit 3ee148a
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 2 deletions.
diff --git a/src/NSwag.Core.Tests/Serialization/MediaTypesSerializationTests.cs b/src/NSwag.Core.Tests/Serialization/MediaTypesSerializationTests.cs
@@ -22,7 +22,6 @@ public void When_response_schema_and_example_is_set_then_it_is_serialized_correc
         ""operationId"": ""foo"",
         ""responses"": {
           ""200"": {
-            ""description"": """",
             ""schema"": {
               ""type"": ""string""
             },
@@ -93,7 +92,6 @@ public void When_response_schema_and_example_is_set_as_file_then_it_is_serialize
         ""operationId"": ""foo"",
         ""responses"": {
           ""200"": {
-            ""description"": """",
             ""schema"": {
               ""type"": ""file""
             },

diff --git a/src/NSwag.Core/OpenApiDocument.Serialization.cs b/src/NSwag.Core/OpenApiDocument.Serialization.cs
@@ -67,6 +67,7 @@ private static PropertyRenameAndIgnoreSerializerContractResolver CreateJsonSeria
                 resolver.IgnoreProperty(typeof(OpenApiParameter), "x-position");
 
                 resolver.IgnoreProperty(typeof(OpenApiResponse), "content");
+                resolver.IgnoreProperty(typeof(OpenApiResponse), "description");
                 resolver.IgnoreProperty(typeof(OpenApiResponse), "links");
 
                 resolver.IgnoreProperty(typeof(OpenApiSecurityScheme), "scheme");