Merge pull request #127 from scott-xu/master

unit test for #126
heldersepu · Jun 27, 2023 · ede4c76 · ede4c76
2 parents 378d1a7 + 50bca76
commit ede4c76
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 0 deletions.
diff --git a/Tests/Swagger.Net.Dummy.Core/Swagger.Net.Dummy.Core.csproj b/Tests/Swagger.Net.Dummy.Core/Swagger.Net.Dummy.Core.csproj
@@ -111,6 +111,7 @@
     <Compile Include="Controllers\DictionaryTypesController.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="SwaggerExtensions\AddDefaultResponse.cs" />
+    <Compile Include="SwaggerExtensions\AddDescription.cs" />
     <Compile Include="SwaggerExtensions\AddFileUploadParams.cs" />
     <Compile Include="SwaggerExtensions\AddMessageDefault.cs" />
     <Compile Include="SwaggerExtensions\AppendVersionToBasePath.cs" />

diff --git a/Tests/Swagger.Net.Dummy.Core/SwaggerExtensions/AddDescription.cs b/Tests/Swagger.Net.Dummy.Core/SwaggerExtensions/AddDescription.cs
@@ -0,0 +1,10 @@
+namespace Swagger.Net.Dummy.SwaggerExtensions
+{
+    public class AddDescription : ISchemaFilter
+    {
+        public void Apply(Schema schema, SchemaRegistry schemaRegistry, System.Type type)
+        {
+            schema.description = "Some description";
+        }
+    }
+}
diff --git a/Tests/Swagger.Net.Tests/Swagger/AnnotationsTests.cs b/Tests/Swagger.Net.Tests/Swagger/AnnotationsTests.cs
@@ -49,6 +49,18 @@ public void It_exposes_config_to_post_modify_responses()
             Assert.AreEqual("bar", xProp.ToString());
         }
 
+        [Test]
+        public void It_exposes_config_to_modify_schema_description()
+        {
+            SetUpHandler(c => c.SchemaFilter<AddDescription>());
+
+            var swagger = GetContent<JObject>(TEMP_URI.DOCS);
+
+            var messageExamples = swagger["definitions"]["Message"]["properties"]["Content"]["description"];
+
+            Assert.AreEqual("Some description", messageExamples.ToString());
+        }
+
         [Test]
         public void It_documents_responses_from_swagger_response_attributes_post()
         {