Update documentaiton for create_tag method.

Sean Edge
1 parent 1e6766f9
Showing 1 changed file with 34 additions and 0 deletions Show diff stats
doc/api/repositories.md
@@ -35,6 +35,40 @@ Parameters:
 ]
 ```
+## Create a new tag
+
+Creates new tag in the repository that points to the supplied ref.
+
+```
+POST /projects/:id/repository/tags
+```
+
+Parameters:
+
++ `id` (required) - The ID of a project
++ `tag_name` (required) - The name of a tag
++ `ref` (required) - Create tag using commit sha, another tag name, or branch name.
+
+```json
+[
+  {
+    "name": "v1.0.0",
+    "commit": {
+      "id": "2695effb5807a22ff3d138d593fd856244e155e7",
+      "parents": [],
+      "message": "Initial commit",
+      "authored_date": "2012-05-28T04:42:42-07:00",
+      "author_name": "John Smith",
+      "author email": "john@example.com"
+      "committer_name": "Jack Smith",
+      "committed_date": "2012-05-28T04:42:42-07:00"
+      "committer_email": "jack@example.com"
+    },
+    "protected": false
+  }
+]
+```
+
 ## List repository tree
 Get a list of repository files and directories in a project.
	@@ -35,6 +35,40 @@ Parameters:		@@ -35,6 +35,40 @@ Parameters:
35	]	35	]
36	```	36	```
37		37
		38	+## Create a new tag
		39	+
		40	+Creates new tag in the repository that points to the supplied ref.
		41	+
		42	+```
		43	+POST /projects/:id/repository/tags
		44	+```
		45	+
		46	+Parameters:
		47	+
		48	++ `id` (required) - The ID of a project
		49	++ `tag_name` (required) - The name of a tag
		50	++ `ref` (required) - Create tag using commit sha, another tag name, or branch name.
		51	+
		52	+```json
		53	+[
		54	+ {
		55	+ "name": "v1.0.0",
		56	+ "commit": {
		57	+ "id": "2695effb5807a22ff3d138d593fd856244e155e7",
		58	+ "parents": [],
		59	+ "message": "Initial commit",
		60	+ "authored_date": "2012-05-28T04:42:42-07:00",
		61	+ "author_name": "John Smith",
		62	+ "author email": "john@example.com"
		63	+ "committer_name": "Jack Smith",
		64	+ "committed_date": "2012-05-28T04:42:42-07:00"
		65	+ "committer_email": "jack@example.com"
		66	+ },
		67	+ "protected": false
		68	+ }
		69	+]
		70	+```
		71	+
38	## List repository tree	72	## List repository tree
39		73
40	Get a list of repository files and directories in a project.	74	Get a list of repository files and directories in a project.