From c281d95c2f978d8d2eb1d77352babf5217d32062 Mon Sep 17 00:00:00 2001
From: Gauvain Pocentek <gauvain@pocentek.net>
Date: Sun, 31 Dec 2017 17:52:57 +0100
Subject: Add support for pagesdomains

Closes #362
---
 docs/gl_objects/pagesdomains.rst | 65 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 65 insertions(+)
 create mode 100644 docs/gl_objects/pagesdomains.rst

(limited to 'docs/gl_objects')

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')
-- 
cgit v1.2.1