diff options
author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-11-01 12:13:46 +0100 |
---|---|---|
committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-11-01 12:13:46 +0100 |
commit | 5082879dcfbe322bb16e4c2387c25ec4f4407cb1 (patch) | |
tree | bcb261cefc6b4c5708a07989e16bfe4275027da3 /docs | |
parent | 4744200d982f7fc556d1202330b218850bd232d6 (diff) | |
download | gitlab-5082879dcfbe322bb16e4c2387c25ec4f4407cb1.tar.gz |
Add support for wiki pages
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api-objects.rst | 1 | ||||
-rw-r--r-- | docs/gl_objects/wikis.py | 21 | ||||
-rw-r--r-- | docs/gl_objects/wikis.rst | 46 |
3 files changed, 68 insertions, 0 deletions
diff --git a/docs/api-objects.rst b/docs/api-objects.rst index 4b40ce1..e549924 100644 --- a/docs/api-objects.rst +++ b/docs/api-objects.rst @@ -30,3 +30,4 @@ API examples gl_objects/todos gl_objects/users gl_objects/sidekiq + gl_objects/wikis diff --git a/docs/gl_objects/wikis.py b/docs/gl_objects/wikis.py new file mode 100644 index 0000000..0c92fe6 --- /dev/null +++ b/docs/gl_objects/wikis.py @@ -0,0 +1,21 @@ +# list +pages = project.wikis.list() +# end list + +# get +page = project.wikis.get(page_slug) +# end get + +# create +page = project.wikis.create({'title': 'Wiki Page 1', + 'content': open(a_file).read()}) +# end create + +# update +page.content = 'My new content' +page.save() +# end update + +# delete +page.delete() +# end delete diff --git a/docs/gl_objects/wikis.rst b/docs/gl_objects/wikis.rst new file mode 100644 index 0000000..0934654 --- /dev/null +++ b/docs/gl_objects/wikis.rst @@ -0,0 +1,46 @@ +########## +Wiki pages +########## + + +References +========== + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectWiki` + + :class:`gitlab.v4.objects.ProjectWikiManager` + + :attr:`gitlab.v4.objects.Project.wikis` + +Examples +-------- + +Get the list of wiki pages for a project: + +.. literalinclude:: wikis.py + :start-after: # list + :end-before: # end list + +Get a single wiki page: + +.. literalinclude:: wikis.py + :start-after: # get + :end-before: # end get + +Create a wiki page: + +.. literalinclude:: wikis.py + :start-after: # create + :end-before: # end create + +Update a wiki page: + +.. literalinclude:: wikis.py + :start-after: # update + :end-before: # end update + +Delete a wiki page: + +.. literalinclude:: wikis.py + :start-after: # delete + :end-before: # end delete |