From 4cfaa2fd44b64459f6fc268a91d4469284c0e768 Mon Sep 17 00:00:00 2001
From: Nejc Habjan <hab.nejc@gmail.com>
Date: Tue, 7 Apr 2020 00:55:33 +0200
Subject: feat(api): add support for remote mirrors API (#1056)

---
 docs/api-objects.rst               |  1 +
 docs/gl_objects/remote_mirrors.rst | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 docs/gl_objects/remote_mirrors.rst

(limited to 'docs')

diff --git a/docs/api-objects.rst b/docs/api-objects.rst
index 32f0d0c..32852f8 100644
--- a/docs/api-objects.rst
+++ b/docs/api-objects.rst
@@ -37,6 +37,7 @@ API examples
    gl_objects/projects
    gl_objects/protected_branches
    gl_objects/runners
+   gl_objects/remote_mirrors
    gl_objects/repositories
    gl_objects/repository_tags
    gl_objects/search
diff --git a/docs/gl_objects/remote_mirrors.rst b/docs/gl_objects/remote_mirrors.rst
new file mode 100644
index 0000000..ea4f72c
--- /dev/null
+++ b/docs/gl_objects/remote_mirrors.rst
@@ -0,0 +1,34 @@
+##########
+Project Remote Mirrors
+##########
+
+Remote Mirrors allow you to set up push mirroring for a project.
+
+References
+==========
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectRemoteMirror`
+  + :class:`gitlab.v4.objects.ProjectRemoteMirrorManager`
+  + :attr:`gitlab.v4.objects.Project.remote_mirrors`
+
+* GitLab API: https://docs.gitlab.com/ce/api/remote_mirrors.html
+
+Examples
+--------
+
+Get the list of a project's remote mirrors::
+
+    mirrors = project.remote_mirrors.list()
+
+Create (and enable) a remote mirror for a project::
+
+    mirror = project.wikis.create({'url': 'https://gitlab.com/example.git',
+                                   'enabled': True})
+
+Update an existing remote mirror's attributes::
+
+    mirror.enabled = False
+    mirror.only_protected_branches = True
+    mirror.save()
-- 
cgit v1.2.1