Add public method SchemaRepository.ReplaceSchemaId

Author: bkoelman

src/Swashbuckle.AspNetCore.SwaggerGen/PublicAPI/PublicAPI.Unshipped.txt

@@ -1 +1 @@
-
+Swashbuckle.AspNetCore.SwaggerGen.SchemaRepository.ReplaceSchemaId(System.Type oldSchemaType, string newSchemaId) -> bool

src/Swashbuckle.AspNetCore.SwaggerGen/SwaggerGenerator/SchemaRepository.cs

@@ -42,4 +42,22 @@ public OpenApiSchemaReference AddDefinition(string schemaId, OpenApiSchema schem
 
         return new OpenApiSchemaReference(schemaId);
     }
+
+    public bool ReplaceSchemaId(Type oldSchemaType, string newSchemaId)
+    {
+        ArgumentNullException.ThrowIfNull(oldSchemaType);
+        ArgumentException.ThrowIfNullOrEmpty(newSchemaId);
+
+        if (_reservedIds.TryGetValue(oldSchemaType, out string oldSchemaId) &&
+            oldSchemaId != newSchemaId && Schemas.TryGetValue(oldSchemaId, out var targetSchema))
+        {
+            Schemas.Add(newSchemaId, targetSchema);
+            Schemas.Remove(oldSchemaId);
+
+            _reservedIds[oldSchemaType] = newSchemaId;
+            return true;
+        }
+
+        return false;
+    }
 }

test/Swashbuckle.AspNetCore.SwaggerGen.Test/SchemaRepositoryTests.cs

@@ -0,0 +1,63 @@
+using Microsoft.OpenApi;
+
+namespace Swashbuckle.AspNetCore.SwaggerGen.Test;
+
+public class SchemaRepositoryTests
+{
+    [Fact]
+    public void ReplaceSchemaId_ExistingSchema_ReplacesSchemaId()
+    {
+        var repository = new SchemaRepository();
+        var generator = new SchemaGenerator(new(), new JsonSerializerDataContractResolver(new()));
+        var exampleSchemaReference = (OpenApiSchemaReference)generator.GenerateSchema(typeof(Example), repository);
+
+        var oldSchemaId = exampleSchemaReference.Reference.Id!;
+        var exampleSchema = repository.Schemas[oldSchemaId];
+        Assert.Contains(oldSchemaId, repository.Schemas);
+        Assert.Same(exampleSchema, repository.Schemas[oldSchemaId]);
+
+        var newSchemaId = "alternateNameForExample";
+        bool result = repository.ReplaceSchemaId(typeof(Example), newSchemaId);
+
+        Assert.True(result);
+        Assert.DoesNotContain(oldSchemaId, repository.Schemas);
+        Assert.Contains(newSchemaId, repository.Schemas);
+        Assert.Same(exampleSchema, repository.Schemas[newSchemaId]);
+    }
+
+    [Fact]
+    public void ReplaceSchemaId_SameName_DoesNotChange()
+    {
+        var repository = new SchemaRepository();
+        var generator = new SchemaGenerator(new(), new JsonSerializerDataContractResolver(new()));
+        var exampleSchemaReference = (OpenApiSchemaReference)generator.GenerateSchema(typeof(Example), repository);
+
+        var unchangedSchemaId = exampleSchemaReference.Reference.Id!;
+        var exampleSchema = repository.Schemas[unchangedSchemaId];
+        Assert.Contains(unchangedSchemaId, repository.Schemas);
+        Assert.Same(exampleSchema, repository.Schemas[unchangedSchemaId]);
+
+        bool result = repository.ReplaceSchemaId(typeof(Example), unchangedSchemaId);
+
+        Assert.False(result);
+        Assert.Contains(unchangedSchemaId, repository.Schemas);
+        Assert.Same(exampleSchema, repository.Schemas[unchangedSchemaId]);
+    }
+
+    [Fact]
+    public void ReplaceSchemaId_MissingSchema_DoesNotChange()
+    {
+        var repository = new SchemaRepository();
+
+        var newSchemaId = "alternateNameForExample";
+        bool result = repository.ReplaceSchemaId(typeof(Example), newSchemaId);
+
+        Assert.False(result);
+        Assert.DoesNotContain(newSchemaId, repository.Schemas);
+    }
+
+    private sealed class Example
+    {
+        public string Value { get; set; }
+    }
+}