feat: api endpoints for project boards

models/fixtures/project.yml

@@ -45,3 +45,29 @@
   type: 2
   created_unix: 1688973000
   updated_unix: 1688973000
+
+# user projects
+-
+  id: 5
+  title: project on user2
+  owner_id: 2
+  repo_id: 0
+  is_closed: false
+  creator_id: 2
+  board_type: 1
+  type: 1
+  created_unix: 1688973000
+  updated_unix: 1688973000
+
+# org projects
+-
+  id: 6
+  title: project on org17
+  owner_id: 17
+  repo_id: 0
+  is_closed: false
+  creator_id: 17
+  board_type: 1
+  type: 3
+  created_unix: 1688973000
+  updated_unix: 1688973000

models/project/board.go

@@ -244,6 +244,24 @@ func (p *Project) GetBoards(ctx context.Context) (BoardList, error) {
 	return append([]*Board{defaultB}, boards...), nil
 }
 
+func (p *Project) GetBoardsAndCount(ctx context.Context) (BoardList, int64, error) {
+	boards := make([]*Board, 0, 5)
+	count, err := db.GetEngine(ctx).
+		Where("project_id=? AND `default`=?", p.ID, false).
+		OrderBy("Sorting").
+		FindAndCount(&boards)
+	if err != nil {
+		return nil, 0, err
+	}
+
+	defaultB, err := p.getDefaultBoard(ctx)
+	if err != nil {
+		return nil, 0, err
+	}
+
+	return append([]*Board{defaultB}, boards...), count, nil
+}
+
 // getDefaultBoard return default board and create a dummy if none exist
 func (p *Project) getDefaultBoard(ctx context.Context) (*Board, error) {
 	var board Board

models/project/project.go

@@ -95,6 +95,7 @@ type Project struct {
 	RepoID      int64                  `xorm:"INDEX"`
 	Repo        *repo_model.Repository `xorm:"-"`
 	CreatorID   int64                  `xorm:"NOT NULL"`
+	Creator     *user_model.User       `xorm:"-"`
 	IsClosed    bool                   `xorm:"INDEX"`
 	BoardType   BoardType
 	CardType    CardType
@@ -107,6 +108,8 @@ type Project struct {
 	ClosedDateUnix timeutil.TimeStamp
 }
 
+type ProjectList []*Project
+
 func (p *Project) LoadOwner(ctx context.Context) (err error) {
 	if p.Owner != nil {
 		return nil
@@ -115,6 +118,14 @@ func (p *Project) LoadOwner(ctx context.Context) (err error) {
 	return err
 }
 
+func (p *Project) LoadCreator(ctx context.Context) (err error) {
+	if p.Creator != nil {
+		return nil
+	}
+	p.Creator, err = user_model.GetUserByID(ctx, p.CreatorID)
+	return err
+}
+
 func (p *Project) LoadRepo(ctx context.Context) (err error) {
 	if p.RepoID == 0 || p.Repo != nil {
 		return nil
@@ -343,7 +354,11 @@ func updateRepositoryProjectCount(ctx context.Context, repoID int64) error {
 }
 
 // ChangeProjectStatusByRepoIDAndID toggles a project between opened and closed
-func ChangeProjectStatusByRepoIDAndID(ctx context.Context, repoID, projectID int64, isClosed bool) error {
+func ChangeProjectStatusByRepoIDAndID(
+	ctx context.Context,
+	repoID, projectID int64,
+	isClosed bool,
+) error {
 	ctx, committer, err := db.TxContext(ctx)
 	if err != nil {
 		return err
@@ -384,7 +399,11 @@ func ChangeProjectStatus(ctx context.Context, p *Project, isClosed bool) error {
 func changeProjectStatus(ctx context.Context, p *Project, isClosed bool) error {
 	p.IsClosed = isClosed
 	p.ClosedDateUnix = timeutil.TimeStampNow()
-	count, err := db.GetEngine(ctx).ID(p.ID).Where("repo_id = ? AND is_closed = ?", p.RepoID, !isClosed).Cols("is_closed", "closed_date_unix").Update(p)
+	count, err := db.GetEngine(ctx).
+		ID(p.ID).
+		Where("repo_id = ? AND is_closed = ?", p.RepoID, !isClosed).
+		Cols("is_closed", "closed_date_unix").
+		Update(p)
 	if err != nil {
 		return err
 	}

models/project/project_test.go

@@ -92,19 +92,19 @@ func TestProjectsSort(t *testing.T) {
 	}{
 		{
 			sortType: "default",
-			wants:    []int64{1, 3, 2, 4},
+			wants:    []int64{1, 3, 2, 4, 5, 6},
 		},
 		{
 			sortType: "oldest",
-			wants:    []int64{4, 2, 3, 1},
+			wants:    []int64{4, 5, 6, 2, 3, 1},
 		},
 		{
 			sortType: "recentupdate",
-			wants:    []int64{1, 3, 2, 4},
+			wants:    []int64{1, 3, 2, 4, 5, 6},
 		},
 		{
 			sortType: "leastupdate",
-			wants:    []int64{4, 2, 3, 1},
+			wants:    []int64{4, 5, 6, 2, 3, 1},
 		},
 	}
 
@@ -113,8 +113,8 @@ func TestProjectsSort(t *testing.T) {
 			OrderBy: GetSearchOrderByBySortType(tt.sortType),
 		})
 		assert.NoError(t, err)
-		assert.EqualValues(t, int64(4), count)
-		if assert.Len(t, projects, 4) {
+		assert.EqualValues(t, int64(6), count)
+		if assert.Len(t, projects, 6) {
 			for i := range projects {
 				assert.EqualValues(t, tt.wants[i], projects[i].ID)
 			}

modules/structs/project.go

@@ -0,0 +1,42 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package structs
+
+import "time"
+
+// swagger:model
+type NewProjectPayload struct {
+	// required:true
+	Title string `json:"title"       binding:"Required"`
+	// required:true
+	BoardType uint8 `json:"board_type"`
+	// required:true
+	CardType    uint8  `json:"card_type"`
+	Description string `json:"description"`
+}
+
+// swagger:model
+type UpdateProjectPayload struct {
+	// required:true
+	Title       string `json:"title"       binding:"Required"`
+	Description string `json:"description"`
+}
+
+type Project struct {
+	ID          int64  `json:"id"`
+	Title       string `json:"title"`
+	Description string `json:"description"`
+	BoardType   uint8  `json:"board_type"`
+	IsClosed    bool   `json:"is_closed"`
+	// swagger:strfmt date-time
+	Created time.Time `json:"created_at"`
+	// swagger:strfmt date-time
+	Updated time.Time `json:"updated_at"`
+	// swagger:strfmt date-time
+	Closed time.Time `json:"closed_at"`
+
+	Repo    *RepositoryMeta `json:"repository"`
+	Creator *User           `json:"creator"`
+	Owner   *User           `json:"owner"`
+}

modules/structs/project_board.go

@@ -0,0 +1,35 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package structs
+
+import "time"
+
+type ProjectBoard struct {
+	ID      int64    `json:"id"`
+	Title   string   `json:"title"`
+	Default bool     `json:"default"`
+	Color   string   `json:"color"`
+	Sorting int8     `json:"sorting"`
+	Project *Project `json:"project"`
+	Creator *User    `json:"creator"`
+	// swagger:strfmt date-time
+	Created time.Time `json:"created_at"`
+	// swagger:strfmt date-time
+	Updated time.Time `json:"updated_at"`
+}
+
+// swagger:model
+type NewProjectBoardPayload struct {
+	// required:true
+	Title   string `json:"title"`
+	Default bool   `json:"default"`
+	Color   string `json:"color"`
+	Sorting int8   `json:"sorting`
+}
+
+// swagger:model
+type UpdateProjectBoardPayload struct {
+	Title string `json:"title"`
+	Color string `json:"color"`
+}

routers/api/v1/api.go

@@ -90,6 +90,7 @@ import (
 	"code.gitea.io/gitea/routers/api/v1/notify"
 	"code.gitea.io/gitea/routers/api/v1/org"
 	"code.gitea.io/gitea/routers/api/v1/packages"
+	"code.gitea.io/gitea/routers/api/v1/projects"
 	"code.gitea.io/gitea/routers/api/v1/repo"
 	"code.gitea.io/gitea/routers/api/v1/settings"
 	"code.gitea.io/gitea/routers/api/v1/user"
@@ -1029,6 +1030,10 @@ func Routes() *web.Route {
 				m.Post("", bind(api.UpdateUserAvatarOption{}), user.UpdateAvatar)
 				m.Delete("", user.DeleteAvatar)
 			}, reqToken())
+
+			m.Combo("/projects", tokenRequiresScopes(auth_model.AccessTokenScopeCategoryIssue)).
+				Get(projects.ListUserProjects).
+				Post(bind(api.NewProjectPayload{}), projects.CreateUserProject)
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser), reqToken())
 
 		// Repositories (requires repo scope, org scope)
@@ -1402,6 +1407,10 @@ func Routes() *web.Route {
 						Patch(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), bind(api.EditMilestoneOption{}), repo.EditMilestone).
 						Delete(reqToken(), reqRepoWriter(unit.TypeIssues, unit.TypePullRequests), repo.DeleteMilestone)
 				})
+				m.Group("/projects", func() {
+					m.Combo("").Get(projects.ListRepoProjects).
+						Post(bind(api.NewProjectPayload{}), projects.CreateRepoProject)
+				}, mustEnableIssues)
 			}, repoAssignment())
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryIssue))
 
@@ -1476,6 +1485,10 @@ func Routes() *web.Route {
 				m.Delete("", org.DeleteAvatar)
 			}, reqToken(), reqOrgOwnership())
 			m.Get("/activities/feeds", org.ListOrgActivityFeeds)
+			m.Group("/projects", func() {
+				m.Combo("").Get(projects.ListOrgProjects).
+					Post(bind(api.NewProjectPayload{}), projects.CreateOrgProject)
+			}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryIssue), reqToken(), reqOrgMembership())
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), orgAssignment(true))
 		m.Group("/teams/{teamid}", func() {
 			m.Combo("").Get(reqToken(), org.GetTeam).
@@ -1541,6 +1554,25 @@ func Routes() *web.Route {
 			})
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryAdmin), reqToken(), reqSiteAdmin())
 
+		m.Group("/projects", func() {
+			m.Group("/{projectId}", func() {
+				m.Combo("").
+					Get(projects.GetProject).
+					Patch(bind(api.UpdateProjectPayload{}), projects.UpdateProject).
+					Delete(projects.DeleteProject)
+				m.Combo("/boards").
+					Get(projects.ListProjectBoards).
+					Post(bind(api.NewProjectBoardPayload{}), projects.CreateProjectBoard)
+			})
+
+			m.Group("/boards", func() {
+				m.Combo("/{boardId}").
+					Get(projects.GetProjectBoard).
+					Patch(bind(api.UpdateProjectBoardPayload{}), projects.UpdateProjectBoard).
+					Delete(projects.DeleteProjectBoard)
+			})
+
+		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryIssue), reqToken())
 		m.Group("/topics", func() {
 			m.Get("/search", repo.TopicSearch)
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository))