Merge pull request #685 from bcgov/dev/ionwyn/TH-1097

Ensure schema ID is polymorphism-aware
bcgov · Aug 12, 2024 · e44c86a · e44c86a
2 parents c2ee0d4 + 22c35a3
commit e44c86a
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/api/Hmcr.Api/Extensions/IServiceCollectionExtensions.cs b/api/Hmcr.Api/Extensions/IServiceCollectionExtensions.cs
@@ -129,6 +129,9 @@ public static void AddHmcrSwagger(this IServiceCollection services, IWebHostEnvi
                 var filePath = Path.Combine(System.AppContext.BaseDirectory, "Hmcr.Api.xml");
                 options.IncludeXmlComments(filePath);
 
+                // Ensure swagger is aware of namespace and class hierarchy, replacing occurrences of such cases with . for readability.
+                options.CustomSchemaIds(type => type.FullName.Replace('+', '.'));
+
                 var securitySchema = new OpenApiSecurityScheme
                 {
                     Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",