Add support for @JsonView annotations

[maliffi]

Hello,
I've seen that Swagger already support the usage of anootation @JsonView in order to filter input and output of a model class in RequestBody or ResponseBody (see swagger-api/swagger-core#479 fixed with swagger-api/swagger-core#2681 since 2018), but If I try using this annotation in my controller in order to selectively hide some fields of my model class from input or output in the swagger-ui, they are anyway displayed.
This is my example

    @JsonView(RestViews.ViewAdmin.class)
    public CompletionStage<FilterRest> saveFilter(
            @Valid @JsonView(RestViews.Save.class) @ConvertGroup(to = ValidationGroups.Save.class) FilterRest filterRest) {
    }

My model class is:

public class FilterRest {

    @JsonView({RestViews.Update.class, RestViews.ViewUser.class})
    @Null(groups = {ValidationGroups.Create.class})
    private String id;

    @JsonView({RestViews.Create.class, RestViews.ViewAdmin.class})
    @NotNull
    private Set<String> countryValidity;

Event the field id is marked with a different JsonView actually is showed in swagger-ui for the request in the API.

What am I doing wrong?

[phillip-kruger]

SmallRye OpenAPI is primarily a microprofile open API implementation. We do not support (yet) swagger annotations, although there is an open issue to add support for it. Once that is done we can look at supporting this

[mschorsch]

JsonView is a jackson annotation not a swagger annotation.

[mschorsch]

@phillip-kruger Is there a chance that this feature will be implemented in the near future?

JsonView support is very important for us, because we must generate different OpenAPI specifications from the same Rest-Api.

[MikeEdgar]

@maliffi , @mschorsch - based on the example in this issue, would you expect the FilterRest bean to result in 6 different schemas?

• FilterRest
• FilterRest_ViewAdmin
• FilterRest_Save
• FilterRest_Update
• FilterRest_ViewUser
• FilterRest_Create

[mschorsch]

Yes. It would be nice if i could choose (config flag?) which JsonView(s) should be generated.

[maliffi]

@maliffi , @mschorsch - based on the example in this issue, would you expect the FilterRest bean to result in 6 different schemas?

• FilterRest
• FilterRest_ViewAdmin
• FilterRest_Save
• FilterRest_Update
• FilterRest_ViewUser
• FilterRest_Create

Yes, this is what I would expect to see in the Schemas section of swagger.
At the same time, the example autogenerated for each API should respect the RestView used to annotate the method of rest api

[mschorsch]

@MikeEdgar Do you know when this feature will be available? This issue prevents us from using smallrye-openapi in quarkus and is a blocker for our migration to resteasy-reactive in one of our projects.

[MikeEdgar]

@mschorsch I haven't had a chance to think about a solution for this one yet, but I hope to find some time soon.

[sandronm]

Don't want to put pressure on anybody but this feature will also be nice for our current developments.
I hope this will become a reality some day ;-)

Already thank you for your all work!

[antssilva96]

I'm in the same situation as @mschorsch, this is blocking the use of quarkus-smallrye-openapi.

[Raf23]

Same issue here and same situation @MikeEdgar this is blocking for us to use quarkus-smallrye-openapi