How to set optional and mandatory fields on openapi class schemas?

[franck-malka]

How to set optional and mandatory fields on openapi class schemas?

[dzikoysk]

By default, we're marking nullable fields as optional fields and non-nullalbe fields as required (based on Kotlin return types or @Nullable/@NotNull annotations in Java). If you don't like this behavior, you can put @JsonSchema annotation on a particular type to disable it and use @OpenApiRequired whenever needed:

@JsonSchema(requireNonNulls = false)
data class Entity(
    val wontBeRequired: String
    @OpenApiRequired
    val willBeRequired: String
)

[franck-malka]

@nullable and @NotNull is fine but it doesn't seems to work for me
Let me try the other method

[franck-malka]

for example

@jsonschema(requireNonNulls = true)
public class measurementRequest {
@NotNull messageType messageType; //9.2.3
@NotNull long nrppaTransactionId; //9.2.4

fist field is still marked as optional in openapi file
second field is marked as required but not because of the annotation because it is a 'long'

[franck-malka]

@OpenApiRequired is not valid in java

[dzikoysk]

It seems to be working fine:

javalin-openapi/examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java

Lines 398 to 402 in 3d15957

	// by default nullable fields are not required, but we can force it
	@OpenApiRequired
	public String getNullableIsRequired() {
	return "required";
	}

Could you share your code for more details? :)

[franck-malka]

Umm I see you put it on getters and setters as well I will try

…

On Wed, 4 Sept 2024, 21:54 dzikoysk, ***@***.***> wrote: It seems to be working fine: https://github.com/javalin/javalin-openapi/blob/3d159578951461165961e21af3460a1adb01954e/examples/javalin-gradle-kotlin/src/main/java/io/javalin/openapi/plugin/test/JavalinTest.java#L398-L402 Could you share your code for more details? :) — Reply to this email directly, view it on GitHub <#229 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AMPYYPUZAPJDTR6XPBQNY2LZU5JNRAVCNFSM6AAAAABNUX6VDOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDGMRZG43DCNJXG4> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[dzikoysk]

I see you put it on getters and setters as well

We don't support this kind of annotations on fields. There's an open ticket if you'd be interested in keeping an eye on this topic tho:

• Support all utility OpenApi annotations on fields #217