OpenAPI Shows Duplicate Fields Because It Uses Both Fields and Getters

[ClaudiaIoana]

SmallRye OpenAPI is generating duplicate entries in my schema because it’s reading both the fields and the getter/setter methods from my class. I want to stop it from using the getters/setters and only use the fields — and I want to do this without annotations and changes on the class code. Is there any way in which this can be done?

[MikeEdgar]

Hi @ClaudiaIoana do you have a sample class you can share?

[ClaudiaIoana]

Yes. So for example in my class i have the field:
private String desc;

public String getDescription() {
return desc;
}

and in OpenApi it will appear like:
"desc": "string",
"description": "string"

This even though the class does not have a field description.

[MikeEdgar]

Are you using Jackson annotations or similar to have the fields used for the actual de-/serialization?

[MikeEdgar]

Please try setting mp.openapi.extensions.smallrye.private-properties.enable=false in your application configuration. Note that this will ignore all private properties and will rely on the methods for properties and their names.

[MikeEdgar]

Wait, ignore that. I see now that you want the fields, not the methods. There is not currently a way to limit that without code changes.

[ClaudiaIoana]

I tried setting mp.openapi.extensions.smallrye.private-properties.enable=false as you suggested, and it seems to work well for my end goal. Thank you!

[ClaudiaIoana]

[MikeEdgar]

@ClaudiaIoana what is the source of the parameters? Do you have an example?

[ClaudiaIoana]

FName is a field in the class. It has a getter method named getFName(). Because of that, the generated schema displays it as fName.

Example:
private String FName;
public String getFName() { return FName; }

Generated schema looks like:
"fName": { "type": "string" }

[ClaudiaIoana]

I will open a different discussion for the second problem.