feat: add pipeline schedule play error exception

twonds · twonds · commit 94ea7d95204f · 2020-04-09T13:17:16.000-07:00
diff --git a/gitlab/exceptions.py b/gitlab/exceptions.py
@@ -145,6 +145,10 @@ class GitlabJobEraseError(GitlabRetryError):
     pass
 
 
+class GitlabPipelinePlayError(GitlabRetryError):
+    pass
+
+
 class GitlabPipelineRetryError(GitlabRetryError):
     pass
 
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
@@ -3775,17 +3775,17 @@ def take_ownership(self, **kwargs):
         self._update_attrs(server_data)
 
     @cli.register_custom_action("ProjectPipelineSchedule")
-    @exc.on_http_error(exc.GitlabOwnershipError)
+    @exc.on_http_error(exc.GitlabPipelinePlayError)
     def play(self, **kwargs):
-        # https://docs.gitlab.com/ee/api/pipeline_schedules.html#run-a-scheduled-pipeline-immediately  # noqa
-        """Play a pipeline schedule immediately.
+        """Trigger a new scheduled pipeline, which runs immediately.
+        The next scheduled run of this pipeline is not affected.
 
         Args:
             **kwargs: Extra options to send to the server (e.g. sudo)
 
         Raises:
             GitlabAuthenticationError: If authentication is not correct
-            GitlabOwnershipError: If the request failed
+            GitlabPipelinePlayError: If the request failed
         """
         path = "%s/%s/play" % (self.manager.path, self.get_id())
         server_data = self.manager.gitlab.http_post(path, **kwargs)
