Define default values for required property per parameter type

I couldn’t find much info about query parameter handling in the spec. This example already suggests, it could be an optional parameter and I would agree: https://github.com/eclipse/microprofile-open-api/blob/master/spec/src/main/asciidoc/microprofile-openapi-spec.adoc#requestbody However some implementors set them required by default, just like @PathParam or @FormParam (where it’s fine). As discussed in https://github.com/smallrye/smallrye-open-api/issues/110 one could consider defining requirements in the spec for each possible parameter type.

[neon-dev]

Glancing over the source code on GitHub it looks like it already handles that correctly: https://github.com/smallrye/smallrye-open-api/blob/e29bdabc89aae81e00be32cdb4dd5a34f551f6c2/implementation/src/main/java/io/smallrye/openapi/runtime/scanner/OpenApiAnnotationScanner.java#L555 I’m currently on vacation so I don’t have a project at hand were I experienced this. I’ll create an issue in a week or two when I can verify this behavior.

[EricWittmann]

We discussed this issue in today’s hangout. Here is what we have (tentatively?) decided to do:

• No changes will be made to the text of the Microprofile OpenAPI specification
• The TCK will be updated to ensure that Query parameters are not set as required by default

To be clear, the TCK will not assert that the required property for query parameters is false. Instead, it will assert that the required property for a query parameter is either not present or present and false.

We will also update the TCK to make sure that query parameters can be marked as required by using a separate OpenAPI annotation to explicitly set that property value.

Also note - these same rules will apply to cookie and header parameters as well.