Add support for the new requiredMode to replace required

[swaechter]

Problem

Swagger Core deprecated the required field in Schema with requiredMode. For more information see swagger-api/swagger-core#4286 . Upgrading to the latest Micronaut OpenAPI + Swagger OpenAPI core version marks this field as deprecated:

Switching to the new annotation value makes the compiler happy (No warning):

But this new annotation value isn't picked up by Micronaut OpenAPI, so the required field in the generated OpenAPI file is dropped, which leads to a compiler error in our TypeScript frontend (The value is now undefined):

Solution

Is it possible to add support for requiredMode which takes precedence over required? There was another annotation value that was deprecated but I can't remember.

Example

You can reproduce the problem with bug 11 in https://github.com/swaechter/openapiproblems

Version

• Platform: Linux Debian
• Java: OpenJDK 64-Bit Server VM (build 17.0.4+8-Debian-1deb11u1, mixed mode, sharing)
• Micronaut Application Gradle Plugin: 3.7.2
• Micronaut Version: 3.8.7

[swaechter]

Ah found it: readOnly and writeOnly were also deprecated and replaced with accessMode in OpenAPI Core version 2.0.0 (2018): https://github.com/swagger-api/swagger-core/releases/tag/v2.0.0 . I am not sure if this feature was ever supported, because it interferes with JSON serialization/deserialization. So nothing to worry about, but still a cool feature in OpenAPI :)

[altro3]

@swaechter Hi! Added support requiredMode here #968. accessMode already supported.

Also turn on alphabetical sort tags by default for swagger-ui and redoc (rapidoc already sort it) here #968. Found this problem on your repo :-).

I found some more bug descriptions in your repo. Could you actualize them with latest micronaut-openapi version? If there's anything else, I'll fix it.

[swaechter]

Hey @altro3 thanks a lot for the fixes (and your work for the OpenAPI integration in general). Is it possible to close the two pull requests so I can test everything locally (+ update my bug repository). Are you using Micronaut 4.0.0-SNAPSHOT with Micronaut OpenAPI 5.0.0-SNAPSHOT?

[altro3]

@swaechter Hi! No, I think, need to release all these fixes before micronaut 4.0. Will be in release micronaut-openapi 4.8.6. I'll ask @graemerocher to merge everything and make a release - there are already enough fixes for the new release.

[altro3]

@swaechter you can check fixes in current release 4.8.6. And just for you know: you don't need to use @Schema annotation for your case. You can add javadoc and @NotNull annotation. Swagger file will be identical. For example, this code

@Schema(description = "My description", requiredMode = Schema.RequiredMode.REQUIRED)
private MyClass myFiled;

and this

/**
 * My description
 */
@NotNull
private MyClass myFiled;

generate the same swagger file.

[swaechter]

@altro3 Thanks a lot for the fix. I justed tested it successfully. I always thought that the required means the key has to exists in the JSON object, but can be null :)

[altro3]

@swaechter understand. But description may be in javadoc ;-)