123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878 |
- // Copyright 2015 The Gogs Authors. All rights reserved.
- // Copyright 2016 The Gitea Authors. All rights reserved.
- // Use of this source code is governed by a MIT-style
- // license that can be found in the LICENSE file.
-
- // Package v1 Gitea API.
- //
- // This documentation describes the Gitea API.
- //
- // Schemes: http, https
- // BasePath: /api/v1
- // Version: 1.1.1
- // License: MIT http://opensource.org/licenses/MIT
- //
- // Consumes:
- // - application/json
- // - text/plain
- //
- // Produces:
- // - application/json
- // - text/html
- //
- // Security:
- // - BasicAuth :
- // - Token :
- // - AccessToken :
- // - AuthorizationHeaderToken :
- // - SudoParam :
- // - SudoHeader :
- //
- // SecurityDefinitions:
- // BasicAuth:
- // type: basic
- // Token:
- // type: apiKey
- // name: token
- // in: query
- // AccessToken:
- // type: apiKey
- // name: access_token
- // in: query
- // AuthorizationHeaderToken:
- // type: apiKey
- // name: Authorization
- // in: header
- // description: API tokens must be prepended with "token" followed by a space.
- // SudoParam:
- // type: apiKey
- // name: sudo
- // in: query
- // description: Sudo API request as the user provided as the key. Admin privileges are required.
- // SudoHeader:
- // type: apiKey
- // name: Sudo
- // in: header
- // description: Sudo API request as the user provided as the key. Admin privileges are required.
- //
- // swagger:meta
- package v1
-
- import (
- "strings"
-
- "code.gitea.io/gitea/models"
- "code.gitea.io/gitea/modules/auth"
- "code.gitea.io/gitea/modules/context"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/setting"
- api "code.gitea.io/gitea/modules/structs"
- "code.gitea.io/gitea/routers/api/v1/admin"
- "code.gitea.io/gitea/routers/api/v1/misc"
- "code.gitea.io/gitea/routers/api/v1/org"
- "code.gitea.io/gitea/routers/api/v1/repo"
- _ "code.gitea.io/gitea/routers/api/v1/swagger" // for swagger generation
- "code.gitea.io/gitea/routers/api/v1/user"
-
- "gitea.com/macaron/binding"
- "gitea.com/macaron/macaron"
- )
-
- func sudo() macaron.Handler {
- return func(ctx *context.APIContext) {
- sudo := ctx.Query("sudo")
- if len(sudo) == 0 {
- sudo = ctx.Req.Header.Get("Sudo")
- }
-
- if len(sudo) > 0 {
- if ctx.IsSigned && ctx.User.IsAdmin {
- user, err := models.GetUserByName(sudo)
- if err != nil {
- if models.IsErrUserNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(500, "GetUserByName", err)
- }
- return
- }
- log.Trace("Sudo from (%s) to: %s", ctx.User.Name, user.Name)
- ctx.User = user
- } else {
- ctx.JSON(403, map[string]string{
- "message": "Only administrators allowed to sudo.",
- })
- return
- }
- }
- }
- }
-
- func repoAssignment() macaron.Handler {
- return func(ctx *context.APIContext) {
- userName := ctx.Params(":username")
- repoName := ctx.Params(":reponame")
-
- var (
- owner *models.User
- err error
- )
-
- // Check if the user is the same as the repository owner.
- if ctx.IsSigned && ctx.User.LowerName == strings.ToLower(userName) {
- owner = ctx.User
- } else {
- owner, err = models.GetUserByName(userName)
- if err != nil {
- if models.IsErrUserNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(500, "GetUserByName", err)
- }
- return
- }
- }
- ctx.Repo.Owner = owner
-
- // Get repository.
- repo, err := models.GetRepositoryByName(owner.ID, repoName)
- if err != nil {
- if models.IsErrRepoNotExist(err) {
- redirectRepoID, err := models.LookupRepoRedirect(owner.ID, repoName)
- if err == nil {
- context.RedirectToRepo(ctx.Context, redirectRepoID)
- } else if models.IsErrRepoRedirectNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(500, "LookupRepoRedirect", err)
- }
- } else {
- ctx.Error(500, "GetRepositoryByName", err)
- }
- return
- }
-
- repo.Owner = owner
- ctx.Repo.Repository = repo
-
- ctx.Repo.Permission, err = models.GetUserRepoPermission(repo, ctx.User)
- if err != nil {
- ctx.Error(500, "GetUserRepoPermission", err)
- return
- }
-
- if !ctx.Repo.HasAccess() {
- ctx.NotFound()
- return
- }
- }
- }
-
- // Contexter middleware already checks token for user sign in process.
- func reqToken() macaron.Handler {
- return func(ctx *context.APIContext) {
- if true == ctx.Data["IsApiToken"] {
- return
- }
- if ctx.Context.IsBasicAuth {
- ctx.CheckForOTP()
- return
- }
- if ctx.IsSigned {
- ctx.RequireCSRF()
- return
- }
- ctx.Context.Error(401)
- }
- }
-
- func reqBasicAuth() macaron.Handler {
- return func(ctx *context.APIContext) {
- if !ctx.Context.IsBasicAuth {
- ctx.Context.Error(401)
- return
- }
- ctx.CheckForOTP()
- }
- }
-
- // reqSiteAdmin user should be the site admin
- func reqSiteAdmin() macaron.Handler {
- return func(ctx *context.Context) {
- if !ctx.IsUserSiteAdmin() {
- ctx.Error(403)
- return
- }
- }
- }
-
- // reqOwner user should be the owner of the repo or site admin.
- func reqOwner() macaron.Handler {
- return func(ctx *context.Context) {
- if !ctx.IsUserRepoOwner() && !ctx.IsUserSiteAdmin() {
- ctx.Error(403)
- return
- }
- }
- }
-
- // reqAdmin user should be an owner or a collaborator with admin write of a repository, or site admin
- func reqAdmin() macaron.Handler {
- return func(ctx *context.Context) {
- if !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
- ctx.Error(403)
- return
- }
- }
- }
-
- // reqRepoWriter user should have a permission to write to a repo, or be a site admin
- func reqRepoWriter(unitTypes ...models.UnitType) macaron.Handler {
- return func(ctx *context.Context) {
- if !ctx.IsUserRepoWriter(unitTypes) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
- ctx.Error(403)
- return
- }
- }
- }
-
- // reqRepoReader user should have specific read permission or be a repo admin or a site admin
- func reqRepoReader(unitType models.UnitType) macaron.Handler {
- return func(ctx *context.Context) {
- if !ctx.IsUserRepoReaderSpecific(unitType) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
- ctx.Error(403)
- return
- }
- }
- }
-
- // reqAnyRepoReader user should have any permission to read repository or permissions of site admin
- func reqAnyRepoReader() macaron.Handler {
- return func(ctx *context.Context) {
- if !ctx.IsUserRepoReaderAny() && !ctx.IsUserSiteAdmin() {
- ctx.Error(403)
- return
- }
- }
- }
-
- // reqOrgOwnership user should be an organization owner, or a site admin
- func reqOrgOwnership() macaron.Handler {
- return func(ctx *context.APIContext) {
- if ctx.Context.IsUserSiteAdmin() {
- return
- }
-
- var orgID int64
- if ctx.Org.Organization != nil {
- orgID = ctx.Org.Organization.ID
- } else if ctx.Org.Team != nil {
- orgID = ctx.Org.Team.OrgID
- } else {
- ctx.Error(500, "", "reqOrgOwnership: unprepared context")
- return
- }
-
- isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID)
- if err != nil {
- ctx.Error(500, "IsOrganizationOwner", err)
- return
- } else if !isOwner {
- if ctx.Org.Organization != nil {
- ctx.Error(403, "", "Must be an organization owner")
- } else {
- ctx.NotFound()
- }
- return
- }
- }
- }
-
- // reqTeamMembership user should be an team member, or a site admin
- func reqTeamMembership() macaron.Handler {
- return func(ctx *context.APIContext) {
- if ctx.Context.IsUserSiteAdmin() {
- return
- }
- if ctx.Org.Team == nil {
- ctx.Error(500, "", "reqTeamMembership: unprepared context")
- return
- }
-
- var orgID = ctx.Org.Team.OrgID
- isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID)
- if err != nil {
- ctx.Error(500, "IsOrganizationOwner", err)
- return
- } else if isOwner {
- return
- }
-
- if isTeamMember, err := models.IsTeamMember(orgID, ctx.Org.Team.ID, ctx.User.ID); err != nil {
- ctx.Error(500, "IsTeamMember", err)
- return
- } else if !isTeamMember {
- isOrgMember, err := models.IsOrganizationMember(orgID, ctx.User.ID)
- if err != nil {
- ctx.Error(500, "IsOrganizationMember", err)
- } else if isOrgMember {
- ctx.Error(403, "", "Must be a team member")
- } else {
- ctx.NotFound()
- }
- return
- }
- }
- }
-
- // reqOrgMembership user should be an organization member, or a site admin
- func reqOrgMembership() macaron.Handler {
- return func(ctx *context.APIContext) {
- if ctx.Context.IsUserSiteAdmin() {
- return
- }
-
- var orgID int64
- if ctx.Org.Organization != nil {
- orgID = ctx.Org.Organization.ID
- } else if ctx.Org.Team != nil {
- orgID = ctx.Org.Team.OrgID
- } else {
- ctx.Error(500, "", "reqOrgMembership: unprepared context")
- return
- }
-
- if isMember, err := models.IsOrganizationMember(orgID, ctx.User.ID); err != nil {
- ctx.Error(500, "IsOrganizationMember", err)
- return
- } else if !isMember {
- if ctx.Org.Organization != nil {
- ctx.Error(403, "", "Must be an organization member")
- } else {
- ctx.NotFound()
- }
- return
- }
- }
- }
-
- func reqGitHook() macaron.Handler {
- return func(ctx *context.APIContext) {
- if !ctx.User.CanEditGitHook() {
- ctx.Error(403, "", "must be allowed to edit Git hooks")
- return
- }
- }
- }
-
- func orgAssignment(args ...bool) macaron.Handler {
- var (
- assignOrg bool
- assignTeam bool
- )
- if len(args) > 0 {
- assignOrg = args[0]
- }
- if len(args) > 1 {
- assignTeam = args[1]
- }
- return func(ctx *context.APIContext) {
- ctx.Org = new(context.APIOrganization)
-
- var err error
- if assignOrg {
- ctx.Org.Organization, err = models.GetOrgByName(ctx.Params(":orgname"))
- if err != nil {
- if models.IsErrOrgNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(500, "GetOrgByName", err)
- }
- return
- }
- }
-
- if assignTeam {
- ctx.Org.Team, err = models.GetTeamByID(ctx.ParamsInt64(":teamid"))
- if err != nil {
- if models.IsErrUserNotExist(err) {
- ctx.NotFound()
- } else {
- ctx.Error(500, "GetTeamById", err)
- }
- return
- }
- }
- }
- }
-
- func mustEnableIssues(ctx *context.APIContext) {
- if !ctx.Repo.CanRead(models.UnitTypeIssues) {
- if log.IsTrace() {
- if ctx.IsSigned {
- log.Trace("Permission Denied: User %-v cannot read %-v in Repo %-v\n"+
- "User in Repo has Permissions: %-+v",
- ctx.User,
- models.UnitTypeIssues,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- } else {
- log.Trace("Permission Denied: Anonymous user cannot read %-v in Repo %-v\n"+
- "Anonymous user in Repo has Permissions: %-+v",
- models.UnitTypeIssues,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- }
- }
- ctx.NotFound()
- return
- }
- }
-
- func mustAllowPulls(ctx *context.APIContext) {
- if !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(models.UnitTypePullRequests)) {
- if ctx.Repo.Repository.CanEnablePulls() && log.IsTrace() {
- if ctx.IsSigned {
- log.Trace("Permission Denied: User %-v cannot read %-v in Repo %-v\n"+
- "User in Repo has Permissions: %-+v",
- ctx.User,
- models.UnitTypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- } else {
- log.Trace("Permission Denied: Anonymous user cannot read %-v in Repo %-v\n"+
- "Anonymous user in Repo has Permissions: %-+v",
- models.UnitTypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- }
- }
- ctx.NotFound()
- return
- }
- }
-
- func mustEnableIssuesOrPulls(ctx *context.APIContext) {
- if !ctx.Repo.CanRead(models.UnitTypeIssues) &&
- !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(models.UnitTypePullRequests)) {
- if ctx.Repo.Repository.CanEnablePulls() && log.IsTrace() {
- if ctx.IsSigned {
- log.Trace("Permission Denied: User %-v cannot read %-v and %-v in Repo %-v\n"+
- "User in Repo has Permissions: %-+v",
- ctx.User,
- models.UnitTypeIssues,
- models.UnitTypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- } else {
- log.Trace("Permission Denied: Anonymous user cannot read %-v and %-v in Repo %-v\n"+
- "Anonymous user in Repo has Permissions: %-+v",
- models.UnitTypeIssues,
- models.UnitTypePullRequests,
- ctx.Repo.Repository,
- ctx.Repo.Permission)
- }
- }
- ctx.NotFound()
- return
- }
- }
-
- func mustEnableUserHeatmap(ctx *context.APIContext) {
- if !setting.Service.EnableUserHeatmap {
- ctx.NotFound()
- return
- }
- }
-
- func mustNotBeArchived(ctx *context.APIContext) {
- if ctx.Repo.Repository.IsArchived {
- ctx.NotFound()
- return
- }
- }
-
- // RegisterRoutes registers all v1 APIs routes to web application.
- // FIXME: custom form error response
- func RegisterRoutes(m *macaron.Macaron) {
- bind := binding.Bind
-
- if setting.API.EnableSwagger {
- m.Get("/swagger", misc.Swagger) //Render V1 by default
- }
-
- m.Group("/v1", func() {
- // Miscellaneous
- if setting.API.EnableSwagger {
- m.Get("/swagger", misc.Swagger)
- }
- m.Get("/version", misc.Version)
- m.Get("/signing-key.gpg", misc.SigningKey)
- m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
- m.Post("/markdown/raw", misc.MarkdownRaw)
-
- // Users
- m.Group("/users", func() {
- m.Get("/search", user.Search)
-
- m.Group("/:username", func() {
- m.Get("", user.GetInfo)
- m.Get("/heatmap", mustEnableUserHeatmap, user.GetUserHeatmapData)
-
- m.Get("/repos", user.ListUserRepos)
- m.Group("/tokens", func() {
- m.Combo("").Get(user.ListAccessTokens).
- Post(bind(api.CreateAccessTokenOption{}), user.CreateAccessToken)
- m.Combo("/:id").Delete(user.DeleteAccessToken)
- }, reqBasicAuth())
- })
- })
-
- m.Group("/users", func() {
- m.Group("/:username", func() {
- m.Get("/keys", user.ListPublicKeys)
- m.Get("/gpg_keys", user.ListGPGKeys)
-
- m.Get("/followers", user.ListFollowers)
- m.Group("/following", func() {
- m.Get("", user.ListFollowing)
- m.Get("/:target", user.CheckFollowing)
- })
-
- m.Get("/starred", user.GetStarredRepos)
-
- m.Get("/subscriptions", user.GetWatchedRepos)
- })
- }, reqToken())
-
- m.Group("/user", func() {
- m.Get("", user.GetAuthenticatedUser)
- m.Combo("/emails").Get(user.ListEmails).
- Post(bind(api.CreateEmailOption{}), user.AddEmail).
- Delete(bind(api.DeleteEmailOption{}), user.DeleteEmail)
-
- m.Get("/followers", user.ListMyFollowers)
- m.Group("/following", func() {
- m.Get("", user.ListMyFollowing)
- m.Combo("/:username").Get(user.CheckMyFollowing).Put(user.Follow).Delete(user.Unfollow)
- })
-
- m.Group("/keys", func() {
- m.Combo("").Get(user.ListMyPublicKeys).
- Post(bind(api.CreateKeyOption{}), user.CreatePublicKey)
- m.Combo("/:id").Get(user.GetPublicKey).
- Delete(user.DeletePublicKey)
- })
-
- m.Group("/gpg_keys", func() {
- m.Combo("").Get(user.ListMyGPGKeys).
- Post(bind(api.CreateGPGKeyOption{}), user.CreateGPGKey)
- m.Combo("/:id").Get(user.GetGPGKey).
- Delete(user.DeleteGPGKey)
- })
-
- m.Combo("/repos").Get(user.ListMyRepos).
- Post(bind(api.CreateRepoOption{}), repo.Create)
-
- m.Group("/starred", func() {
- m.Get("", user.GetMyStarredRepos)
- m.Group("/:username/:reponame", func() {
- m.Get("", user.IsStarring)
- m.Put("", user.Star)
- m.Delete("", user.Unstar)
- }, repoAssignment())
- })
- m.Get("/times", repo.ListMyTrackedTimes)
-
- m.Get("/subscriptions", user.GetMyWatchedRepos)
-
- m.Get("/teams", org.ListUserTeams)
- }, reqToken())
-
- // Repositories
- m.Post("/org/:org/repos", reqToken(), bind(api.CreateRepoOption{}), repo.CreateOrgRepo)
-
- m.Group("/repos", func() {
- m.Get("/search", repo.Search)
- })
-
- m.Get("/repos/issues/search", repo.SearchIssues)
-
- m.Combo("/repositories/:id", reqToken()).Get(repo.GetByID)
-
- m.Group("/repos", func() {
- m.Post("/migrate", reqToken(), bind(auth.MigrateRepoForm{}), repo.Migrate)
-
- m.Group("/:username/:reponame", func() {
- m.Combo("").Get(reqAnyRepoReader(), repo.Get).
- Delete(reqToken(), reqOwner(), repo.Delete).
- Patch(reqToken(), reqAdmin(), bind(api.EditRepoOption{}), repo.Edit)
- m.Group("/hooks", func() {
- m.Combo("").Get(repo.ListHooks).
- Post(bind(api.CreateHookOption{}), repo.CreateHook)
- m.Group("/:id", func() {
- m.Combo("").Get(repo.GetHook).
- Patch(bind(api.EditHookOption{}), repo.EditHook).
- Delete(repo.DeleteHook)
- m.Post("/tests", context.RepoRef(), repo.TestHook)
- })
- m.Group("/git", func() {
- m.Combo("").Get(repo.ListGitHooks)
- m.Group("/:id", func() {
- m.Combo("").Get(repo.GetGitHook).
- Patch(bind(api.EditGitHookOption{}), repo.EditGitHook).
- Delete(repo.DeleteGitHook)
- })
- }, reqGitHook(), context.ReferencesGitRepo(true))
- }, reqToken(), reqAdmin())
- m.Group("/collaborators", func() {
- m.Get("", repo.ListCollaborators)
- m.Combo("/:collaborator").Get(repo.IsCollaborator).
- Put(bind(api.AddCollaboratorOption{}), repo.AddCollaborator).
- Delete(repo.DeleteCollaborator)
- }, reqToken(), reqAdmin())
- m.Get("/raw/*", context.RepoRefByType(context.RepoRefAny), reqRepoReader(models.UnitTypeCode), repo.GetRawFile)
- m.Get("/archive/*", reqRepoReader(models.UnitTypeCode), repo.GetArchive)
- m.Combo("/forks").Get(repo.ListForks).
- Post(reqToken(), reqRepoReader(models.UnitTypeCode), bind(api.CreateForkOption{}), repo.CreateFork)
- m.Group("/branches", func() {
- m.Get("", repo.ListBranches)
- m.Get("/*", context.RepoRefByType(context.RepoRefBranch), repo.GetBranch)
- }, reqRepoReader(models.UnitTypeCode))
- m.Group("/tags", func() {
- m.Get("", repo.ListTags)
- }, reqRepoReader(models.UnitTypeCode))
- m.Group("/keys", func() {
- m.Combo("").Get(repo.ListDeployKeys).
- Post(bind(api.CreateKeyOption{}), repo.CreateDeployKey)
- m.Combo("/:id").Get(repo.GetDeployKey).
- Delete(repo.DeleteDeploykey)
- }, reqToken(), reqAdmin())
- m.Group("/times", func() {
- m.Combo("").Get(repo.ListTrackedTimesByRepository)
- m.Combo("/:timetrackingusername").Get(repo.ListTrackedTimesByUser)
- }, mustEnableIssues)
- m.Group("/issues", func() {
- m.Combo("").Get(repo.ListIssues).
- Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueOption{}), repo.CreateIssue)
- m.Group("/comments", func() {
- m.Get("", repo.ListRepoIssueComments)
- m.Combo("/:id", reqToken()).
- Patch(mustNotBeArchived, bind(api.EditIssueCommentOption{}), repo.EditIssueComment).
- Delete(repo.DeleteIssueComment)
- })
- m.Group("/:index", func() {
- m.Combo("").Get(repo.GetIssue).
- Patch(reqToken(), bind(api.EditIssueOption{}), repo.EditIssue)
-
- m.Group("/comments", func() {
- m.Combo("").Get(repo.ListIssueComments).
- Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueCommentOption{}), repo.CreateIssueComment)
- m.Combo("/:id", reqToken()).Patch(bind(api.EditIssueCommentOption{}), repo.EditIssueCommentDeprecated).
- Delete(repo.DeleteIssueCommentDeprecated)
- })
-
- m.Group("/labels", func() {
- m.Combo("").Get(repo.ListIssueLabels).
- Post(reqToken(), bind(api.IssueLabelsOption{}), repo.AddIssueLabels).
- Put(reqToken(), bind(api.IssueLabelsOption{}), repo.ReplaceIssueLabels).
- Delete(reqToken(), repo.ClearIssueLabels)
- m.Delete("/:id", reqToken(), repo.DeleteIssueLabel)
- })
-
- m.Group("/times", func() {
- m.Combo("").Get(repo.ListTrackedTimes).
- Post(reqToken(), bind(api.AddTimeOption{}), repo.AddTime)
- })
-
- m.Combo("/deadline").Post(reqToken(), bind(api.EditDeadlineOption{}), repo.UpdateIssueDeadline)
- m.Group("/stopwatch", func() {
- m.Post("/start", reqToken(), repo.StartIssueStopwatch)
- m.Post("/stop", reqToken(), repo.StopIssueStopwatch)
- })
- })
- }, mustEnableIssuesOrPulls)
- m.Group("/labels", func() {
- m.Combo("").Get(repo.ListLabels).
- Post(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.CreateLabelOption{}), repo.CreateLabel)
- m.Combo("/:id").Get(repo.GetLabel).
- Patch(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.EditLabelOption{}), repo.EditLabel).
- Delete(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), repo.DeleteLabel)
- })
- m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
- m.Post("/markdown/raw", misc.MarkdownRaw)
- m.Group("/milestones", func() {
- m.Combo("").Get(repo.ListMilestones).
- Post(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.CreateMilestoneOption{}), repo.CreateMilestone)
- m.Combo("/:id").Get(repo.GetMilestone).
- Patch(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.EditMilestoneOption{}), repo.EditMilestone).
- Delete(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), repo.DeleteMilestone)
- })
- m.Get("/stargazers", repo.ListStargazers)
- m.Get("/subscribers", repo.ListSubscribers)
- m.Group("/subscription", func() {
- m.Get("", user.IsWatching)
- m.Put("", reqToken(), user.Watch)
- m.Delete("", reqToken(), user.Unwatch)
- })
- m.Group("/releases", func() {
- m.Combo("").Get(repo.ListReleases).
- Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.CreateReleaseOption{}), repo.CreateRelease)
- m.Group("/:id", func() {
- m.Combo("").Get(repo.GetRelease).
- Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.EditReleaseOption{}), repo.EditRelease).
- Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteRelease)
- m.Group("/assets", func() {
- m.Combo("").Get(repo.ListReleaseAttachments).
- Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.CreateReleaseAttachment)
- m.Combo("/:asset").Get(repo.GetReleaseAttachment).
- Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), bind(api.EditAttachmentOptions{}), repo.EditReleaseAttachment).
- Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteReleaseAttachment)
- })
- })
- }, reqRepoReader(models.UnitTypeReleases))
- m.Post("/mirror-sync", reqToken(), reqRepoWriter(models.UnitTypeCode), repo.MirrorSync)
- m.Get("/editorconfig/:filename", context.RepoRef(), reqRepoReader(models.UnitTypeCode), repo.GetEditorconfig)
- m.Group("/pulls", func() {
- m.Combo("").Get(bind(api.ListPullRequestsOptions{}), repo.ListPullRequests).
- Post(reqToken(), mustNotBeArchived, bind(api.CreatePullRequestOption{}), repo.CreatePullRequest)
- m.Group("/:index", func() {
- m.Combo("").Get(repo.GetPullRequest).
- Patch(reqToken(), reqRepoWriter(models.UnitTypePullRequests), bind(api.EditPullRequestOption{}), repo.EditPullRequest)
- m.Combo("/merge").Get(repo.IsPullRequestMerged).
- Post(reqToken(), mustNotBeArchived, reqRepoWriter(models.UnitTypePullRequests), bind(auth.MergePullRequestForm{}), repo.MergePullRequest)
- })
- }, mustAllowPulls, reqRepoReader(models.UnitTypeCode), context.ReferencesGitRepo(false))
- m.Group("/statuses", func() {
- m.Combo("/:sha").Get(repo.GetCommitStatuses).
- Post(reqToken(), bind(api.CreateStatusOption{}), repo.NewCommitStatus)
- }, reqRepoReader(models.UnitTypeCode))
- m.Group("/commits", func() {
- m.Get("", repo.GetAllCommits)
- m.Group("/:ref", func() {
- // TODO: Add m.Get("") for single commit (https://developer.github.com/v3/repos/commits/#get-a-single-commit)
- m.Get("/status", repo.GetCombinedCommitStatusByRef)
- m.Get("/statuses", repo.GetCommitStatusesByRef)
- })
- }, reqRepoReader(models.UnitTypeCode))
- m.Group("/git", func() {
- m.Group("/commits", func() {
- m.Get("/:sha", repo.GetSingleCommit)
- })
- m.Get("/refs", repo.GetGitAllRefs)
- m.Get("/refs/*", repo.GetGitRefs)
- m.Get("/trees/:sha", context.RepoRef(), repo.GetTree)
- m.Get("/blobs/:sha", context.RepoRef(), repo.GetBlob)
- m.Get("/tags/:sha", context.RepoRef(), repo.GetTag)
- }, reqRepoReader(models.UnitTypeCode))
- m.Group("/contents", func() {
- m.Get("", repo.GetContentsList)
- m.Get("/*", repo.GetContents)
- m.Group("/*", func() {
- m.Post("", bind(api.CreateFileOptions{}), repo.CreateFile)
- m.Put("", bind(api.UpdateFileOptions{}), repo.UpdateFile)
- m.Delete("", bind(api.DeleteFileOptions{}), repo.DeleteFile)
- }, reqRepoWriter(models.UnitTypeCode), reqToken())
- }, reqRepoReader(models.UnitTypeCode))
- m.Get("/signing-key.gpg", misc.SigningKey)
- m.Group("/topics", func() {
- m.Combo("").Get(repo.ListTopics).
- Put(reqToken(), reqAdmin(), bind(api.RepoTopicOptions{}), repo.UpdateTopics)
- m.Group("/:topic", func() {
- m.Combo("").Put(reqToken(), repo.AddTopic).
- Delete(reqToken(), repo.DeleteTopic)
- }, reqAdmin())
- }, reqAnyRepoReader())
- }, repoAssignment())
- })
-
- // Organizations
- m.Get("/user/orgs", reqToken(), org.ListMyOrgs)
- m.Get("/users/:username/orgs", org.ListUserOrgs)
- m.Post("/orgs", reqToken(), bind(api.CreateOrgOption{}), org.Create)
- m.Group("/orgs/:orgname", func() {
- m.Get("/repos", user.ListOrgRepos)
- m.Combo("").Get(org.Get).
- Patch(reqToken(), reqOrgOwnership(), bind(api.EditOrgOption{}), org.Edit).
- Delete(reqToken(), reqOrgOwnership(), org.Delete)
- m.Group("/members", func() {
- m.Get("", org.ListMembers)
- m.Combo("/:username").Get(org.IsMember).
- Delete(reqToken(), reqOrgOwnership(), org.DeleteMember)
- })
- m.Group("/public_members", func() {
- m.Get("", org.ListPublicMembers)
- m.Combo("/:username").Get(org.IsPublicMember).
- Put(reqToken(), reqOrgMembership(), org.PublicizeMember).
- Delete(reqToken(), reqOrgMembership(), org.ConcealMember)
- })
- m.Group("/teams", func() {
- m.Combo("", reqToken()).Get(org.ListTeams).
- Post(reqOrgOwnership(), bind(api.CreateTeamOption{}), org.CreateTeam)
- m.Get("/search", org.SearchTeam)
- }, reqOrgMembership())
- m.Group("/hooks", func() {
- m.Combo("").Get(org.ListHooks).
- Post(bind(api.CreateHookOption{}), org.CreateHook)
- m.Combo("/:id").Get(org.GetHook).
- Patch(bind(api.EditHookOption{}), org.EditHook).
- Delete(org.DeleteHook)
- }, reqToken(), reqOrgOwnership())
- }, orgAssignment(true))
- m.Group("/teams/:teamid", func() {
- m.Combo("").Get(org.GetTeam).
- Patch(reqOrgOwnership(), bind(api.EditTeamOption{}), org.EditTeam).
- Delete(reqOrgOwnership(), org.DeleteTeam)
- m.Group("/members", func() {
- m.Get("", org.GetTeamMembers)
- m.Combo("/:username").
- Get(org.GetTeamMember).
- Put(reqOrgOwnership(), org.AddTeamMember).
- Delete(reqOrgOwnership(), org.RemoveTeamMember)
- })
- m.Group("/repos", func() {
- m.Get("", org.GetTeamRepos)
- m.Combo("/:orgname/:reponame").
- Put(org.AddTeamRepository).
- Delete(org.RemoveTeamRepository)
- })
- }, orgAssignment(false, true), reqToken(), reqTeamMembership())
-
- m.Any("/*", func(ctx *context.APIContext) {
- ctx.NotFound()
- })
-
- m.Group("/admin", func() {
- m.Get("/orgs", admin.GetAllOrgs)
- m.Group("/users", func() {
- m.Get("", admin.GetAllUsers)
- m.Post("", bind(api.CreateUserOption{}), admin.CreateUser)
- m.Group("/:username", func() {
- m.Combo("").Patch(bind(api.EditUserOption{}), admin.EditUser).
- Delete(admin.DeleteUser)
- m.Group("/keys", func() {
- m.Post("", bind(api.CreateKeyOption{}), admin.CreatePublicKey)
- m.Delete("/:id", admin.DeleteUserPublicKey)
- })
- m.Get("/orgs", org.ListUserOrgs)
- m.Post("/orgs", bind(api.CreateOrgOption{}), admin.CreateOrg)
- m.Post("/repos", bind(api.CreateRepoOption{}), admin.CreateRepo)
- })
- })
- }, reqToken(), reqSiteAdmin())
-
- m.Group("/topics", func() {
- m.Get("/search", repo.TopicSearch)
- })
- }, securityHeaders(), context.APIContexter(), sudo())
- }
-
- func securityHeaders() macaron.Handler {
- return func(ctx *macaron.Context) {
- ctx.Resp.Before(func(w macaron.ResponseWriter) {
- // CORB: https://www.chromium.org/Home/chromium-security/corb-for-developers
- // http://stackoverflow.com/a/3146618/244009
- w.Header().Set("x-content-type-options", "nosniff")
- })
- }
- }
|