Skip to content

Default discriminator "$type" for JsonPolymorphicAttribute (annotations) #3496

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 4 commits into from
Aug 27, 2025
Merged

Default discriminator "$type" for JsonPolymorphicAttribute (annotations) #3496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d98da2e
Update AnnotationsSwaggerGenOptionsExtensions.cs
lilinus Jul 10, 2025
5b637f9
Merge branch 'master' into stj-default-discriminator
lilinus Aug 26, 2025
d175987
Fix tests
lilinus Aug 26, 2025
0b07ac0
Revert rename for custom discriminator tests
lilinus Aug 27, 2025
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
2 changes: 1 addition & 1 deletion src/Swashbuckle.AspNetCore.Annotations/AnnotationsSwaggerGenOptionsExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ private static string AnnotationsDiscriminatorNameSelector(Type baseType)

if (jsonPolymorphicAttributes != null)
{
return jsonPolymorphicAttributes.TypeDiscriminatorPropertyName;
return jsonPolymorphicAttributes.TypeDiscriminatorPropertyName ?? "$type";
}

return null;
Expand Down
119 changes: 119 additions & 0 deletions ...erJson_startupType=NSwagClientExample.Startup_swaggerRequestUri=v1.DotNet8_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,68 @@
}
}
}
},
"/SystemTextJsonDefaultDiscriminatorAnimals": {
"post": {
"tags": [
"SystemTextJsonDefaultDiscriminatorAnimals"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
]
}
},
"text/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
]
}
},
"application/*+json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -319,6 +381,63 @@
}
]
},
"SystemTextJsonDefaultDiscriminatorAnimal": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"animalType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"Cat": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat",
"Dog": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
}
},
"SystemTextJsonDefaultDiscriminatorCat": {
"allOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"type": "object",
"properties": {
"catSpecificProperty": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SystemTextJsonDefaultDiscriminatorDog": {
"allOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"type": "object",
"properties": {
"dogSpecificProperty": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SystemTextJsonDog": {
"allOf": [
{
Expand Down
119 changes: 119 additions & 0 deletions ...erJson_startupType=NSwagClientExample.Startup_swaggerRequestUri=v1.DotNet9_0.verified.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,68 @@
}
}
}
},
"/SystemTextJsonDefaultDiscriminatorAnimals": {
"post": {
"tags": [
"SystemTextJsonDefaultDiscriminatorAnimals"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
]
}
},
"text/json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
]
}
},
"application/*+json": {
"schema": {
"oneOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat"
},
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
]
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -319,6 +381,63 @@
}
]
},
"SystemTextJsonDefaultDiscriminatorAnimal": {
"required": [
"$type"
],
"type": "object",
"properties": {
"$type": {
"type": "string"
},
"animalType": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false,
"discriminator": {
"propertyName": "$type",
"mapping": {
"Cat": "#/components/schemas/SystemTextJsonDefaultDiscriminatorCat",
"Dog": "#/components/schemas/SystemTextJsonDefaultDiscriminatorDog"
}
}
},
"SystemTextJsonDefaultDiscriminatorCat": {
"allOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"type": "object",
"properties": {
"catSpecificProperty": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SystemTextJsonDefaultDiscriminatorDog": {
"allOf": [
{
"$ref": "#/components/schemas/SystemTextJsonDefaultDiscriminatorAnimal"
},
{
"type": "object",
"properties": {
"dogSpecificProperty": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
]
},
"SystemTextJsonDog": {
"allOf": [
{
Expand Down
35 changes: 35 additions & 0 deletions ...tes/NswagClientExample/Controllers/SystemTextJsonDefaultDiscriminatorAnimalsController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
using System.ComponentModel.DataAnnotations;
using System.Text.Json.Serialization;
using Microsoft.AspNetCore.Mvc;

namespace NSwagClientExample.Controllers;

[ApiController]
[Route("[controller]")]
public class SystemTextJsonDefaultDiscriminatorAnimalsController : ControllerBase
{
[HttpPost]
[Produces("application/json")]
public void CreateAnimal([Required] SystemTextJsonDefaultDiscriminatorAnimal animal)
{
throw new NotImplementedException();
}
}

[JsonPolymorphic]
[JsonDerivedType(typeof(SystemTextJsonDefaultDiscriminatorCat), "Cat")]
[JsonDerivedType(typeof(SystemTextJsonDefaultDiscriminatorDog), "Dog")]
public class SystemTextJsonDefaultDiscriminatorAnimal
{
public string AnimalType { get; set; }
}

public class SystemTextJsonDefaultDiscriminatorCat : SystemTextJsonDefaultDiscriminatorAnimal
{
public string CatSpecificProperty { get; set; }
}

public class SystemTextJsonDefaultDiscriminatorDog : SystemTextJsonDefaultDiscriminatorAnimal
{
public string DogSpecificProperty { get; set; }
}
Loading
Loading