Skip to content

second level inheritance for UseOneOfForPolymorphism #3155

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 22, 2024
Merged

second level inheritance for UseOneOfForPolymorphism #3155

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
daeadcb
second level inheritance for UseAllOf
k0ka Nov 19, 2024
1ca85b5
Add integration test
k0ka Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions src/Swashbuckle.AspNetCore.Annotations/AnnotationsSwaggerGenOptionsExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,16 +105,19 @@ private static string AnnotationsDiscriminatorNameSelector(Type baseType)

private static string AnnotationsDiscriminatorValueSelector(Type subType)
{
if (subType.BaseType == null)
return null;
var baseType = subType.BaseType;
while (baseType != null)
{
var subTypeAttribute = baseType.GetCustomAttributes(false)
.OfType<SwaggerSubTypeAttribute>()
.FirstOrDefault(attr => attr.SubType == subType);

var subTypeAttribute = subType.BaseType.GetCustomAttributes(false)
.OfType<SwaggerSubTypeAttribute>()
.FirstOrDefault(attr => attr.SubType == subType);
if (subTypeAttribute != null)
{
return subTypeAttribute.DiscriminatorValue;
}

if (subTypeAttribute != null)
{
return subTypeAttribute.DiscriminatorValue;
baseType = baseType.BaseType;
}

return null;
Expand Down
14 changes: 10 additions & 4 deletions src/Swashbuckle.AspNetCore.SwaggerGen/SchemaGenerator/SchemaGenerator.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,12 +475,18 @@ private bool IsKnownSubType(DataContract dataContract, out DataContract baseType
baseTypeDataContract = null;

var baseType = dataContract.UnderlyingType.BaseType;
while (baseType != null && baseType != typeof(object))
{
if (_generatorOptions.SubTypesSelector(baseType).Contains(dataContract.UnderlyingType))
{
baseTypeDataContract = GetDataContractFor(baseType);
return true;
}

if (baseType == null || baseType == typeof(object) || !_generatorOptions.SubTypesSelector(baseType).Contains(dataContract.UnderlyingType))
return false;
baseType = baseType.BaseType;
}

baseTypeDataContract = GetDataContractFor(baseType);
return true;
return false;
}

private bool TryGetDiscriminatorFor(
Expand Down
102 changes: 102 additions & 0 deletions ...ValidSwaggerJson_startupType=NSwagClientExample.Startup_swaggerRequestUri=v1.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,69 @@
}
}
}
},
"/SecondLevel": {
"post": {
"tags": [
"SecondLevel"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubSubType"
}
]
}
},
"text/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubSubType"
}
]
}
},
"application/*+json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubSubType"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -96,6 +159,28 @@
],
"type": "string"
},
"BaseType": {
"required": [
"discriminator"
],
"type": "object",
"properties": {
"discriminator": {
"type": "string"
},
"property": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "discriminator",
"mapping": {
"SubSubType": "#/components/schemas/SubSubType"
}
}
},
"Cat": {
"allOf": [
{
Expand Down Expand Up @@ -129,6 +214,23 @@
"additionalProperties": false
}
]
},
"SubSubType": {
"allOf": [
{
"$ref": "#/components/schemas/BaseType"
},
{
"type": "object",
"properties": {
"property2": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
}
}
}
Expand Down
23 changes: 23 additions & 0 deletions ...shbuckle.AspNetCore.SwaggerGen.Test/SchemaGenerator/JsonSerializerSchemaGeneratorTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,6 +582,29 @@ public void GenerateSchema_SupportsOption_SubTypesSelector()
var schema = subject.GenerateSchema(typeof(BaseType), schemaRepository);

Assert.Equal(new[] { "SubType1", "BaseType" }, schemaRepository.Schemas.Keys);

var subSchema = schemaRepository.Schemas["SubType1"];
Assert.NotNull(subSchema.AllOf);
Assert.Equal(2, subSchema.AllOf.Count);
}

[Fact]
public void GenerateSchema_SecondLevelInheritance_SubTypesSelector()
{
var subject = Subject(configureGenerator: c =>
{
c.UseAllOfForInheritance = true;
c.SubTypesSelector = (type) => type == typeof(BaseSecondLevelType) ? new[] { typeof(SubSubSecondLevelType) } : Array.Empty<Type>();
});
var schemaRepository = new SchemaRepository();

var schema = subject.GenerateSchema(typeof(BaseSecondLevelType), schemaRepository);

Assert.Equal(new[] { "SubSubSecondLevelType", "BaseSecondLevelType" }, schemaRepository.Schemas.Keys);

var subSchema = schemaRepository.Schemas["SubSubSecondLevelType"];
Assert.NotNull(subSchema.AllOf);
Assert.Equal(2, subSchema.AllOf.Count);
}

[Fact]
Expand Down
17 changes: 17 additions & 0 deletions test/Swashbuckle.AspNetCore.TestSupport/Fixtures/BaseSecondLevelType.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
namespace Swashbuckle.AspNetCore.TestSupport
{
public class BaseSecondLevelType
{
public string BaseProperty { get; set; }
}

public class SubSecondLevelType : BaseSecondLevelType
{
public int Property1 { get; set; }
}

public class SubSubSecondLevelType : SubSecondLevelType
{
public int Property2 { get; set; }
}
}
33 changes: 33 additions & 0 deletions test/WebSites/NswagClientExample/Controllers/SecondLevelController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
using System;
using Microsoft.AspNetCore.Mvc;
using Swashbuckle.AspNetCore.Annotations;

namespace NswagClientExample.Controllers
{
[ApiController]
[Route("[controller]")]
public class SecondLevelController : ControllerBase
{
[HttpPost]
public int Create([FromBody]BaseType input)
{
throw new NotImplementedException();
}
}

[SwaggerDiscriminator("discriminator")]
[SwaggerSubType(typeof(SubSubType), DiscriminatorValue = nameof(SubSubType))]
public abstract class BaseType
{
public string Property { get; set; }
}

public abstract class SubType : BaseType
{
}

public class SubSubType : SubType
{
public string Property2 { get; set; }
}
}
99 changes: 99 additions & 0 deletions test/WebSites/NswagClientExample/swagger_net6.0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,69 @@
}
}
}
},
"/SecondLevel": {
"post": {
"tags": [
"SecondLevel"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubSubType"
}
]
}
},
"text/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubSubType"
}
]
}
},
"application/*+json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SubSubType"
}
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"application/json": {
"schema": {
"type": "integer",
"format": "int32"
}
},
"text/json": {
"schema": {
"type": "integer",
"format": "int32"
}
}
}
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -101,6 +164,25 @@
],
"type": "string"
},
"BaseType": {
"required": [
"discriminator"
],
"type": "object",
"properties": {
"discriminator": {
"type": "string"
},
"property": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "discriminator"
}
},
"Cat": {
"allOf": [
{
Expand Down Expand Up @@ -134,6 +216,23 @@
"additionalProperties": false
}
]
},
"SubSubType": {
"allOf": [
{
"$ref": "#/components/schemas/BaseType"
},
{
"type": "object",
"properties": {
"property2": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
}
}
}
Expand Down
Loading