beego / bee

Bee is a tool for helping develop with beego app framework.
Apache License 2.0
1.45k stars 923 forks source link

unable to generate swagger docs on multiline description #437

Open apremalal opened 7 years ago

apremalal commented 7 years ago
type ContractCreateRequest struct {
    ContactEmail   string `json:"contactEmail" valid:"email,required" description:"email of the contact"`
    BusinessUnit   string `json:"businessUnit" valid:"required" description:" this string will continue to another line, this string will continue to another line, this string will continue to another line  "`
    DeviceModel    string `json:"deviceModel" valid:"required"`
    SerialNo       string `json:"serialNo" valid:"required"`
    MAC            string `json:"mac" valid:"required"`
    Language       string `json:"language" valid:"required"`
    ExpirationDate time.Time `json:"expirationDate" valid:"required"`
}

If the description is lengthier and continues to the next line, doc generator ignores that description tag.

franzwilhelm commented 7 years ago

i think it has a maximum length