Deployment approve/reject via python api supported? #2252

jbotello7381 · 2022-08-24T00:58:33Z

jbotello7381
Aug 24, 2022

I was playing with deployment and gitlab python library, and notice there's no method to approve or reject a deployment? i was able to do it via REST API from my python code, but not via the python wrapper. I'm using 3.8.1 of the gitlab python library.

JohnVillalovos · 2022-08-24T01:12:13Z

JohnVillalovos
Aug 24, 2022
Maintainer

Would be useful to have a link to the upstream GitLab API docs for what is missing. Thanks.

0 replies

jbotello7381 · 2022-08-24T02:00:27Z

jbotello7381
Aug 24, 2022
Author

Sorry, this is the endpoint
https://docs.gitlab.com/ee/ci/environments/deployment_approvals.html#approve-or-reject-a-deployment-using-the-api

0 replies

JohnVillalovos · 2022-08-24T02:39:28Z

JohnVillalovos
Aug 24, 2022
Maintainer

So it looks like it is this API:
https://docs.gitlab.com/ee/api/deployments.html#approve-or-reject-a-blocked-deployment

And it doesn't look like there is any support for that yet in:
https://github.com/python-gitlab/python-gitlab/blob/main/gitlab/v4/objects/deployments.py

Implementing it will look similar to how the "approve" method is done for a merge request.

python-gitlab/gitlab/v4/objects/merge_requests.py

Lines 263 to 290 in f67514e

    
               @cli.register_custom_action("ProjectMergeRequest", (), ("sha",)) 
        
               @exc.on_http_error(exc.GitlabMRApprovalError) 
        
               def approve(self, sha: Optional[str] = None, **kwargs: Any) -> Dict[str, Any]: 
        
                   """Approve the merge request. 
        
                   Args: 
        
                       sha: Head SHA of MR 
        
                       **kwargs: Extra options to send to the server (e.g. sudo) 
        
                   Raises: 
        
                       GitlabAuthenticationError: If authentication is not correct 
        
                       GitlabMRApprovalError: If the approval failed 
        
                   Returns: 
        
                      A dict containing the result. 
        
                   https://docs.gitlab.com/ee/api/merge_request_approvals.html#approve-merge-request 
        
                   """ 
        
                   path = f"{self.manager.path}/{self.encoded_id}/approve" 
        
                   data = {} 
        
                   if sha: 
        
                       data["sha"] = sha 
        
                   server_data = self.manager.gitlab.http_post(path, post_data=data, **kwargs) 
        
                   if TYPE_CHECKING: 
        
                       assert isinstance(server_data, dict) 
        
                   self._update_attrs(server_data) 
        
                   return server_data

2 replies

JohnVillalovos Aug 24, 2022
Maintainer

I opened #2253 as a RFE (Request For Enhancement)

JohnVillalovos Aug 24, 2022
Maintainer

Created a PR: #2254

jbotello7381 · 2022-08-24T05:53:05Z

jbotello7381
Aug 24, 2022
Author

I tested on my local environment with your PR and it works. Thanks for the quick PR.

1 reply

JohnVillalovos Aug 24, 2022
Maintainer

I tested on my local environment with your PR and it works. Thanks for the quick PR.

Thanks for the test! Glad to know it works.

Navigation Menu

Uh oh!

Deployment approve/reject via python api supported? #2252

Uh oh!

{{title}}

Uh oh!

Replies: 4 comments 3 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Uh oh!

Deployment approve/reject via python api supported? #2252

Uh oh!

jbotello7381 Aug 24, 2022

Replies: 4 comments · 3 replies

Uh oh!

JohnVillalovos Aug 24, 2022 Maintainer

Uh oh!

jbotello7381 Aug 24, 2022 Author

Uh oh!

JohnVillalovos Aug 24, 2022 Maintainer

Uh oh!

JohnVillalovos Aug 24, 2022 Maintainer

Uh oh!

JohnVillalovos Aug 24, 2022 Maintainer

Uh oh!

jbotello7381 Aug 24, 2022 Author

Uh oh!

JohnVillalovos Aug 24, 2022 Maintainer

jbotello7381
Aug 24, 2022

Replies: 4 comments 3 replies

JohnVillalovos
Aug 24, 2022
Maintainer

jbotello7381
Aug 24, 2022
Author

JohnVillalovos
Aug 24, 2022
Maintainer

JohnVillalovos Aug 24, 2022
Maintainer

JohnVillalovos Aug 24, 2022
Maintainer

jbotello7381
Aug 24, 2022
Author

JohnVillalovos Aug 24, 2022
Maintainer