Handle null in collections (list/map) #106
Conversation
…ing an action on null (e.g. calling SerializeAsV3) has potential to yield null reference exception. - This is sort of a grey area since we will only encounter this for a "broken" object (e.g. a null schema in the Schemas map in Components - see the written unit tests), but I think it's a good idea to have this safeguard. Getting a generic null reference exception is a bad experience for our customer in any situation, I believe. - Unit test for Components
|
@PerthCharern, |
|
Am I correct in understanding that this could in theory write out an invalid OpenAPI description? I'm not sure how I feel about that. |
|
Yes, I totally understand and I am still a little uncomfortable with this myself, but I don't think I have many options. It's a choice between producing an invalid document and throwing an exception. If we don't want to go with the invalid doc route, we can make it throw a specific exception for this case. That said, I'm trying to limit the number of exceptions we throw due to document problem since we (sorta) decided that it's the validator's job to take care of verifying the validity of the document. Other alternatives I have considered like populating it with empty object are inconsistent and yield different semantic meanings. What do you think? |
|
@PerthCharern Yeah, I think the ship sailed on my idea of never generating an invalid output doc once we allowed the dom to be invalid. That's fine. If it becomes necessary we can always force a clean validation before writing. |
Null object in collections is handled explicitly. Otherwise, operating an action on null (e.g. calling SerializeAsV3) has potential to yield null reference exception.
Unit test for Components