docs: create swagger api documentation for endpoints

Author: eyad-hussein

modules/structs/issue.go

@@ -115,6 +115,20 @@ type EditIssueOption struct {
 	RemoveDeadline *bool      `json:"unset_due_date"`
 }
 
+// MoveIssuesOption options for moving issues
+type MovedIssuesOption struct {
+	Issues []struct {
+		IssueID int64 `json:"issueID"`
+		Sorting int64 `json:"sorting"`
+	} `json:"issues"`
+}
+
+// UpdateIssuesOption options for updating issues
+type UpdateIssuesOption struct {
+	ProjectID int64   `json:"project_id"`
+	Issues    []int64 `json:"issues"`
+}
+
 // EditDeadlineOption options for creating a deadline
 type EditDeadlineOption struct {
 	// required:true

modules/structs/project.go

@@ -21,10 +21,26 @@ type Project struct {
 	ClosedDateUnix int64 `json:"closed_date_unix"`
 }
 
+// CreateProjectOption options for creating a project
 type CreateProjectOption struct {
 	// required:true
 	Title        string `json:"title" binding:"Required;MaxSize(100)"`
 	Content      string `json:"content"`
 	TemplateType uint8  `json:"template_type"`
 	CardType     uint8  `json:"card_type"`
 }
+
+// EditProjectOption options for editing a project
+type EditProjectOption struct {
+	Title    string `json:"title" binding:"MaxSize(100)"`
+	Content  string `json:"content"`
+	CardType uint8  `json:"card_type"`
+}
+
+// MoveColumnsOption options for moving columns
+type MovedColumnsOption struct {
+	Columns []struct {
+		ColumnID int64 `json:"columnID"`
+		Sorting  int64 `json:"sorting"`
+	} `json:"columns"`
+}

modules/structs/project_column.go

@@ -12,6 +12,14 @@ type Column struct {
 
 // EditProjectColumnOption options for editing a project column
 type EditProjectColumnOption struct {
+	Title   string `binding:"MaxSize(100)"`
+	Sorting int8
+	Color   string `binding:"MaxSize(7)"`
+}
+
+// CreateProjectColumnOption options for creating a project column
+type CreateProjectColumnOption struct {
+	// required:true
 	Title   string `binding:"Required;MaxSize(100)"`
 	Sorting int8
 	Color   string `binding:"MaxSize(7)"`

routers/api/v1/api.go

@@ -1026,9 +1026,9 @@ func Routes() *web.Router {
 				m.Group("", func() {
 					m.Post("", bind(api.CreateProjectOption{}), project_shared.ProjectHandler("org", project_shared.CreateProject))
 					m.Group("/{id}", func() {
-						m.Post("", bind(api.EditProjectColumnOption{}), project_shared.ProjectHandler("org", project_shared.AddColumnToProject))
+						m.Post("", bind(api.CreateProjectColumnOption{}), project_shared.ProjectHandler("org", project_shared.AddColumnToProject))
 						m.Delete("", project_shared.ProjectHandler("org", project_shared.DeleteProject))
-						m.Put("", bind(api.CreateProjectOption{}), project_shared.ProjectHandler("org", project_shared.EditProject))
+						m.Put("", bind(api.EditProjectOption{}), project_shared.ProjectHandler("org", project_shared.EditProject))
 						m.Post("/move", project_shared.MoveColumns)
 						m.Post("/{action:open|close}", project_shared.ChangeProjectStatus)
 
@@ -1055,9 +1055,9 @@ func Routes() *web.Router {
 				m.Group("", func() {
 					m.Post("", bind(api.CreateProjectOption{}), project_shared.ProjectHandler("repo", project_shared.CreateProject))
 					m.Group("/{id}", func() {
-						m.Post("", bind(api.EditProjectColumnOption{}), project_shared.ProjectHandler("repo", project_shared.AddColumnToProject))
+						m.Post("", bind(api.CreateProjectColumnOption{}), project_shared.ProjectHandler("repo", project_shared.AddColumnToProject))
 						m.Delete("", project_shared.ProjectHandler("repo", project_shared.DeleteProject))
-						m.Put("", bind(api.CreateProjectOption{}), project_shared.ProjectHandler("repo", project_shared.EditProject))
+						m.Put("", bind(api.EditProjectOption{}), project_shared.ProjectHandler("repo", project_shared.EditProject))
 						m.Post("/move", project_shared.MoveColumns)
 						m.Post("/{action:open|close}", project_shared.ChangeProjectStatus)