UI show required parameter as optional.

[Fernando Gandini]

Hi guys, I´m using the annotation on my beans to set required and non required parameters, but Swagger UI seems not reading the properties correctly. Here is my bean and what Swagger show.

Can anyone help me please?

Thanks

BEAN :

@JsonInclude(JsonInclude.Include.NON_NULL) 

public class ProcessoInsert {

    

    @NotNull

    @ApiParam(required = true)

    @JsonProperty("id_ocorrencia")

    public Integer idOcorrencia;

    

    @NotEmpty

    @ApiParam(required = true)

    @JsonProperty("descricao")

    public String dsDescricao;

    

    @NotNull

    @ApiParam(required = true)

    @JsonProperty("id_status")

    public Integer idStatus;

    

    @Email

    @ApiParam(required = true)

    @JsonProperty("email_usuario")

    public String dsEmailUsuario;

    

    @ApiParam(required = false)

    @JsonProperty("id_departamento_encaminhado")

    public Integer idDepartamentoEnc;

}

SWAGGER:

ProcessoInsert {

id_ocorrencia (integer),

descricao (string, optional),

id_status (integer),

email_usuario (string, optional),

id_departamento_encaminhado (integer, optional)

}

[tony tam]

What version of swagger and which framework are you using?

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Fernando Gandini]

Using swagger-core/jersey2-jaxrs -1.5.6

and Dropwizard.

You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/Ltl11ipCNTw/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

[tony tam]

Try 1.5.7 please

[Fernando Gandini]

Still not working. Could be a problem with swagger-ui.js?

[tony tam]

I don’t think so, my guess is that swagger-core is not reading those annotations.  The best thing to share would be the swagger definition that is produced by scanning your beans.  Can you please share that?

[Fernando Gandini]

Sorry, but what do you mean by "swagger definition that is produced by scanning your beans" where do i find it?

Thanks alot.

[Fernando Gandini]

Problem seems to be solved by using  @ApiModelProperty(required = true) insted of @ApiParam(required = true)..it´s that right?!

[tony tam]

The swagger definition is the JSON that you’re loading in your swagger-ui.   For example:  http://petstore.swagger.io/v2/swagger.json.  That tells the UI what to render.

[Fernando Gandini]

Without @ApiModelProperty(required = true) and with @ApiParam(required = true)
"ProcessoInsert":{"type":"object","required":["id_ocorrencia","id_status"],"properties":{"id_ocorrencia":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"id_status":{"type":"integer","format":"int32"},"email_usuario":{"type":"string"},"id_departamento_encaminhado":{"type":"integer","format":"int32"}

With @ApiModelProperty(required = true) and without @ApiParam(required = true)

"ProcessoInsert":{"type":"object","required":["descricao","email_usuario","id_ocorrencia","id_status"],"properties":{"id_ocorrencia":{"type":"integer","format":"int32"},"descricao":{"type":"string"},"id_status":{"type":"integer","format":"int32"},"email_usuario":{"type":"string"},"id_departamento_encaminhado":{"type":"integer","format":"int32"}

Seems that  @ApiModelProperty is the right anotation?

[tony tam]

Yes, @ApiParam is for operations, not model properties.  But I did expect that @NotNull annotation would be processed by the BeanValidations.java class in swagger core.

It was added in 1.5.7 so you should try that.

[Fernando Gandini]

I think things are different, right? You can not send a parameter, but when it sends, it can not be null.

I thing one says that you must send on every request and the other says that can not