Add repo fork swagger (go-gitea#1941)

zhongqf · Jun 12, 2017 · ad70af1 · ad70af1
1 parent 91f27bf
commit ad70af1
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 0 deletions.
diff --git a/public/swagger.v1.json b/public/swagger.v1.json
@@ -228,6 +228,42 @@
         }
       }
     },
+    "/repos/{owner}/{repo}/forks": {
+      "get": {
+        "produces": [
+          "application/json"
+        ],
+        "operationId": "listForks",
+        "responses": {
+          "200": {
+            "$ref": "#/responses/RepositoryList"
+          },
+          "500": {
+            "$ref": "#/responses/error"
+          }
+        }
+      },
+      "post": {
+        "produces": [
+          "application/json"
+        ],
+        "operationId": "createFork",
+        "responses": {
+          "202": {
+            "$ref": "#/responses/Repository"
+          },
+          "403": {
+            "$ref": "#/responses/forbidden"
+          },
+          "422": {
+            "$ref": "#/responses/validationError"
+          },
+          "500": {
+            "$ref": "#/responses/error"
+          }
+        }
+      }
+    },
     "/repos/{username}/{reponame}/mirror-sync": {
       "post": {
         "produces": [

diff --git a/routers/api/v1/repo/fork.go b/routers/api/v1/repo/fork.go
@@ -13,6 +13,15 @@ import (
 
 // ListForks list a repository's forks
 func ListForks(ctx *context.APIContext) {
+	// swagger:route GET /repos/{owner}/{repo}/forks listForks
+	//
+	//     Produces:
+	//     - application/json
+	//
+	//     Responses:
+	//       200: RepositoryList
+	//       500: error
+
 	forks, err := ctx.Repo.Repository.GetForks()
 	if err != nil {
 		ctx.Error(500, "GetForks", err)
@@ -32,6 +41,17 @@ func ListForks(ctx *context.APIContext) {
 
 // CreateFork create a fork of a repo
 func CreateFork(ctx *context.APIContext, form api.CreateForkOption) {
+	// swagger:route POST /repos/{owner}/{repo}/forks createFork
+	//
+	//     Produces:
+	//     - application/json
+	//
+	//     Responses:
+	//       202: Repository
+	//       403: forbidden
+	//       422: validationError
+	//       500: error
+
 	repo := ctx.Repo.Repository
 	var forker *models.User // user/org that will own the fork
 	if form.Organization == nil {