docs: tags API

Gauvain Pocentek · Gauvain Pocentek · commit dd79eda78f91 · 2016-08-09T17:40:17.000+02:00
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
@@ -242,3 +242,34 @@
 # or
 f.delete(commit_message='Delete testfile')
 # end files delete
+
+# tags list
+tags = gl.project_tags.list(project_id=1)
+# or
+tags = project.tags.list()
+# end tags list
+
+# tags get
+tag = gl.project_tags.list('1.0', project_id=1)
+# or
+tags = project.tags.list('1.0')
+# end tags get
+
+# tags create
+tag = gl.project_tags.create({'tag_name': '1.0', 'ref': 'master'},
+                             project_id=1)
+# or
+tag = project.tags.create({'tag_name': '1.0', 'ref': 'master'})
+# end tags create
+
+# tags delete
+gl.project_tags.delete('1.0', project_id=1)
+# or
+project.tags.delete('1.0')
+# or
+tag.delete()
+# end tags delete
+
+# tags release
+tag.set_release_description('awesome v1.0 release')
+# end tags release
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -169,6 +169,43 @@ Delete a file:
    :start-after: # files delete
    :end-before: # end files delete
 
+Tags
+----
+
+Use :class:`~gitlab.objects.ProjectTag` objects to manipulate tags. The
+:attr:`gitlab.Gitlab.project_tags` and :attr:`Project.tags
+<gitlab.objects.Project.tags>` manager objects provide helper functions.
+
+List the project tags:
+
+.. literalinclude:: projects.py
+   :start-after: # tags list
+   :end-before: # end tags list
+
+Get a tag:
+
+.. literalinclude:: projects.py
+   :start-after: # tags get
+   :end-before: # end tags get
+
+Create a tag:
+
+.. literalinclude:: projects.py
+   :start-after: # tags create
+   :end-before: # end tags create
+
+Set or update the release note for a tag:
+
+.. literalinclude:: projects.py
+   :start-after: # tags release
+   :end-before: # end tags release
+
+Delete a tag:
+
+.. literalinclude:: projects.py
+   :start-after: # tags delete
+   :end-before: # end tags delete
+
 Events
 ------
 
