Discriminator in Open API JSON Causes "Type expected" Error w/RTK Query Code Gen #4791
Comments
|
I have it working now. I don't fully understand it but thought I'd post in case it helps someone and/or there is anything to be done on the code gen part. I'm guessing not since it seems to do with how I was using NJsonSchema and the resulting Open API JSON document's format... though perhaps the error above could be made to be more descriptive - it didn't really help me much but maybe that is my lack of understanding... Anyway, I'd put the [JsonSchemaFlatten] on my derived types a long time ago for some reason. I remove those and adjusted the way I was using the [JsonDerivedType] attribute on the base class. I also removed the [TypeDiscriminatorPropertyName] attribute to accept the default "$type" value: [JsonDerivedType(typeof(Widget1), "Widget1")]
[JsonDerivedType(typeof(Widget2), "Widget2")]These changes resulted in a more expected Open API JSON output which included references to derived types in a mapping from the discriminator value to the type: "WidgetBase": {
"type": "object",
"discriminator": {
"propertyName": "$type",
"mapping": {
"Widget1": "#/components/schemas/Widget1",
"Widget2": "#/components/schemas/Widget2",
}
},
"x-abstract": true,
"additionalProperties": false,
"required": [
"$type"
],
"properties": {
"widgetType": {
"type": "string"
},
"$type": {
"type": "string"
}
}
}...as well as the allOf construct to include base type properties in the derived types: "Widget1": {
"allOf": [
{
"$ref": "#/components/schemas/WidgetBase"
},
{
"type": "object",
"additionalProperties": false,
"properties": {
"body": {
"type": "string"
}
}
}
]
}Then the RTK Query Open API gen worked just fine. |
I have an API and use NSwag.AspNetCore to generate open api JSON. I have a "WidgetBase" abstract type with several derived types that are distinquished by a WidgetType property. The generated JSON used to be this:
With the above, RTK Query Code Gen runs perfectly fine.
I updated to a newer version of NSwag and it now adds some additional info (discriminator, required/$type, and properties/$type):
Now when I run RTK Query Code Gen, I get this error:
I can't make much sense of this but see "SyntaxError: Type expected" and "WidgetBase" mentioned. The JSON seems to indicate that I have a "type" property on WidgetBase which I do not so I tried to make discriminator/propertyName referernce the widgetType property by adding JsonPolymorphicAttribute to my WidgetBase type in the C# code:
That then resulted in this, seemingly better, JSON that correctly says that "widgetType" is the thing that can be used to discriminate between derived types:
This seemed better since the WidgetBase type does have a WidgetType property. That property is Pascal case in C# and camel case in the generated client code and I tried both for the JsonPolymorphicAttribute just in case but either way I get basically the same error when I try to generate code with the RTK Query Code Gen.
Does RTK Query Code Gen support this discriminator value? I could be doing something wrong, but it seems to break when nothing really changes except adding the extra discriminator and related JSON to the API spec.
The text was updated successfully, but these errors were encountered: