feat: api endpoints for projects

models/auth/access_token_scope.go

@@ -24,6 +24,7 @@ const (
 	AccessTokenScopeCategoryIssue
 	AccessTokenScopeCategoryRepository
 	AccessTokenScopeCategoryUser
+	AccessTokenScopeCategoryProject
 )
 
 // AllAccessTokenScopeCategories contains all access token scope categories
@@ -37,6 +38,7 @@ var AllAccessTokenScopeCategories = []AccessTokenScopeCategory{
 	AccessTokenScopeCategoryIssue,
 	AccessTokenScopeCategoryRepository,
 	AccessTokenScopeCategoryUser,
+	AccessTokenScopeCategoryProject,
 }
 
 // AccessTokenScopeLevel represents the access levels without a given scope category
@@ -82,6 +84,9 @@ const (
 
 	AccessTokenScopeReadUser  AccessTokenScope = "read:user"
 	AccessTokenScopeWriteUser AccessTokenScope = "write:user"
+
+	AccessTokenScopeReadProject  AccessTokenScope = "read:project"
+	AccessTokenScopeWriteProject AccessTokenScope = "write:project"
 )
 
 // accessTokenScopeBitmap represents a bitmap of access token scopes.
@@ -124,6 +129,9 @@ const (
 	accessTokenScopeReadUserBits  accessTokenScopeBitmap = 1 << iota
 	accessTokenScopeWriteUserBits accessTokenScopeBitmap = 1<<iota | accessTokenScopeReadUserBits
 
+	accessTokenScopeReadProjectBits  accessTokenScopeBitmap = 1 << iota
+	accessTokenScopeWriteProjectBits accessTokenScopeBitmap = 1<<iota | accessTokenScopeReadProjectBits
+
 	// The current implementation only supports up to 64 token scopes.
 	// If we need to support > 64 scopes,
 	// refactoring the whole implementation in this file (and only this file) is needed.
@@ -142,6 +150,7 @@ var allAccessTokenScopes = []AccessTokenScope{
 	AccessTokenScopeWriteIssue, AccessTokenScopeReadIssue,
 	AccessTokenScopeWriteRepository, AccessTokenScopeReadRepository,
 	AccessTokenScopeWriteUser, AccessTokenScopeReadUser,
+	AccessTokenScopeWriteProject, AccessTokenScopeReadProject,
 }
 
 // allAccessTokenScopeBits contains all access token scopes.
@@ -166,6 +175,8 @@ var allAccessTokenScopeBits = map[AccessTokenScope]accessTokenScopeBitmap{
 	AccessTokenScopeWriteRepository:   accessTokenScopeWriteRepositoryBits,
 	AccessTokenScopeReadUser:          accessTokenScopeReadUserBits,
 	AccessTokenScopeWriteUser:         accessTokenScopeWriteUserBits,
+	AccessTokenScopeReadProject:       accessTokenScopeReadProjectBits,
+	AccessTokenScopeWriteProject:      accessTokenScopeWriteProjectBits,
 }
 
 // readAccessTokenScopes maps a scope category to the read permission scope
@@ -180,6 +191,7 @@ var accessTokenScopes = map[AccessTokenScopeLevel]map[AccessTokenScopeCategory]A
 		AccessTokenScopeCategoryIssue:        AccessTokenScopeReadIssue,
 		AccessTokenScopeCategoryRepository:   AccessTokenScopeReadRepository,
 		AccessTokenScopeCategoryUser:         AccessTokenScopeReadUser,
+		AccessTokenScopeCategoryProject:      AccessTokenScopeReadProject,
 	},
 	Write: {
 		AccessTokenScopeCategoryActivityPub:  AccessTokenScopeWriteActivityPub,
@@ -191,6 +203,7 @@ var accessTokenScopes = map[AccessTokenScopeLevel]map[AccessTokenScopeCategory]A
 		AccessTokenScopeCategoryIssue:        AccessTokenScopeWriteIssue,
 		AccessTokenScopeCategoryRepository:   AccessTokenScopeWriteRepository,
 		AccessTokenScopeCategoryUser:         AccessTokenScopeWriteUser,
+		AccessTokenScopeCategoryProject:      AccessTokenScopeWriteProject,
 	},
 }
 

models/auth/access_token_scope_test.go

@@ -17,7 +17,7 @@ type scopeTestNormalize struct {
 }
 
 func TestAccessTokenScope_Normalize(t *testing.T) {
-	assert.Equal(t, []string{"activitypub", "admin", "issue", "misc", "notification", "organization", "package", "repository", "user"}, GetAccessTokenCategories())
+	assert.Equal(t, []string{"activitypub", "admin", "issue", "misc", "notification", "organization", "package", "project", "repository", "user"}, GetAccessTokenCategories())
 	tests := []scopeTestNormalize{
 		{"", "", nil},
 		{"write:misc,write:notification,read:package,write:notification,public-only", "public-only,write:misc,write:notification,read:package", nil},

models/project/column.go

@@ -34,6 +34,28 @@ const (
 	CardTypeImagesAndText
 )
 
+func (p CardType) ToString() string {
+	switch p {
+	case CardTypeImagesAndText:
+		return "ImagesAndText"
+	case CardTypeTextOnly:
+		fallthrough
+	default:
+		return "TextOnly"
+	}
+}
+
+func ToCardType(s string) CardType {
+	switch s {
+	case "ImagesAndText":
+		return CardTypeImagesAndText
+	case "TextOnly":
+		fallthrough
+	default:
+		return CardTypeTextOnly
+	}
+}
+
 // ColumnColorPattern is a regexp witch can validate ColumnColor
 var ColumnColorPattern = regexp.MustCompile("^#[0-9a-fA-F]{6}$")
 

models/project/project.go

@@ -91,6 +91,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"`
 	TemplateType TemplateType           `xorm:"'board_type'"` // TODO: rename the column to template_type
 	CardType     CardType
@@ -121,6 +122,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

models/project/template.go

@@ -25,6 +25,31 @@ const (
 	TemplateTypeBugTriage
 )
 
+func (p TemplateType) ToString() string {
+	switch p {
+	case TemplateTypeBasicKanban:
+		return "BasicKanban"
+	case TemplateTypeBugTriage:
+		return "BugTriage"
+	case TemplateTypeNone:
+		fallthrough
+	default:
+		return ""
+	}
+}
+
+// ToTemplateType converts a string to a TemplateType
+func ToTemplateType(s string) TemplateType {
+	switch s {
+	case "BasicKanban":
+		return TemplateTypeBasicKanban
+	case "BugTriage":
+		return TemplateTypeBugTriage
+	default:
+		return TemplateTypeNone
+	}
+}
+
 // GetTemplateConfigs retrieves the template configs of configurations project columns could have
 func GetTemplateConfigs() []TemplateConfig {
 	return []TemplateConfig{

modules/structs/project.go

@@ -0,0 +1,59 @@
+// Copyright 2023 The Gitea Authors. All rights reserved.
+// SPDX-License-Identifier: MIT
+
+package structs
+
+import "time"
+
+// NewProjectOption options when creating a new project
+// swagger:model
+type NewProjectOption struct {
+	// required:true
+	// Keep compatibility with Github API to use "name" instead of "title"
+	Name string `json:"name" binding:"Required"`
+	// required:true
+	// enum: , BasicKanban, BugTriage
+	// Note: this is the same as TemplateType in models/project/template.go
+	TemplateType string `json:"template_type"`
+	// required:true
+	// enum: TextOnly, ImagesAndText
+	CardType string `json:"card_type"`
+	// Keep compatibility with Github API to use "body" instead of "description"
+	Body string `json:"body"`
+}
+
+// UpdateProjectOption options when updating a project
+// swagger:model
+type UpdateProjectOption struct {
+	// required:true
+	// Keep compatibility with Github API to use "name" instead of "title"
+	Name string `json:"name" binding:"Required"`
+	// Keep compatibility with Github API to use "body" instead of "description"
+	Body string `json:"body"`
+}
+
+// Project represents a project
+// swagger:model
+type Project struct {
+	ID int64 `json:"id"`
+	// Keep compatibility with Github API to use "name" instead of "title"
+	Name string `json:"name"`
+	// Keep compatibility with Github API to use "body" instead of "description"
+	Body string `json:"body"`
+	// required:true
+	// enum: , BasicKanban, BugTriage
+	// Note: this is the same as TemplateType in models/project/template.go
+	TemplateType string `json:"template_type"`
+	// enum: open, closed
+	State string `json:"state"`
+	// 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"`
+}

routers/api/v1/api.go

@@ -89,6 +89,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"
@@ -1041,6 +1042,13 @@ func Routes() *web.Router {
 
 				m.Get("/subscriptions", user.GetWatchedRepos)
 			}, context.UserAssignmentAPI(), checkTokenPublicOnly())
+
+			m.Group("/{username}", func() {
+				m.Group("/projects", func() {
+					m.Get("", projects.ListUserProjects)
+					m.Post("", bind(api.NewProjectOption{}), projects.CreateUserProject)
+				}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryProject))
+			}, context.UserAssignmentAPI())
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryUser), reqToken())
 
 		// Users (requires user scope)
@@ -1467,6 +1475,10 @@ func Routes() *web.Router {
 				}, reqAdmin(), reqToken())
 
 				m.Methods("HEAD,GET", "/{ball_type:tarball|zipball|bundle}/*", reqRepoReader(unit.TypeCode), repo.DownloadArchive)
+
+				m.Group("/projects", func() {
+					m.Post("", bind(api.NewProjectOption{}), projects.CreateRepoProject)
+				}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryProject))
 			}, repoAssignment(), checkTokenPublicOnly())
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryRepository))
 
@@ -1687,6 +1699,11 @@ func Routes() *web.Router {
 					m.Delete("", org.UnblockUser)
 				})
 			}, reqToken(), reqOrgOwnership())
+
+			m.Group("/projects", func() {
+				m.Post("", bind(api.NewProjectOption{}), projects.CreateOrgProject)
+				m.Get("", projects.ListOrgProjects)
+			}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryProject))
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), orgAssignment(true), checkTokenPublicOnly())
 		m.Group("/teams/{teamid}", func() {
 			m.Combo("").Get(reqToken(), org.GetTeam).
@@ -1709,6 +1726,13 @@ func Routes() *web.Router {
 			m.Get("/activities/feeds", org.ListTeamActivityFeeds)
 		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryOrganization), orgAssignment(false, true), reqToken(), reqTeamMembership(), checkTokenPublicOnly())
 
+		// Projects
+		m.Group("/projects", func() {
+			m.Get("{project_id}", projects.GetProject)
+			m.Patch("{project_id}", bind(api.UpdateProjectOption{}), projects.UpdateProject)
+			m.Delete("{project_id}", projects.DeleteProject)
+		}, tokenRequiresScopes(auth_model.AccessTokenScopeCategoryProject), reqToken())
+
 		m.Group("/admin", func() {
 			m.Group("/cron", func() {
 				m.Get("", admin.ListCronTasks)