@ApiModelProperty "hidden" attribute has no effect

I’m including this annotation in my model, and there is one attribute there that I want to hide from the API, cause it’s not relevant.

As far as I know, “hidden” attribute of @ApiModelProperty does it, but it’s not working. I tried defining it in the class attribute and in the getter/setter, but Swagger always includes it in the API.

@ApiModel(value = "DTO description")
public class ESType {
    @ApiModelProperty(value = "The type", position = -1, required = true)
    private String type;

    @ApiModelProperty(hidden = true)
    private Class<DTO> clazz;

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    @ApiModelProperty(hidden = true)
    public Class<DTO> getClazz() {
        return clazz;
    }

    @ApiModelProperty(hidden = true)
    public void setClazz(Class<DTO> clazz) {
        this.clazz = clazz;
    }
}

How can I hide it?

Thanks! Marc

[raspacorp]

One of the comments above that suggests to create different classes for requests responses that have or not the required properties. IMHO a documentation tool shouldn’t drive the design of the class hierarchy for requests or responses. It is very common and fair to reuse classes that contain a global set of properties. Developers want to be able to use for example a class ‘User’ that has an id, that is normally not known in the moment of the call to the ‘POST /user’ service as it is going to be generated in the backend, in addition to other possible properties e.g. createdDate, modifiedDate… But we want to have those in the response of that or other operations. It would be great if Swagger had an annotation for allowing the field to appear or not in the documentation, but it would be even more useful if we could choose if it should be documented for request or for response.

For example: @ApiModelProperty(responseOnly = true)

[Marza]

We would like to have the hidden attribute. For our use case we don’t want to show it in the documentation since it is deprecated and should not be used but we cannot remove it yet since it is still used by some clients and therefor cannot use @JsonIgnore from Jackson.