summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/api-objects.rst2
-rw-r--r--docs/gl_objects/environments.py31
-rw-r--r--docs/gl_objects/environments.rst41
3 files changed, 74 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 5a71947..59d981c 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -3,11 +3,13 @@ API objects manipulation
########################
.. toctree::
+ :maxdepth: 1
gl_objects/branches
gl_objects/builds
gl_objects/commits
gl_objects/deploy_keys
+ gl_objects/environments
gl_objects/groups
gl_objects/issues
gl_objects/namespaces
diff --git a/docs/gl_objects/environments.py b/docs/gl_objects/environments.py
new file mode 100644
index 0000000..80d77c9
--- /dev/null
+++ b/docs/gl_objects/environments.py
@@ -0,0 +1,31 @@
+# list
+environments = gl.project_environments.list(project_id=1)
+# or
+environments = project.environments.list()
+# end list
+
+# get
+environment = gl.project_environments.get(environment_id, project_id=1)
+# or
+environment = project.environments.get(environment_id)
+# end get
+
+# create
+environment = gl.project_environments.create({'name': 'production'},
+ project_id=1)
+# or
+environment = project.environments.create({'name': 'production'})
+# end create
+
+# update
+environment.external_url = 'http://foo.bar.com'
+environment.save()
+# end update
+
+# delete
+environment = gl.project_environments.delete(environment_id, project_id=1)
+# or
+environment = project.environments.list(environment_id)
+# or
+environment.delete()
+# end delete
diff --git a/docs/gl_objects/environments.rst b/docs/gl_objects/environments.rst
new file mode 100644
index 0000000..83d080b
--- /dev/null
+++ b/docs/gl_objects/environments.rst
@@ -0,0 +1,41 @@
+############
+Environments
+############
+
+Use :class:`~gitlab.objects.ProjectEnvironment` objects to manipulate
+environments for projects. The :attr:`gitlab.Gitlab.project_environments` and
+:attr:`Project.environments <gitlab.objects.Project.environments>` manager
+objects provide helper functions.
+
+Examples
+--------
+
+List environments for a project:
+
+.. literalinclude:: environments.py
+ :start-after: # list
+ :end-before: # end list
+
+Get a single environment:
+
+.. literalinclude:: environments.py
+ :start-after: # get
+ :end-before: # end get
+
+Create an environment for a project:
+
+.. literalinclude:: environments.py
+ :start-after: # create
+ :end-before: # end create
+
+Update an environment for a project:
+
+.. literalinclude:: environments.py
+ :start-after: # update
+ :end-before: # end update
+
+Delete an environment for a project:
+
+.. literalinclude:: environments.py
+ :start-after: # delete
+ :end-before: # end delete