[Feature]: I want to configure the default value of @Schema RequiredMode to other value, than AUTO

[VOJAKIS]

Feature Description

I want to configure the RequiredMode for annotation @Schema programatically to REQUIRED. Right now, most of the attributes we use are required, like 95%, and other are not required.

Use Case

When I am making an application with backend and frontend, most of the times the frontend wants to see every attribute as a response from the backend.
Right now we have to configure that (or use another annotations, like @NotNull) to do that.

Suggested Solution (optional)

There should be a way to overload the default value to a specified value, when not stated otherwise.

If a value is declared in the annotation, e.g.
@Schema(requiredMode = Schema.RequiredMode.NOT_REQUIRED
then Swagger should ignore the default value and use the one declared.
Otherwise use the default value.

Alternatives Considered

I have tried to do this with Spring Boot annotation @NotNull, OpenAPICustomizer and a custom meta-annotation.

Additional Context

I use Spring Boot v4.

SpringDOC OpenAPI Starter WebMVC UI v2.8.10

Checklist

• I have searched the existing issues to ensure this is not a duplicate.
• This feature would be useful to more than just my use case.
• I have provided enough detail for the maintainers to understand the scope of the request.

[Mattias-Sehlstedt]

Hi, I believe that the easiest way of achieving this together with springdoc-openapi is by doing this.

[VOJAKIS]

Hi, I believe that the easiest way of achieving this together with springdoc-openapi is by doing this.

Thank you for your reply. I used this springdoc/springdoc-openapi#2992 (comment)

[VOJAKIS]

This removes the option for an attribute to retain it's "null" type.

This schema:
@Schema(types = { "string", "null" }, nullable = true) String fileReference
or this one
@Schema(types = { "string", "null" }) String fileReference

both produce this in Swagger:

I want to produce this:

This bug happens when I create the class SwaggerConfig that extends ModelResolver. The Override is disabled and it still removes the possible null value???

@Configuration
@Slf4j
public class SwaggerConfig extends ModelResolver {

    public SwaggerConfig(ObjectMapper mapper) {
        super(mapper);
    }

    // @Override
    // protected Schema.RequiredMode resolveRequiredMode(Schema schema) {
    // if (schema == null || schema.requiredMode() == null || schema.requiredMode() == Schema.RequiredMode.AUTO) {
    // return Schema.RequiredMode.REQUIRED;
    // }
    // return schema.requiredMode();
    // }

}

[Mattias-Sehlstedt]

If you are producing a 3.1 specification it might be that the resolver is by default 3.0 and that it is not changed properly to 3.1.

So maybe something like this (a bit of a wild guess)

@Configuration
public class MyModelResolver extends ModelResolver {

    public MyModelResolver(ObjectMapper mapper) {
        super(mapper);
        // This is added
        this.setOpenapi31(true);
    }

    @Override
    protected Schema.RequiredMode resolveRequiredMode(Schema schema) {
        if (schema == null || schema.requiredMode() == null || schema.requiredMode() == Schema.RequiredMode.AUTO) {
            return Schema.RequiredMode.REQUIRED;
        }
        return schema.requiredMode();
    }
}

But I believe it would be helpful if more exact reproducible data was provided so one could reason about the behavior.

Do you experience that @Schema(types = { "string", "null" }) String fileReference works without injecting a custom converter? I have always had issue with being able to utilize the 3.1 way of expressing nullability properly, and that it does not seem to be anything that works exactly as expected.