Merge pull request #2839 from m4tthumphrey/protected-branches-api

Added methods to protect and unprotect branches in from the API

1 files changed, 86 insertions, 3 deletions

diff --git a/doc/api/repositories.md b/doc/api/repositories.md
index 685797ad78d..bc6ca70aa50 100644
--- a/doc/api/repositories.md
+++ b/doc/api/repositories.md
@@ -33,7 +33,8 @@ Parameters:
       },
       "authored_date": "2012-06-27T05:51:39-07:00",
       "committed_date": "2012-06-28T03:44:20-07:00"
-    }
+    },
+    "protected": true
   }
 ]
 ```
@@ -73,7 +74,88 @@ Parameters:
     },
     "authored_date": "2012-06-27T05:51:39-07:00",
     "committed_date": "2012-06-28T03:44:20-07:00"
-  }
+  },
+  "protected": true
+}
+```
+
+## Protect a project repository branch
+
+Protect a single project repository branch.
+
+```
+PUT /projects/:id/repository/branches/:branch/protect
+```
+
+Parameters:
+
++ `id` (required) - The ID of a project
++ `branch` (required) - The name of the branch
+
+```json
+{
+  "name": "master",
+  "commit": {
+    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
+    "parents": [
+      {
+        "id": "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
+      }
+    ],
+    "tree": "46e82de44b1061621357f24c05515327f2795a95",
+    "message": "add projects API",
+    "author": {
+      "name": "John Smith",
+      "email": "john@example.com"
+    },
+    "committer": {
+      "name": "John Smith",
+      "email": "john@example.com"
+    },
+    "authored_date": "2012-06-27T05:51:39-07:00",
+    "committed_date": "2012-06-28T03:44:20-07:00"
+  },
+  "protected": true
+}
+```
+
+## Unprotect a project repository branch
+
+Unprotect a single project repository branch.
+
+```
+PUT /projects/:id/repository/branches/:branch/unprotect
+```
+
+Parameters:
+
++ `id` (required) - The ID of a project
++ `branch` (required) - The name of the branch
+
+```json
+{
+  "name": "master",
+  "commit": {
+    "id": "7b5c3cc8be40ee161ae89a06bba6229da1032a0c",
+    "parents": [
+      {
+        "id": "4ad91d3c1144c406e50c7b33bae684bd6837faf8"
+      }
+    ],
+    "tree": "46e82de44b1061621357f24c05515327f2795a95",
+    "message": "add projects API",
+    "author": {
+      "name": "John Smith",
+      "email": "john@example.com"
+    },
+    "committer": {
+      "name": "John Smith",
+      "email": "john@example.com"
+    },
+    "authored_date": "2012-06-27T05:51:39-07:00",
+    "committed_date": "2012-06-28T03:44:20-07:00"
+  },
+  "protected": false
 }
 ```
 
@@ -110,7 +192,8 @@ Parameters:
       },
       "authored_date": "2012-05-28T04:42:42-07:00",
       "committed_date": "2012-05-28T04:42:42-07:00"
-    }
+    },
+    "protected": null
   }
 ]
 ```