GET /repos/:owner/:repo/commits/:ref

modules/convert/convert.go

@@ -386,7 +386,6 @@ func ToCommitUser(sig *git.Signature) *api.CommitUser {
 func ToCommitMeta(repo *models.Repository, tag *git.Tag) *api.CommitMeta {
  return &api.CommitMeta{
  SHA: tag.Object.String(),
- // TODO: Add the /commits API endpoint and use it here (https://developer.github.com/v3/repos/commits/#get-a-single-commit)
  URL: util.URLJoin(repo.APIURL(), "git/commits", tag.ID.String()),
  }
 }

routers/api/v1/api.go

@@ -798,14 +798,14 @@ func RegisterRoutes(m *macaron.Macaron) {
  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("", repo.GetSingleCommitByRef)
  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("/:sha", repo.GetSingleCommitBySHA)
  })
  m.Get("/refs", repo.GetGitAllRefs)
  m.Get("/refs/*", repo.GetGitRefs)

routers/api/v1/repo/commits.go

@@ -19,9 +19,9 @@ import (
  "code.gitea.io/gitea/routers/api/v1/utils"
 )
 
-// GetSingleCommit get a commit via
-func GetSingleCommit(ctx *context.APIContext) {
- // swagger:operation GET /repos/{owner}/{repo}/git/commits/{sha} repository repoGetSingleCommit
+// GetSingleCommitBySHA get a commit via sha
+func GetSingleCommitBySHA(ctx *context.APIContext) {
+ // swagger:operation GET /repos/{owner}/{repo}/git/commits/{sha} repository repoGetSingleCommitBySHA
  // ---
  // summary: Get a single commit from a repository
  // produces:
@@ -48,13 +48,61 @@ func GetSingleCommit(ctx *context.APIContext) {
  // "404":
  // "$ref": "#/responses/notFound"
 
+ sha := ctx.Params(":sha")
+ if len(sha) == 0 {
+ ctx.Error(http.StatusBadRequest, "ref not given", nil)
+ return
+ }
+ getCommit(ctx, sha)
+}
+
+// GetSingleCommitByRef get a commit via ref
+func GetSingleCommitByRef(ctx *context.APIContext) {
+ // swagger:operation GET /repos/{owner}/{repo}/commits/{ref} repository repoGetSingleCommitByRef
+ // ---
+ // summary: Get a single commit from a repository
+ // produces:
+ // - application/json
+ // parameters:
+ // - name: owner
+ // in: path
+ // description: owner of the repo
+ // type: string
+ // required: true
+ // - name: repo
+ // in: path
+ // description: name of the repo
+ // type: string
+ // required: true
+ // - name: ref
+ // in: path
+ // description: a git ref
+ // type: string
+ // required: true
+ // responses:
+ // "200":
+ // "$ref": "#/responses/Commit"
+ // "400":
+ // "$ref": "#/responses/error"
+ // "404":
+ // "$ref": "#/responses/notFound"
+
+ ref := ctx.Params("ref")
+ if len(ref) == 0 {
+ ctx.Error(http.StatusBadRequest, "ref not given", nil)
+ return
+ }
+ getCommit(ctx, ref)
+}
+
+func getCommit(ctx *context.APIContext, identifier string) {
  gitRepo, err := git.OpenRepository(ctx.Repo.Repository.RepoPath())
  if err != nil {
  ctx.ServerError("OpenRepository", err)
  return
  }
  defer gitRepo.Close()
- commit, err := gitRepo.GetCommit(ctx.Params(":sha"))
+ commit, err := gitRepo.GetCommit(identifier)
  if err != nil {
  ctx.NotFoundOrServerError("GetCommit", git.IsErrNotExist, err)
  return
@@ -65,7 +113,6 @@ func GetSingleCommit(ctx *context.APIContext) {
  ctx.ServerError("toCommit", err)
  return
  }
-
  ctx.JSON(http.StatusOK, json)
 }
 

templates/swagger/v1_json.tmpl

@@ -2511,6 +2511,52 @@
  }
  }
  },
+ "/repos/{owner}/{repo}/commits/{ref}": {
+ "get": {
+ "produces": [
+ "application/json"
+ ],
+ "tags": [
+ "repository"
+ ],
+ "summary": "Get a single commit from a repository",
+ "operationId": "repoGetSingleCommitByRef",
+ "parameters": [
+ {
+ "type": "string",
+ "description": "owner of the repo",
+ "name": "owner",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "name of the repo",
+ "name": "repo",
+ "in": "path",
+ "required": true
+ },
+ {
+ "type": "string",
+ "description": "a git ref",
+ "name": "ref",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "responses": {
+ "200": {
+ "$ref": "#/responses/Commit"
+ },
+ "400": {
+ "$ref": "#/responses/error"
+ },
+ "404": {
+ "$ref": "#/responses/notFound"
+ }
+ }
+ }
+ },
  "/repos/{owner}/{repo}/commits/{ref}/statuses": {
  "get": {
  "produces": [
@@ -2976,7 +3022,7 @@
  "repository"
  ],
  "summary": "Get a single commit from a repository",
- "operationId": "repoGetSingleCommit",
+ "operationId": "repoGetSingleCommitBySHA",
  "parameters": [
  {
  "type": "string",