feat: api for projects
This commit is contained in:
Dinesh Salunke
407
routers/api/v1/projects/project.go
Normal file
407
routers/api/v1/projects/project.go
Normal file
@@ -0,0 +1,407 @@
|
||||
// Copyright 2023 The Gitea Authors. All rights reserved.
|
||||
// SPDX-License-Identifier: MIT
|
||||
|
||||
package projects
|
||||
|
||||
import (
|
||||
"net/http"
|
||||
|
||||
project_model "code.gitea.io/gitea/models/project"
|
||||
"code.gitea.io/gitea/modules/context"
|
||||
"code.gitea.io/gitea/modules/setting"
|
||||
api "code.gitea.io/gitea/modules/structs"
|
||||
"code.gitea.io/gitea/modules/web"
|
||||
"code.gitea.io/gitea/services/convert"
|
||||
)
|
||||
|
||||
func innerCreateProject(
|
||||
ctx *context.APIContext,
|
||||
project_type project_model.Type,
|
||||
) {
|
||||
form := web.GetForm(ctx).(*api.NewProjectPayload)
|
||||
project := &project_model.Project{
|
||||
RepoID: 0,
|
||||
OwnerID: ctx.Doer.ID,
|
||||
Title: form.Title,
|
||||
Description: form.Description,
|
||||
CreatorID: ctx.Doer.ID,
|
||||
BoardType: project_model.BoardType(form.BoardType),
|
||||
Type: project_type,
|
||||
}
|
||||
|
||||
if ctx.ContextUser != nil {
|
||||
project.OwnerID = ctx.ContextUser.ID
|
||||
}
|
||||
|
||||
if project_type == project_model.TypeRepository {
|
||||
project.RepoID = ctx.Repo.Repository.ID
|
||||
}
|
||||
|
||||
if err := project_model.NewProject(ctx, project); err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "NewProject", err)
|
||||
return
|
||||
}
|
||||
|
||||
project, err := project_model.GetProjectByID(ctx, project.ID)
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "NewProject", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.JSON(http.StatusCreated, convert.ToAPIProject(ctx, project))
|
||||
}
|
||||
|
||||
func CreateUserProject(ctx *context.APIContext) {
|
||||
// swagger:operation POST /user/projects project projectCreateUserProject
|
||||
// ---
|
||||
// summary: Create a user project
|
||||
// produces:
|
||||
// - application/json
|
||||
// consumes:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: project
|
||||
// in: body
|
||||
// required: true
|
||||
// schema: { "$ref": "#/definitions/NewProjectPayload" }
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/Project"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
innerCreateProject(ctx, project_model.TypeIndividual)
|
||||
}
|
||||
|
||||
func CreateOrgProject(ctx *context.APIContext) {
|
||||
// swagger:operation POST /orgs/{org}/projects project projectCreateOrgProject
|
||||
// ---
|
||||
// summary: Create a organization project
|
||||
// produces:
|
||||
// - application/json
|
||||
// consumes:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: org
|
||||
// in: path
|
||||
// description: owner of repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: project
|
||||
// in: body
|
||||
// required: true
|
||||
// schema: { "$ref": "#/definitions/NewProjectPayload" }
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/Project"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
innerCreateProject(ctx, project_model.TypeOrganization)
|
||||
}
|
||||
|
||||
func CreateRepoProject(ctx *context.APIContext) {
|
||||
// swagger:operation POST /repos/{owner}/{repo}/projects project projectCreateRepositoryProject
|
||||
// ---
|
||||
// summary: Create a repository project
|
||||
// produces:
|
||||
// - application/json
|
||||
// consumes:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: project
|
||||
// in: body
|
||||
// required: true
|
||||
// schema: { "$ref": "#/definitions/NewProjectPayload" }
|
||||
// responses:
|
||||
// "201":
|
||||
// "$ref": "#/responses/Project"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
innerCreateProject(ctx, project_model.TypeRepository)
|
||||
}
|
||||
|
||||
func GetProject(ctx *context.APIContext) {
|
||||
// swagger:operation GET /projects/{id} project projectGetProject
|
||||
// ---
|
||||
// summary: Get project
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: id
|
||||
// in: path
|
||||
// description: id of the project
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/Project"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
project, err := project_model.GetProjectByID(ctx, ctx.ParamsInt64(":id"))
|
||||
if err != nil {
|
||||
if project_model.IsErrProjectNotExist(err) {
|
||||
ctx.NotFound()
|
||||
} else {
|
||||
ctx.Error(http.StatusInternalServerError, "GetProjectByID", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
ctx.JSON(http.StatusOK, convert.ToAPIProject(ctx, project))
|
||||
}
|
||||
|
||||
func UpdateProject(ctx *context.APIContext) {
|
||||
// swagger:operation PATCH /projects/{id} project projectUpdateProject
|
||||
// ---
|
||||
// summary: Update project
|
||||
// produces:
|
||||
// - application/json
|
||||
// consumes:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: id
|
||||
// in: path
|
||||
// description: id of the project
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: project
|
||||
// in: body
|
||||
// required: true
|
||||
// schema: { "$ref": "#/definitions/UpdateProjectPayload" }
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/Project"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
form := web.GetForm(ctx).(*api.UpdateProjectPayload)
|
||||
project, err := project_model.GetProjectByID(ctx, ctx.ParamsInt64("id"))
|
||||
if err != nil {
|
||||
if project_model.IsErrProjectNotExist(err) {
|
||||
ctx.NotFound()
|
||||
} else {
|
||||
ctx.Error(http.StatusInternalServerError, "UpdateProject", err)
|
||||
}
|
||||
return
|
||||
}
|
||||
if project.Title != form.Title {
|
||||
project.Title = form.Title
|
||||
}
|
||||
if project.Description != form.Description {
|
||||
project.Description = form.Description
|
||||
}
|
||||
|
||||
err = project_model.UpdateProject(ctx, project)
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "UpdateProject", err)
|
||||
return
|
||||
}
|
||||
ctx.JSON(http.StatusOK, convert.ToAPIProject(ctx, project))
|
||||
}
|
||||
|
||||
func DeleteProject(ctx *context.APIContext) {
|
||||
// swagger:operation DELETE /projects/{id} project projectDeleteProject
|
||||
// ---
|
||||
// summary: Delete project
|
||||
// parameters:
|
||||
// - name: id
|
||||
// in: path
|
||||
// description: id of the project
|
||||
// type: string
|
||||
// required: true
|
||||
// responses:
|
||||
// "204":
|
||||
// "description": "Deleted the project"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
|
||||
if err := project_model.DeleteProjectByID(ctx, ctx.ParamsInt64(":id")); err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "DeleteProjectByID", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.Status(http.StatusNoContent)
|
||||
|
||||
}
|
||||
|
||||
func ListUserProjects(ctx *context.APIContext) {
|
||||
// swagger:operation GET /user/projects project projectListUserProjects
|
||||
// ---
|
||||
// summary: List repository projects
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: closed
|
||||
// in: query
|
||||
// description: include closed issues or not
|
||||
// type: boolean
|
||||
// - name: page
|
||||
// in: query
|
||||
// description: page number of results to return (1-based)
|
||||
// type: integer
|
||||
// - name: limit
|
||||
// in: query
|
||||
// description: page size of results
|
||||
// type: integer
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/ProjectList"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
projects, count, err := project_model.FindProjects(ctx, project_model.SearchOptions{
|
||||
OwnerID: ctx.Doer.ID,
|
||||
Page: ctx.FormInt("page"),
|
||||
IsClosed: ctx.FormOptionalBool("closed"),
|
||||
Type: project_model.TypeIndividual,
|
||||
})
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "Projects", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.SetLinkHeader(int(count), setting.UI.IssuePagingNum)
|
||||
ctx.SetTotalCountHeader(count)
|
||||
|
||||
apiProjects, err := convert.ToAPIProjectList(ctx, projects)
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "Projects", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.JSON(http.StatusOK, apiProjects)
|
||||
}
|
||||
|
||||
func ListOrgProjects(ctx *context.APIContext) {
|
||||
// swagger:operation GET /orgs/{org}/projects project projectListOrgProjects
|
||||
// ---
|
||||
// summary: List repository projects
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: org
|
||||
// in: path
|
||||
// description: owner of the repository
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: closed
|
||||
// in: query
|
||||
// description: include closed issues or not
|
||||
// type: boolean
|
||||
// - name: page
|
||||
// in: query
|
||||
// description: page number of results to return (1-based)
|
||||
// type: integer
|
||||
// - name: limit
|
||||
// in: query
|
||||
// description: page size of results
|
||||
// type: integer
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/ProjectList"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
projects, count, err := project_model.FindProjects(ctx, project_model.SearchOptions{
|
||||
OwnerID: ctx.Org.Organization.AsUser().ID,
|
||||
Page: ctx.FormInt("page"),
|
||||
IsClosed: ctx.FormOptionalBool("closed"),
|
||||
Type: project_model.TypeOrganization,
|
||||
})
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "Projects", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.SetLinkHeader(int(count), setting.UI.IssuePagingNum)
|
||||
ctx.SetTotalCountHeader(count)
|
||||
|
||||
apiProjects, err := convert.ToAPIProjectList(ctx, projects)
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "Projects", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.JSON(http.StatusOK, apiProjects)
|
||||
}
|
||||
|
||||
func ListRepoProjects(ctx *context.APIContext) {
|
||||
// swagger:operation GET /repos/{owner}/{repo}/projects project projectListRepositoryProjects
|
||||
// ---
|
||||
// summary: List repository projects
|
||||
// produces:
|
||||
// - application/json
|
||||
// parameters:
|
||||
// - name: owner
|
||||
// in: path
|
||||
// description: owner of the repository
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: repo
|
||||
// in: path
|
||||
// description: repo
|
||||
// type: string
|
||||
// required: true
|
||||
// - name: closed
|
||||
// in: query
|
||||
// description: include closed issues or not
|
||||
// type: boolean
|
||||
// - name: page
|
||||
// in: query
|
||||
// description: page number of results to return (1-based)
|
||||
// type: integer
|
||||
// - name: limit
|
||||
// in: query
|
||||
// description: page size of results
|
||||
// type: integer
|
||||
// responses:
|
||||
// "200":
|
||||
// "$ref": "#/responses/ProjectList"
|
||||
// "403":
|
||||
// "$ref": "#/responses/forbidden"
|
||||
// "404":
|
||||
// "$ref": "#/responses/notFound"
|
||||
projects, count, err := project_model.FindProjects(ctx, project_model.SearchOptions{
|
||||
RepoID: ctx.Repo.Repository.ID,
|
||||
Page: ctx.FormInt("page"),
|
||||
IsClosed: ctx.FormOptionalBool("closed"),
|
||||
Type: project_model.TypeRepository,
|
||||
})
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "Projects", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.SetLinkHeader(int(count), setting.UI.IssuePagingNum)
|
||||
ctx.SetTotalCountHeader(count)
|
||||
|
||||
apiProjects, err := convert.ToAPIProjectList(ctx, projects)
|
||||
if err != nil {
|
||||
ctx.Error(http.StatusInternalServerError, "Projects", err)
|
||||
return
|
||||
}
|
||||
|
||||
ctx.JSON(http.StatusOK, apiProjects)
|
||||
}
|
||||
Reference in New Issue
Block a user