docs: snippets API

Gauvain Pocentek · Gauvain Pocentek · commit 35b7f750c7e3 · 2016-08-09T18:09:33.000+02:00
diff --git a/docs/gl_objects/projects.py b/docs/gl_objects/projects.py
@@ -273,3 +273,47 @@
 # tags release
 tag.set_release_description('awesome v1.0 release')
 # end tags release
+
+# snippets list
+snippets = gl.project_snippets.list(project_id=1)
+# or
+snippets = project.snippets.list()
+# end snippets list
+
+# snippets get
+snippet = gl.project_snippets.list(snippet_id, project_id=1)
+# or
+snippets = project.snippets.list(snippet_id)
+# end snippets get
+
+# snippets create
+snippet = gl.project_snippets.create({'title': 'sample 1',
+                                      'file_name': 'foo.py',
+                                      'code': 'import gitlab',
+                                      'visibility_level':
+                                      Project.VISIBILITY_PRIVATE},
+                                     project_id=1)
+# or
+snippet = project.snippets.create({'title': 'sample 1',
+                                   'file_name': 'foo.py',
+                                   'code': 'import gitlab',
+                                   'visibility_level':
+                                   Project.VISIBILITY_PRIVATE})
+# end snippets create
+
+# snippets content
+print(snippet.content())
+# end snippets content
+
+# snippets update
+snippet.code = 'import gitlab\nimport whatever'
+snippet.save
+# end snippets update
+
+# snippets delete
+gl.project_snippets.delete(snippet_id, project_id=1)
+# or
+project.snippets.delete(snippet_id)
+# or
+snippet.delete()
+# end snippets delete
diff --git a/docs/gl_objects/projects.rst b/docs/gl_objects/projects.rst
@@ -206,6 +206,54 @@ Delete a tag:
    :start-after: # tags delete
    :end-before: # end tags delete
 
+Snippets
+--------
+
+Use :class:`~gitlab.objects.ProjectSnippet` objects to manipulate snippets. The
+:attr:`gitlab.Gitlab.project_snippets` and :attr:`Project.snippets
+<gitlab.objects.Project.snippets>` manager objects provide helper functions.
+
+List the project snippets:
+
+.. literalinclude:: projects.py
+   :start-after: # snippets list
+   :end-before: # end snippets list
+
+Get a snippet:
+
+.. literalinclude:: projects.py
+   :start-after: # snippets get
+   :end-before: # end snippets get
+
+Get the content of a snippet:
+
+.. literalinclude:: projects.py
+   :start-after: # snippets content
+   :end-before: # end snippets content
+
+.. warning::
+
+   The snippet content is entirely stored in memory unless you use the
+   streaming feature. See :ref:`the artifacts example <streaming_example>`.
+
+Create a snippet:
+
+.. literalinclude:: projects.py
+   :start-after: # snippets create
+   :end-before: # end snippets create
+
+Update a snippet:
+
+.. literalinclude:: projects.py
+   :start-after: # snippets update
+   :end-before: # end snippets update
+
+Delete a snippet:
+
+.. literalinclude:: projects.py
+   :start-after: # snippets delete
+   :end-before: # end snippets delete
+
 Events
 ------
 
