docs: add usage of pull mirror

nicoklaus · nejch · commit 9b374b2c051f · 2025-01-28T11:50:03.000+01:00
diff --git a/docs/api-objects.rst b/docs/api-objects.rst
@@ -52,6 +52,7 @@ API examples
    gl_objects/protected_container_repositories
    gl_objects/protected_environments
    gl_objects/protected_packages
+   gl_objects/pull_mirror
    gl_objects/releases
    gl_objects/runners
    gl_objects/remote_mirrors
diff --git a/docs/gl_objects/pull_mirror.rst b/docs/gl_objects/pull_mirror.rst
@@ -0,0 +1,38 @@
+######################
+Project Pull Mirror
+######################
+
+Pull Mirror allow you to set up pull mirroring for a project.
+
+References
+==========
+
+* v4 API:
+
+  + :class:`gitlab.v4.objects.ProjectPullMirror`
+  + :class:`gitlab.v4.objects.ProjectPullMirrorManager`
+  + :attr:`gitlab.v4.objects.Project.pull_mirror`
+
+* GitLab API: https://docs.gitlab.com/ce/api/pull_mirror.html
+
+Examples
+--------
+
+Get the current pull mirror of a project::
+
+    mirrors = project.pull_mirror.get()
+
+Create (and enable) a remote mirror for a project::
+
+    mirror = project.pull_mirror.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()
+
+Start an sync of the pull mirror::
+
+  mirror.start()
