You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

api.go 23KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743
  1. // Copyright 2015 The Gogs Authors. All rights reserved.
  2. // Copyright 2016 The Gitea Authors. All rights reserved.
  3. // Use of this source code is governed by a MIT-style
  4. // license that can be found in the LICENSE file.
  5. // Package v1 Gitea API.
  6. //
  7. // This documentation describes the Gitea API.
  8. //
  9. // Schemes: http, https
  10. // BasePath: /api/v1
  11. // Version: 1.1.1
  12. // License: MIT http://opensource.org/licenses/MIT
  13. //
  14. // Consumes:
  15. // - application/json
  16. // - text/plain
  17. //
  18. // Produces:
  19. // - application/json
  20. // - text/html
  21. //
  22. // Security:
  23. // - BasicAuth :
  24. // - Token :
  25. // - AccessToken :
  26. // - AuthorizationHeaderToken :
  27. // - SudoParam :
  28. // - SudoHeader :
  29. //
  30. // SecurityDefinitions:
  31. // BasicAuth:
  32. // type: basic
  33. // Token:
  34. // type: apiKey
  35. // name: token
  36. // in: query
  37. // AccessToken:
  38. // type: apiKey
  39. // name: access_token
  40. // in: query
  41. // AuthorizationHeaderToken:
  42. // type: apiKey
  43. // name: Authorization
  44. // in: header
  45. // SudoParam:
  46. // type: apiKey
  47. // name: sudo
  48. // in: query
  49. // description: Sudo API request as the user provided as the key. Admin privileges are required.
  50. // SudoHeader:
  51. // type: apiKey
  52. // name: Sudo
  53. // in: header
  54. // description: Sudo API request as the user provided as the key. Admin privileges are required.
  55. //
  56. // swagger:meta
  57. package v1
  58. import (
  59. "strings"
  60. "code.gitea.io/gitea/models"
  61. "code.gitea.io/gitea/modules/auth"
  62. "code.gitea.io/gitea/modules/context"
  63. "code.gitea.io/gitea/modules/log"
  64. "code.gitea.io/gitea/modules/setting"
  65. "code.gitea.io/gitea/routers/api/v1/admin"
  66. "code.gitea.io/gitea/routers/api/v1/misc"
  67. "code.gitea.io/gitea/routers/api/v1/org"
  68. "code.gitea.io/gitea/routers/api/v1/repo"
  69. _ "code.gitea.io/gitea/routers/api/v1/swagger" // for swagger generation
  70. "code.gitea.io/gitea/routers/api/v1/user"
  71. api "code.gitea.io/sdk/gitea"
  72. "github.com/go-macaron/binding"
  73. "gopkg.in/macaron.v1"
  74. )
  75. func sudo() macaron.Handler {
  76. return func(ctx *context.APIContext) {
  77. sudo := ctx.Query("sudo")
  78. if len(sudo) == 0 {
  79. sudo = ctx.Req.Header.Get("Sudo")
  80. }
  81. if len(sudo) > 0 {
  82. if ctx.IsSigned && ctx.User.IsAdmin {
  83. user, err := models.GetUserByName(sudo)
  84. if err != nil {
  85. if models.IsErrUserNotExist(err) {
  86. ctx.NotFound()
  87. } else {
  88. ctx.Error(500, "GetUserByName", err)
  89. }
  90. return
  91. }
  92. log.Trace("Sudo from (%s) to: %s", ctx.User.Name, user.Name)
  93. ctx.User = user
  94. } else {
  95. ctx.JSON(403, map[string]string{
  96. "message": "Only administrators allowed to sudo.",
  97. })
  98. return
  99. }
  100. }
  101. }
  102. }
  103. func repoAssignment() macaron.Handler {
  104. return func(ctx *context.APIContext) {
  105. userName := ctx.Params(":username")
  106. repoName := ctx.Params(":reponame")
  107. var (
  108. owner *models.User
  109. err error
  110. )
  111. // Check if the user is the same as the repository owner.
  112. if ctx.IsSigned && ctx.User.LowerName == strings.ToLower(userName) {
  113. owner = ctx.User
  114. } else {
  115. owner, err = models.GetUserByName(userName)
  116. if err != nil {
  117. if models.IsErrUserNotExist(err) {
  118. ctx.NotFound()
  119. } else {
  120. ctx.Error(500, "GetUserByName", err)
  121. }
  122. return
  123. }
  124. }
  125. ctx.Repo.Owner = owner
  126. // Get repository.
  127. repo, err := models.GetRepositoryByName(owner.ID, repoName)
  128. if err != nil {
  129. if models.IsErrRepoNotExist(err) {
  130. redirectRepoID, err := models.LookupRepoRedirect(owner.ID, repoName)
  131. if err == nil {
  132. context.RedirectToRepo(ctx.Context, redirectRepoID)
  133. } else if models.IsErrRepoRedirectNotExist(err) {
  134. ctx.NotFound()
  135. } else {
  136. ctx.Error(500, "LookupRepoRedirect", err)
  137. }
  138. } else {
  139. ctx.Error(500, "GetRepositoryByName", err)
  140. }
  141. return
  142. }
  143. repo.Owner = owner
  144. ctx.Repo.Repository = repo
  145. ctx.Repo.Permission, err = models.GetUserRepoPermission(repo, ctx.User)
  146. if err != nil {
  147. ctx.Error(500, "GetUserRepoPermission", err)
  148. return
  149. }
  150. if !ctx.Repo.HasAccess() {
  151. ctx.NotFound()
  152. return
  153. }
  154. }
  155. }
  156. // Contexter middleware already checks token for user sign in process.
  157. func reqToken() macaron.Handler {
  158. return func(ctx *context.APIContext) {
  159. if true == ctx.Data["IsApiToken"] {
  160. return
  161. }
  162. if ctx.IsSigned {
  163. ctx.RequireCSRF()
  164. return
  165. }
  166. ctx.Context.Error(401)
  167. }
  168. }
  169. func reqBasicAuth() macaron.Handler {
  170. return func(ctx *context.Context) {
  171. if !ctx.IsBasicAuth {
  172. ctx.Error(401)
  173. return
  174. }
  175. }
  176. }
  177. // reqSiteAdmin user should be the site admin
  178. func reqSiteAdmin() macaron.Handler {
  179. return func(ctx *context.Context) {
  180. if !ctx.IsUserSiteAdmin() {
  181. ctx.Error(403)
  182. return
  183. }
  184. }
  185. }
  186. // reqOwner user should be the owner of the repo or site admin.
  187. func reqOwner() macaron.Handler {
  188. return func(ctx *context.Context) {
  189. if !ctx.IsUserRepoOwner() && !ctx.IsUserSiteAdmin() {
  190. ctx.Error(403)
  191. return
  192. }
  193. }
  194. }
  195. // reqAdmin user should be an owner or a collaborator with admin write of a repository, or site admin
  196. func reqAdmin() macaron.Handler {
  197. return func(ctx *context.Context) {
  198. if !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
  199. ctx.Error(403)
  200. return
  201. }
  202. }
  203. }
  204. // reqRepoWriter user should have a permission to write to a repo, or be a site admin
  205. func reqRepoWriter(unitTypes ...models.UnitType) macaron.Handler {
  206. return func(ctx *context.Context) {
  207. if !ctx.IsUserRepoWriter(unitTypes) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
  208. ctx.Error(403)
  209. return
  210. }
  211. }
  212. }
  213. // reqRepoReader user should have specific read permission or be a repo admin or a site admin
  214. func reqRepoReader(unitType models.UnitType) macaron.Handler {
  215. return func(ctx *context.Context) {
  216. if !ctx.IsUserRepoReaderSpecific(unitType) && !ctx.IsUserRepoAdmin() && !ctx.IsUserSiteAdmin() {
  217. ctx.Error(403)
  218. return
  219. }
  220. }
  221. }
  222. // reqAnyRepoReader user should have any permission to read repository or permissions of site admin
  223. func reqAnyRepoReader() macaron.Handler {
  224. return func(ctx *context.Context) {
  225. if !ctx.IsUserRepoReaderAny() && !ctx.IsUserSiteAdmin() {
  226. ctx.Error(403)
  227. return
  228. }
  229. }
  230. }
  231. // reqOrgOwnership user should be an organization owner, or a site admin
  232. func reqOrgOwnership() macaron.Handler {
  233. return func(ctx *context.APIContext) {
  234. if ctx.Context.IsUserSiteAdmin() {
  235. return
  236. }
  237. var orgID int64
  238. if ctx.Org.Organization != nil {
  239. orgID = ctx.Org.Organization.ID
  240. } else if ctx.Org.Team != nil {
  241. orgID = ctx.Org.Team.OrgID
  242. } else {
  243. ctx.Error(500, "", "reqOrgOwnership: unprepared context")
  244. return
  245. }
  246. isOwner, err := models.IsOrganizationOwner(orgID, ctx.User.ID)
  247. if err != nil {
  248. ctx.Error(500, "IsOrganizationOwner", err)
  249. return
  250. } else if !isOwner {
  251. if ctx.Org.Organization != nil {
  252. ctx.Error(403, "", "Must be an organization owner")
  253. } else {
  254. ctx.NotFound()
  255. }
  256. return
  257. }
  258. }
  259. }
  260. // reqOrgMembership user should be an organization member, or a site admin
  261. func reqOrgMembership() macaron.Handler {
  262. return func(ctx *context.APIContext) {
  263. if ctx.Context.IsUserSiteAdmin() {
  264. return
  265. }
  266. var orgID int64
  267. if ctx.Org.Organization != nil {
  268. orgID = ctx.Org.Organization.ID
  269. } else if ctx.Org.Team != nil {
  270. orgID = ctx.Org.Team.OrgID
  271. } else {
  272. ctx.Error(500, "", "reqOrgMembership: unprepared context")
  273. return
  274. }
  275. if isMember, err := models.IsOrganizationMember(orgID, ctx.User.ID); err != nil {
  276. ctx.Error(500, "IsOrganizationMember", err)
  277. return
  278. } else if !isMember {
  279. if ctx.Org.Organization != nil {
  280. ctx.Error(403, "", "Must be an organization member")
  281. } else {
  282. ctx.NotFound()
  283. }
  284. return
  285. }
  286. }
  287. }
  288. func reqGitHook() macaron.Handler {
  289. return func(ctx *context.APIContext) {
  290. if !ctx.User.CanEditGitHook() {
  291. ctx.Error(403, "", "must be allowed to edit Git hooks")
  292. return
  293. }
  294. }
  295. }
  296. func orgAssignment(args ...bool) macaron.Handler {
  297. var (
  298. assignOrg bool
  299. assignTeam bool
  300. )
  301. if len(args) > 0 {
  302. assignOrg = args[0]
  303. }
  304. if len(args) > 1 {
  305. assignTeam = args[1]
  306. }
  307. return func(ctx *context.APIContext) {
  308. ctx.Org = new(context.APIOrganization)
  309. var err error
  310. if assignOrg {
  311. ctx.Org.Organization, err = models.GetOrgByName(ctx.Params(":orgname"))
  312. if err != nil {
  313. if models.IsErrOrgNotExist(err) {
  314. ctx.NotFound()
  315. } else {
  316. ctx.Error(500, "GetOrgByName", err)
  317. }
  318. return
  319. }
  320. }
  321. if assignTeam {
  322. ctx.Org.Team, err = models.GetTeamByID(ctx.ParamsInt64(":teamid"))
  323. if err != nil {
  324. if models.IsErrUserNotExist(err) {
  325. ctx.NotFound()
  326. } else {
  327. ctx.Error(500, "GetTeamById", err)
  328. }
  329. return
  330. }
  331. }
  332. }
  333. }
  334. func mustEnableIssues(ctx *context.APIContext) {
  335. if !ctx.Repo.CanRead(models.UnitTypeIssues) {
  336. ctx.NotFound()
  337. return
  338. }
  339. }
  340. func mustAllowPulls(ctx *context.APIContext) {
  341. if !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(models.UnitTypePullRequests)) {
  342. ctx.NotFound()
  343. return
  344. }
  345. }
  346. func mustEnableIssuesOrPulls(ctx *context.APIContext) {
  347. if !ctx.Repo.CanRead(models.UnitTypeIssues) &&
  348. !(ctx.Repo.Repository.CanEnablePulls() && ctx.Repo.CanRead(models.UnitTypePullRequests)) {
  349. ctx.NotFound()
  350. return
  351. }
  352. }
  353. func mustEnableUserHeatmap(ctx *context.APIContext) {
  354. if !setting.Service.EnableUserHeatmap {
  355. ctx.NotFound()
  356. return
  357. }
  358. }
  359. func mustNotBeArchived(ctx *context.APIContext) {
  360. if ctx.Repo.Repository.IsArchived {
  361. ctx.NotFound()
  362. return
  363. }
  364. }
  365. // RegisterRoutes registers all v1 APIs routes to web application.
  366. // FIXME: custom form error response
  367. func RegisterRoutes(m *macaron.Macaron) {
  368. bind := binding.Bind
  369. if setting.API.EnableSwagger {
  370. m.Get("/swagger", misc.Swagger) //Render V1 by default
  371. }
  372. m.Group("/v1", func() {
  373. // Miscellaneous
  374. if setting.API.EnableSwagger {
  375. m.Get("/swagger", misc.Swagger)
  376. }
  377. m.Get("/version", misc.Version)
  378. m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
  379. m.Post("/markdown/raw", misc.MarkdownRaw)
  380. // Users
  381. m.Group("/users", func() {
  382. m.Get("/search", user.Search)
  383. m.Group("/:username", func() {
  384. m.Get("", user.GetInfo)
  385. m.Get("/heatmap", mustEnableUserHeatmap, user.GetUserHeatmapData)
  386. m.Get("/repos", user.ListUserRepos)
  387. m.Group("/tokens", func() {
  388. m.Combo("").Get(user.ListAccessTokens).
  389. Post(bind(api.CreateAccessTokenOption{}), user.CreateAccessToken)
  390. m.Combo("/:id").Delete(user.DeleteAccessToken)
  391. }, reqBasicAuth())
  392. })
  393. })
  394. m.Group("/users", func() {
  395. m.Group("/:username", func() {
  396. m.Get("/keys", user.ListPublicKeys)
  397. m.Get("/gpg_keys", user.ListGPGKeys)
  398. m.Get("/followers", user.ListFollowers)
  399. m.Group("/following", func() {
  400. m.Get("", user.ListFollowing)
  401. m.Get("/:target", user.CheckFollowing)
  402. })
  403. m.Get("/starred", user.GetStarredRepos)
  404. m.Get("/subscriptions", user.GetWatchedRepos)
  405. })
  406. }, reqToken())
  407. m.Group("/user", func() {
  408. m.Get("", user.GetAuthenticatedUser)
  409. m.Combo("/emails").Get(user.ListEmails).
  410. Post(bind(api.CreateEmailOption{}), user.AddEmail).
  411. Delete(bind(api.DeleteEmailOption{}), user.DeleteEmail)
  412. m.Get("/followers", user.ListMyFollowers)
  413. m.Group("/following", func() {
  414. m.Get("", user.ListMyFollowing)
  415. m.Combo("/:username").Get(user.CheckMyFollowing).Put(user.Follow).Delete(user.Unfollow)
  416. })
  417. m.Group("/keys", func() {
  418. m.Combo("").Get(user.ListMyPublicKeys).
  419. Post(bind(api.CreateKeyOption{}), user.CreatePublicKey)
  420. m.Combo("/:id").Get(user.GetPublicKey).
  421. Delete(user.DeletePublicKey)
  422. })
  423. m.Group("/gpg_keys", func() {
  424. m.Combo("").Get(user.ListMyGPGKeys).
  425. Post(bind(api.CreateGPGKeyOption{}), user.CreateGPGKey)
  426. m.Combo("/:id").Get(user.GetGPGKey).
  427. Delete(user.DeleteGPGKey)
  428. })
  429. m.Combo("/repos").Get(user.ListMyRepos).
  430. Post(bind(api.CreateRepoOption{}), repo.Create)
  431. m.Group("/starred", func() {
  432. m.Get("", user.GetMyStarredRepos)
  433. m.Group("/:username/:reponame", func() {
  434. m.Get("", user.IsStarring)
  435. m.Put("", user.Star)
  436. m.Delete("", user.Unstar)
  437. }, repoAssignment())
  438. })
  439. m.Get("/times", repo.ListMyTrackedTimes)
  440. m.Get("/subscriptions", user.GetMyWatchedRepos)
  441. m.Get("/teams", org.ListUserTeams)
  442. }, reqToken())
  443. // Repositories
  444. m.Post("/org/:org/repos", reqToken(), bind(api.CreateRepoOption{}), repo.CreateOrgRepo)
  445. m.Group("/repos", func() {
  446. m.Get("/search", repo.Search)
  447. })
  448. m.Combo("/repositories/:id", reqToken()).Get(repo.GetByID)
  449. m.Group("/repos", func() {
  450. m.Post("/migrate", reqToken(), bind(auth.MigrateRepoForm{}), repo.Migrate)
  451. m.Group("/:username/:reponame", func() {
  452. m.Combo("").Get(reqAnyRepoReader(), repo.Get).
  453. Delete(reqToken(), reqOwner(), repo.Delete)
  454. m.Group("/hooks", func() {
  455. m.Combo("").Get(repo.ListHooks).
  456. Post(bind(api.CreateHookOption{}), repo.CreateHook)
  457. m.Group("/:id", func() {
  458. m.Combo("").Get(repo.GetHook).
  459. Patch(bind(api.EditHookOption{}), repo.EditHook).
  460. Delete(repo.DeleteHook)
  461. m.Post("/tests", context.RepoRef(), repo.TestHook)
  462. })
  463. m.Group("/git", func() {
  464. m.Combo("").Get(repo.ListGitHooks)
  465. m.Group("/:id", func() {
  466. m.Combo("").Get(repo.GetGitHook).
  467. Patch(bind(api.EditGitHookOption{}), repo.EditGitHook).
  468. Delete(repo.DeleteGitHook)
  469. })
  470. }, reqGitHook(), context.ReferencesGitRepo(true))
  471. }, reqToken(), reqAdmin())
  472. m.Group("/collaborators", func() {
  473. m.Get("", repo.ListCollaborators)
  474. m.Combo("/:collaborator").Get(repo.IsCollaborator).
  475. Put(bind(api.AddCollaboratorOption{}), repo.AddCollaborator).
  476. Delete(repo.DeleteCollaborator)
  477. }, reqToken(), reqAdmin())
  478. m.Get("/raw/*", context.RepoRefByType(context.RepoRefAny), reqRepoReader(models.UnitTypeCode), repo.GetRawFile)
  479. m.Get("/archive/*", reqRepoReader(models.UnitTypeCode), repo.GetArchive)
  480. m.Combo("/forks").Get(repo.ListForks).
  481. Post(reqToken(), reqRepoReader(models.UnitTypeCode), bind(api.CreateForkOption{}), repo.CreateFork)
  482. m.Group("/branches", func() {
  483. m.Get("", repo.ListBranches)
  484. m.Get("/*", context.RepoRefByType(context.RepoRefBranch), repo.GetBranch)
  485. }, reqRepoReader(models.UnitTypeCode))
  486. m.Group("/tags", func() {
  487. m.Get("", repo.ListTags)
  488. }, reqRepoReader(models.UnitTypeCode))
  489. m.Group("/keys", func() {
  490. m.Combo("").Get(repo.ListDeployKeys).
  491. Post(bind(api.CreateKeyOption{}), repo.CreateDeployKey)
  492. m.Combo("/:id").Get(repo.GetDeployKey).
  493. Delete(repo.DeleteDeploykey)
  494. }, reqToken(), reqAdmin())
  495. m.Group("/times", func() {
  496. m.Combo("").Get(repo.ListTrackedTimesByRepository)
  497. m.Combo("/:timetrackingusername").Get(repo.ListTrackedTimesByUser)
  498. }, mustEnableIssues)
  499. m.Group("/issues", func() {
  500. m.Combo("").Get(repo.ListIssues).
  501. Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueOption{}), repo.CreateIssue)
  502. m.Group("/comments", func() {
  503. m.Get("", repo.ListRepoIssueComments)
  504. m.Combo("/:id", reqToken()).
  505. Patch(mustNotBeArchived, bind(api.EditIssueCommentOption{}), repo.EditIssueComment).
  506. Delete(repo.DeleteIssueComment)
  507. })
  508. m.Group("/:index", func() {
  509. m.Combo("").Get(repo.GetIssue).
  510. Patch(reqToken(), bind(api.EditIssueOption{}), repo.EditIssue)
  511. m.Group("/comments", func() {
  512. m.Combo("").Get(repo.ListIssueComments).
  513. Post(reqToken(), mustNotBeArchived, bind(api.CreateIssueCommentOption{}), repo.CreateIssueComment)
  514. m.Combo("/:id", reqToken()).Patch(bind(api.EditIssueCommentOption{}), repo.EditIssueCommentDeprecated).
  515. Delete(repo.DeleteIssueCommentDeprecated)
  516. })
  517. m.Group("/labels", func() {
  518. m.Combo("").Get(repo.ListIssueLabels).
  519. Post(reqToken(), bind(api.IssueLabelsOption{}), repo.AddIssueLabels).
  520. Put(reqToken(), bind(api.IssueLabelsOption{}), repo.ReplaceIssueLabels).
  521. Delete(reqToken(), repo.ClearIssueLabels)
  522. m.Delete("/:id", reqToken(), repo.DeleteIssueLabel)
  523. })
  524. m.Group("/times", func() {
  525. m.Combo("").Get(repo.ListTrackedTimes).
  526. Post(reqToken(), bind(api.AddTimeOption{}), repo.AddTime)
  527. })
  528. m.Combo("/deadline").Post(reqToken(), bind(api.EditDeadlineOption{}), repo.UpdateIssueDeadline)
  529. m.Group("/stopwatch", func() {
  530. m.Post("/start", reqToken(), repo.StartIssueStopwatch)
  531. m.Post("/stop", reqToken(), repo.StopIssueStopwatch)
  532. })
  533. })
  534. }, mustEnableIssuesOrPulls)
  535. m.Group("/labels", func() {
  536. m.Combo("").Get(repo.ListLabels).
  537. Post(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.CreateLabelOption{}), repo.CreateLabel)
  538. m.Combo("/:id").Get(repo.GetLabel).
  539. Patch(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.EditLabelOption{}), repo.EditLabel).
  540. Delete(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), repo.DeleteLabel)
  541. })
  542. m.Post("/markdown", bind(api.MarkdownOption{}), misc.Markdown)
  543. m.Post("/markdown/raw", misc.MarkdownRaw)
  544. m.Group("/milestones", func() {
  545. m.Combo("").Get(repo.ListMilestones).
  546. Post(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.CreateMilestoneOption{}), repo.CreateMilestone)
  547. m.Combo("/:id").Get(repo.GetMilestone).
  548. Patch(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), bind(api.EditMilestoneOption{}), repo.EditMilestone).
  549. Delete(reqToken(), reqRepoWriter(models.UnitTypeIssues, models.UnitTypePullRequests), repo.DeleteMilestone)
  550. })
  551. m.Get("/stargazers", repo.ListStargazers)
  552. m.Get("/subscribers", repo.ListSubscribers)
  553. m.Group("/subscription", func() {
  554. m.Get("", user.IsWatching)
  555. m.Put("", reqToken(), user.Watch)
  556. m.Delete("", reqToken(), user.Unwatch)
  557. })
  558. m.Group("/releases", func() {
  559. m.Combo("").Get(repo.ListReleases).
  560. Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.CreateReleaseOption{}), repo.CreateRelease)
  561. m.Group("/:id", func() {
  562. m.Combo("").Get(repo.GetRelease).
  563. Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), context.ReferencesGitRepo(false), bind(api.EditReleaseOption{}), repo.EditRelease).
  564. Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteRelease)
  565. m.Group("/assets", func() {
  566. m.Combo("").Get(repo.ListReleaseAttachments).
  567. Post(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.CreateReleaseAttachment)
  568. m.Combo("/:asset").Get(repo.GetReleaseAttachment).
  569. Patch(reqToken(), reqRepoWriter(models.UnitTypeReleases), bind(api.EditAttachmentOptions{}), repo.EditReleaseAttachment).
  570. Delete(reqToken(), reqRepoWriter(models.UnitTypeReleases), repo.DeleteReleaseAttachment)
  571. })
  572. })
  573. }, reqRepoReader(models.UnitTypeReleases))
  574. m.Post("/mirror-sync", reqToken(), reqRepoWriter(models.UnitTypeCode), repo.MirrorSync)
  575. m.Get("/editorconfig/:filename", context.RepoRef(), reqRepoReader(models.UnitTypeCode), repo.GetEditorconfig)
  576. m.Group("/pulls", func() {
  577. m.Combo("").Get(bind(api.ListPullRequestsOptions{}), repo.ListPullRequests).
  578. Post(reqToken(), mustNotBeArchived, bind(api.CreatePullRequestOption{}), repo.CreatePullRequest)
  579. m.Group("/:index", func() {
  580. m.Combo("").Get(repo.GetPullRequest).
  581. Patch(reqToken(), reqRepoWriter(models.UnitTypePullRequests), bind(api.EditPullRequestOption{}), repo.EditPullRequest)
  582. m.Combo("/merge").Get(repo.IsPullRequestMerged).
  583. Post(reqToken(), mustNotBeArchived, reqRepoWriter(models.UnitTypePullRequests), bind(auth.MergePullRequestForm{}), repo.MergePullRequest)
  584. })
  585. }, mustAllowPulls, reqRepoReader(models.UnitTypeCode), context.ReferencesGitRepo(false))
  586. m.Group("/statuses", func() {
  587. m.Combo("/:sha").Get(repo.GetCommitStatuses).
  588. Post(reqToken(), bind(api.CreateStatusOption{}), repo.NewCommitStatus)
  589. }, reqRepoReader(models.UnitTypeCode))
  590. m.Group("/commits/:ref", func() {
  591. m.Get("/status", repo.GetCombinedCommitStatusByRef)
  592. m.Get("/statuses", repo.GetCommitStatusesByRef)
  593. }, reqRepoReader(models.UnitTypeCode))
  594. m.Group("/git", func() {
  595. m.Group("/commits", func() {
  596. m.Get("/:sha", repo.GetSingleCommit)
  597. })
  598. m.Get("/refs", repo.GetGitAllRefs)
  599. m.Get("/refs/*", repo.GetGitRefs)
  600. m.Combo("/trees/:sha", context.RepoRef()).Get(repo.GetTree)
  601. }, reqRepoReader(models.UnitTypeCode))
  602. }, repoAssignment())
  603. })
  604. // Organizations
  605. m.Get("/user/orgs", reqToken(), org.ListMyOrgs)
  606. m.Get("/users/:username/orgs", org.ListUserOrgs)
  607. m.Post("/orgs", reqToken(), bind(api.CreateOrgOption{}), org.Create)
  608. m.Group("/orgs/:orgname", func() {
  609. m.Get("/repos", user.ListOrgRepos)
  610. m.Combo("").Get(org.Get).
  611. Patch(reqToken(), reqOrgOwnership(), bind(api.EditOrgOption{}), org.Edit).
  612. Delete(reqToken(), reqOrgOwnership(), org.Delete)
  613. m.Group("/members", func() {
  614. m.Get("", org.ListMembers)
  615. m.Combo("/:username").Get(org.IsMember).
  616. Delete(reqToken(), reqOrgOwnership(), org.DeleteMember)
  617. })
  618. m.Group("/public_members", func() {
  619. m.Get("", org.ListPublicMembers)
  620. m.Combo("/:username").Get(org.IsPublicMember).
  621. Put(reqToken(), reqOrgMembership(), org.PublicizeMember).
  622. Delete(reqToken(), reqOrgMembership(), org.ConcealMember)
  623. })
  624. m.Combo("/teams", reqToken(), reqOrgMembership()).Get(org.ListTeams).
  625. Post(bind(api.CreateTeamOption{}), org.CreateTeam)
  626. m.Group("/hooks", func() {
  627. m.Combo("").Get(org.ListHooks).
  628. Post(bind(api.CreateHookOption{}), org.CreateHook)
  629. m.Combo("/:id").Get(org.GetHook).
  630. Patch(reqOrgOwnership(), bind(api.EditHookOption{}), org.EditHook).
  631. Delete(reqOrgOwnership(), org.DeleteHook)
  632. }, reqToken(), reqOrgMembership())
  633. }, orgAssignment(true))
  634. m.Group("/teams/:teamid", func() {
  635. m.Combo("").Get(org.GetTeam).
  636. Patch(reqOrgOwnership(), bind(api.EditTeamOption{}), org.EditTeam).
  637. Delete(reqOrgOwnership(), org.DeleteTeam)
  638. m.Group("/members", func() {
  639. m.Get("", org.GetTeamMembers)
  640. m.Combo("/:username").
  641. Get(org.GetTeamMember).
  642. Put(reqOrgOwnership(), org.AddTeamMember).
  643. Delete(reqOrgOwnership(), org.RemoveTeamMember)
  644. })
  645. m.Group("/repos", func() {
  646. m.Get("", org.GetTeamRepos)
  647. m.Combo("/:orgname/:reponame").
  648. Put(org.AddTeamRepository).
  649. Delete(org.RemoveTeamRepository)
  650. })
  651. }, orgAssignment(false, true), reqToken(), reqOrgMembership())
  652. m.Any("/*", func(ctx *context.APIContext) {
  653. ctx.NotFound()
  654. })
  655. m.Group("/admin", func() {
  656. m.Get("/orgs", admin.GetAllOrgs)
  657. m.Group("/users", func() {
  658. m.Get("", admin.GetAllUsers)
  659. m.Post("", bind(api.CreateUserOption{}), admin.CreateUser)
  660. m.Group("/:username", func() {
  661. m.Combo("").Patch(bind(api.EditUserOption{}), admin.EditUser).
  662. Delete(admin.DeleteUser)
  663. m.Group("/keys", func() {
  664. m.Post("", bind(api.CreateKeyOption{}), admin.CreatePublicKey)
  665. m.Delete("/:id", admin.DeleteUserPublicKey)
  666. })
  667. m.Get("/orgs", org.ListUserOrgs)
  668. m.Post("/orgs", bind(api.CreateOrgOption{}), admin.CreateOrg)
  669. m.Post("/repos", bind(api.CreateRepoOption{}), admin.CreateRepo)
  670. })
  671. })
  672. }, reqToken(), reqSiteAdmin())
  673. m.Group("/topics", func() {
  674. m.Get("/search", repo.TopicSearch)
  675. })
  676. }, context.APIContexter(), sudo())
  677. }