summaryrefslogtreecommitdiff
path: root/docs/gl_objects/milestones.py
diff options
context:
space:
mode:
authorGauvain Pocentek <gauvain@pocentek.net>2016-08-09 10:03:45 +0200
committerGauvain Pocentek <gauvain@pocentek.net>2016-08-09 10:03:45 +0200
commit74119073dae18214df1dd67ded6cd57abda335d4 (patch)
treee26bb2a0e7c9e95408f174c5c8378b7272cfd99f /docs/gl_objects/milestones.py
parentbaa09fecb277a206aa41b22d97c60d5b230656c1 (diff)
downloadgitlab-74119073dae18214df1dd67ded6cd57abda335d4.tar.gz
docs: add milestones API
Diffstat (limited to 'docs/gl_objects/milestones.py')
-rw-r--r--docs/gl_objects/milestones.py42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/gl_objects/milestones.py b/docs/gl_objects/milestones.py
new file mode 100644
index 0000000..27be573
--- /dev/null
+++ b/docs/gl_objects/milestones.py
@@ -0,0 +1,42 @@
+# list
+milestones = gl.project_milestones.list(project_id=1)
+# or
+milestones = project.milestones.list()
+# end list
+
+# filter
+milestones = gl.project_milestones.list(project_id=1, state='closed')
+# or
+milestones = project.milestones.list(state='closed')
+# end filter
+
+# get
+milestone = gl.project_milestones.get(milestone_id, project_id=1)
+# or
+milestone = project.milestones.get(milestone_id)
+# end get
+
+# create
+milestone = gl.project_milestones.create({'title': '1.0'}, project_id=1)
+# or
+milestone = project.milestones.create({'title': '1.0'})
+# end create
+
+# update
+milestone.description = 'v 1.0 release'
+milestone.save()
+# end update
+
+# state
+# close a milestone
+milestone.state_event = 'close'
+milestone.save
+
+# activate a milestone
+milestone.state_event = 'activate'
+m.save()
+# end state
+
+# issues
+issues = milestone.issues()
+# end issues