Add Discriminator mapping #752
Conversation
|
I agree there is certainly a need for clarification about what is needed to be done. I sort of get what is the wished outcome of the implementation but the current one here is not complete in itself. Just for starters there are no tests to test the correctness nor there are macro support thus using this would work only when types are manually constructed. I added more elaborate message here #738 (comment) |
utoipa/src/openapi/schema.rs
Outdated
| @@ -284,6 +284,10 @@ pub struct Discriminator { | |||
| /// Defines a discriminator property name which must be found within all composite | |||
| /// objects. | |||
| pub property_name: String, | |||
|
|
|||
| // An object to hold mappings between payload values and schema names or references. | |||
There was a problem hiding this comment.
Can you change this to triple slash and expand the comment so it is more suitable for public documentation?
It needs to state that it can only be populated manually - i.e. there is no macro support, and there is no validation of the mapping.
There was a problem hiding this comment.
I edited the comment and added a test here: c2834c5
|
Given the work you are doing at https://github.com/1lutz/geoengine/blob/5e17832833fefc3a0915df4de5ee68bb3c8cee5d/services/src/util/apidoc.rs#L168 , I can see the value of getting this in, even if utoipa doesnt do anything with this mapping field. And you could grab a subset of that code and convert it to be a unit test quite easily...? |
|
Yeah I agree as I also described here #738 (comment). That is unfortunate at the moment that there is a need for such manual processing. I think we can let this in without further additions but the doc comment could be improved as @jayvdb mentioned above. |
I need to set the mapping property for the discriminator of oneOfs.
Resolves #738