Qlik Automate: Breaking change in the response of the GitLab blocks

[Sonja_Bauernfeind]

Hello Qlik Automate users and admins,

A series of changes have been identified across various GitLab APIs due to the deprecation of specific fields. For more information, see REST API deprecations (docs.gitlab.com).

As of the release of this post, GitLab has no official release date for API v5, and development has not yet started as of version 18.0.

What will be changed?

merged_by: In the Merge Request API, the merged_by field has been deprecated and replaced with merge_user. The following block response will be affected:

• List merge request
• Get merge request
• List updated merge request incrementally
• List new merge request incrementally

merge_status: The merge_status field in the Merge Request API is deprecated and replaced with detailed_merge_status. The following block response will be affected:

• List merge request
• Get merge request
• Create merge request
• List updated merge request incrementally
• List new merge request incrementally

default_branch_protection: The default_branch_protection field will be replaced with the default_branch_protection_defaults field. For more information, see default_branch_protection API field (docs.gitlab.com). The following block response will be affected:

• List groups

Additional details on Response Changes

Below you will find examples of responses with the deprecated (red) and new (green) fields.

merged_by & merge_status fields

[
{
"id": 1,
"iid": 1,
"project_id": 3,
"title": "test1",
"description": "fixed login page css paddings",
"state": "merged",
"imported": false,
"imported_from": "none",
"merged_by": {
"id": --,
"name": "--",
"username": "--",
"state": "active",
"avatar_url": "https://gitlab.example.com/--",
"web_url": "https://gitlab.com/--"
},
"merge_user": {
"id": --,
"name": "--",
"username": "--",
"state": "active",
"avatar_url": "https://gitlab.example.com/--",
"web_url": "https://gitlab.com/--"
},
"merged_at": "2018-09-07T11:16:17.520Z",
"merge_after": "2018-09-07T11:16:00.000Z",
"merge_when_pipeline_succeeds": true,
"merge_status": "can_be_merged",
"detailed_merge_status": "not_open"
}
]

default_branch_protection

{
"id": 96,
"web_url": "https://gitlab.example.com/--",
"name": "test-1",
"path": "test-1",
"description": "",
"math_rendering_limits_enabled": true,
"lock_math_rendering_limits_enabled": false,
"default_branch": null,
"default_branch_protection": 2,
"default_branch_protection_defaults": {
"allowed_to_push": [
{
"access_level": 40
}
],
"allow_force_push": false,
"allowed_to_merge": [
{
"access_level": 40
}
],
"developer_can_initial_push": false
},
"avatar_url": null
}

What action do I need to take?

All the above blocks referencing these deprecated fields in the other block should be updated with the new fields.

If you have any questions, we're happy to assist. Reply to this blog post or take similar queries to the Qlik Application Automation forum.

 

Thank you for choosing Qlik,
Qlik Support