captainsafia
commented
1 month ago The type Dog is renamed to PetDog; not expected.
This allows us to disambiguate between Dog used in a polymorphic hierarchy (where a discriminator property must be defined) versus Dog used on its own (which serializes directly without need for a discriminator).
Pet has the name property defined in code, but this shows up on PetBase and PetDoc in schema. I can't see how you can write code that operates on the Pet type and use the Name property.
Hm....can you clarify what you mean by this? I assume you're referring to being able to use the PetBase.Name property? As mentioned above, the distinction between Pet and PetBase is primarily around which one is part of the discriminated hierarchy and which type stands on its own.
Swashbuckle adds a discriminator section that is completely missing. OpenApi seems to be quite flexible in some areas; is this just another way of representing things. Code generator will have to handle both?
Your intuition is right here. The OpenAPI specification is a bit flexible in the way it defines support for discriminators in the spec. For our purposes, we've decided to stick true to the definition of the spec. Specifically, the this section of the specification, which states:
The expectation now is that a property with name petType MUST be present in the response payload, and the value will correspond to the name of a schema defined in the OAS document. Thus the response payload:
In sum, the spec requires that when you use the discriminator property every subschema must define the discriminator property.
In the type:
[JsonPolymorphic(TypeDiscriminatorPropertyName = "$dis")]
[JsonDerivedType(typeof(Cat), typeDiscriminator: "cat")]
[JsonDerivedType(typeof(Dog), typeDiscriminator: "dog")]
public class Pet
{
public string Name { get; set; } = default!;
}
public class Dog : Pet
{
public string? Breed { get; set; }
}
public class Cat : Pet
{
public int? Lives { get; set; }
}The Pet type doesn't define a discriminator and in this case STJ will determine what to do based on the JsonUnknownDerivedTypeHandling. To explicitly define the mapping, you can add a [JsonDerivedType(typeof(Pet), typeDiscriminator: "pet")] attribute so that the all possible subtypes are explicitly defined.
dnv-kimbell
marinasundstrom
Is there an existing issue for this?
Describe the bug
I have some polymorphic types
This result in
This is the equivalent generated by Swashbuckle
Expected Behavior
The type Dog is renamed to PetDog; not expected.
Pet has the name property defined in code, but this shows up on PetBase and PetDoc in schema. I can't see how you can write code that operates on the Pet type and use the Name property.
Swashbuckle adds a discriminator section that is completely missing. OpenApi seems to be quite flexible in some areas; is this just another way of representing things. Code generator will have to handle both?
Steps To Reproduce
https://github.com/dnv-kimbell/openapi-inlineschema
Exceptions (if any)
No response
.NET Version
9.0 RC1
Anything else?
No response