diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2017-12-31 17:52:57 +0100 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2017-12-31 17:52:57 +0100 |
| commit | c281d95c2f978d8d2eb1d77352babf5217d32062 (patch) | |
| tree | b25838f9379fb73abc01996c9221f99c4b262e32 /docs/gl_objects | |
| parent | 6923f117bc20fffcb0256e7cda35534ee48b058f (diff) | |
| download | gitlab-c281d95c2f978d8d2eb1d77352babf5217d32062.tar.gz | |
Add support for pagesdomains
Closes #362
Diffstat (limited to 'docs/gl_objects')
| -rw-r--r-- | docs/gl_objects/pagesdomains.rst | 65 |
1 files changed, 65 insertions, 0 deletions
diff --git a/docs/gl_objects/pagesdomains.rst b/docs/gl_objects/pagesdomains.rst new file mode 100644 index 0000000..d6b39c7 --- /dev/null +++ b/docs/gl_objects/pagesdomains.rst @@ -0,0 +1,65 @@ +############# +Pages domains +############# + +Admin +===== + +References +---------- + +* v4 API: + + + :class:`gitlab.v4.objects.PagesDomain` + + :class:`gitlab.v4.objects.PagesDomainManager` + + :attr:`gitlab.Gitlab.pagesdomains` + +* GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-all-pages-domains + +Examples +-------- + +List all the existing domains (admin only):: + + domains = gl.pagesdomains.list() + +Project pages domain +==================== + +References +---------- + +* v4 API: + + + :class:`gitlab.v4.objects.ProjectPagesDomain` + + :class:`gitlab.v4.objects.ProjectPagesDomainManager` + + :attr:`gitlab.v4.objects.Project.pagesdomains` + +* GitLab API: https://docs.gitlab.com/ce/api/pages_domains.html#list-pages-domains + +Examples +-------- + +List domains for a project:: + + domains = project.pagesdomains.list() + +Get a single domain:: + + domain = project.pagesdomains.get('d1.example.com') + +Create a new domain:: + + domain = project.pagesdomains.create({'domain': 'd2.example.com}) + +Update an existing domain:: + + domain.certificate = open('d2.crt').read() + domain.key = open('d2.key').read() + domain.save() + +Delete an existing domain:: + + domain.delete + # or + project.pagesdomains.delete('d2.example.com') |
