TODO items are getting picked up in swagger documentation
jscharber opened this issue · comments
Move to a location where they won't be shown
In the template files for the dataMgr, we have TODO inside the comment blocks used to generate the swagger documentation. These need to be moved above that comment block to avoid them showing up in the generated documentation. These are in the templateModel.go file
// Return list of {{.Name}}s
//
// TODO: add method of including sub attributes
//
// swagger:response {{.Name}}List
type listResponse struct {
// in: body
UUID string `json:"uuid"`
}
resulting in
"responses": [
{
"code": "200",
"desc": "Return list of filmss\n\nTODO: add method of including sub attributes",
"schema": "",
"schemaState": []
},
Proposed changes
//
// TODO: add method of including sub attributes
//
// Return list of {{.Name}}s
// swagger:response {{.Name}}List
type listResponse struct {
// in: body
UUID string `json:"uuid"`
}