summaryrefslogtreecommitdiff
path: root/docs/gl_objects/labels.rst
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-06 22:04:00 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-06 22:04:00 +0200
commit31882b8a57f3f4c7e4c4c4b319af436795ebafd3 (patch)
tree99af41fdd1cb2ac8c8180f4587e5f708ce49f026 /docs/gl_objects/labels.rst
parent4fd00f8a7a879eb113e3998b1c9ef82758560235 (diff)
downloadgitlab-31882b8a57f3f4c7e4c4c4b319af436795ebafd3.tar.gz
docs: add labales API
Diffstat (limited to 'docs/gl_objects/labels.rst')
-rw-r--r--docs/gl_objects/labels.rst40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/gl_objects/labels.rst b/docs/gl_objects/labels.rst
new file mode 100644
index 0000000..3973b0b
--- /dev/null
+++ b/docs/gl_objects/labels.rst
@@ -0,0 +1,40 @@
+######
+Labels
+######
+
+Use :class:`~gitlab.objects.ProjectLabel` objects to manipulate labels for
+projects. The :attr:`gitlab.Gitlab.project_labels` and :attr:`Project.labels
+<gitlab.objects.Project.labels>` manager objects provide helper functions.
+
+Examples
+--------
+
+List labels for a project:
+
+.. literalinclude:: labels.py
+ :start-after: # list
+ :end-before: # end list
+
+Get a single label:
+
+.. literalinclude:: labels.py
+ :start-after: # get
+ :end-before: # end get
+
+Create a label for a project:
+
+.. literalinclude:: labels.py
+ :start-after: # create
+ :end-before: # end create
+
+Update a label for a project:
+
+.. literalinclude:: labels.py
+ :start-after: # update
+ :end-before: # end update
+
+Delete a label for a project:
+
+.. literalinclude:: labels.py
+ :start-after: # delete
+ :end-before: # end delete