-
Notifications
You must be signed in to change notification settings - Fork 82
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.
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
Can org.eclipse.microprofile.openapi.models.OpenAPI and its "children" return null
on getters?
#558
Comments
I agree that the Javadoc should state where To my eye, the fact that the model API has separate In a Security Requirement Object, there's a difference between a key being present and set to an empty array vs. not being present which would make changing the API to be There are a few other things the model API javadoc also doesn't make clear:
|
Unfortunately, I've run out of time to tackle this before the next release. My assumption from looking at the way the API is structured is that If it is, then we could make the documentation change in the a minor release. If it isn't, then we'd need to come to some kind of agreement over how it should behave and agree to specify that and make our implementations consistent. |
I couldn't find in the docs whether
OpenAPI
's getters can returnnull
. For example, could the following code throw aNullPointerException
?It would be helpful to have it explicitly stated in the
#getComponents()
and#getSchemas()
Javadoc whether they can or cannot returnnull
values, or if it's up to the implementation."The text was updated successfully, but these errors were encountered: