Skip to content

Commit 4db3e8f

Browse files
martinsifraclaude
andcommitted
feat: Add externalId to MergeRequest API
- DMD-1081 - Expose the MergeRequest::$externalId through the create and update merge request endpoints as an optional string parameter. - Update response provider to include externalId in all MR responses, and update Apiary documentation accordingly. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent d801817 commit 4db3e8f

1 file changed

Lines changed: 13 additions & 2 deletions

File tree

apiary.apib

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9901,6 +9901,7 @@ other buckets (production buckets or buckets belongs the other development branc
99019901
+ branchIntoId (required, number) - ID of the branch to merge into (default branch)
99029902
+ title (required, string) - title of the merge request
99039903
+ description (optional, string) - description of the merge request
9904+
+ externalId (optional, string) - identifier of the merge request in an external system
99049905
99059906
+ Request (application/json)
99069907
@@ -9915,6 +9916,7 @@ other buckets (production buckets or buckets belongs the other development branc
99159916
"branchIntoId": 123,
99169917
"title": "Refactor DB extractors",
99179918
"description": "DB exctractor have new columns now",
9919+
"externalId": "ticket-123"
99189920
}
99199921
99209922
+ Response 201 (application/json)
@@ -9939,6 +9941,7 @@ other buckets (production buckets or buckets belongs the other development branc
99399941
"mergerId": null,
99409942
"mergerName": ""
99419943
},
9944+
"externalId": "ticket-123",
99429945
"approvals": [
99439946
{
99449947
"approverId": 123,
@@ -9955,6 +9958,7 @@ other buckets (production buckets or buckets belongs the other development branc
99559958
+ Attributes
99569959
+ title (required, string) - title of the merge request
99579960
+ description (optional, string) - description of the merge request
9961+
+ externalId (optional, string) - identifier of the merge request in an external system
99589962
99599963
+ Request (application/json)
99609964
@@ -9967,6 +9971,7 @@ other buckets (production buckets or buckets belongs the other development branc
99679971
{
99689972
"title": "New title",
99699973
"description": "New desc",
9974+
"externalId": "ticket-123"
99709975
}
99719976
99729977
+ Response 200 (application/json)
@@ -9991,6 +9996,7 @@ other buckets (production buckets or buckets belongs the other development branc
99919996
"mergerId": null,
99929997
"mergerName": ""
99939998
},
9999+
"externalId": "ticket-123",
999410000
"approvals": [
999510001
{
999610002
"approverId": 123,
@@ -10034,6 +10040,7 @@ List all merge requests available in the project defined by token.
1003410040
"mergerId": null,
1003510041
"mergerName": ""
1003610042
},
10043+
"externalId": "ticket-123",
1003710044
"approvals": [
1003810045
{
1003910046
"approverId": 123,
@@ -10097,6 +10104,7 @@ Detail of Merge request also contains `content` of changed objects.
1009710104
"mergerId": null,
1009810105
"mergerName": ""
1009910106
},
10107+
"externalId": "ticket-123",
1010010108
"approvals": [
1010110109
{
1010210110
"approverId": 123,
@@ -10157,6 +10165,7 @@ Will move Merge request state `development` -> `in_review`. If branch has an ope
1015710165
"mergerId": null,
1015810166
"mergerName": ""
1015910167
},
10168+
"externalId": "ticket-123",
1016010169
"approvals": [
1016110170
{
1016210171
"approverId": 123,
@@ -10208,7 +10217,7 @@ Each project has defined required number of approvals. If the last approval arri
1020810217
"lastVersionIdentifier": "01H5M1B47BX3W4GM4CDH40J330"
1020910218
}
1021010219
]
10211-
}
10220+
},
1021210221
"branches": {
1021310222
"branchFromId": 124,
1021410223
"branchIntoId": 123
@@ -10218,6 +10227,7 @@ Each project has defined required number of approvals. If the last approval arri
1021810227
"mergerId": null,
1021910228
"mergerName": ""
1022010229
},
10230+
"externalId": "ticket-123",
1022110231
"approvals": [
1022210232
{
1022310233
"approverId": 123,
@@ -10299,7 +10309,7 @@ Requesting changes will remove all approvals and move the Merge request to `deve
1029910309
"lastVersionIdentifier": "01H5M1B47BX3W4GM4CDH40J330"
1030010310
}
1030110311
]
10302-
}
10312+
},
1030310313
"branches": {
1030410314
"branchFromId": 124,
1030510315
"branchIntoId": 123
@@ -10309,6 +10319,7 @@ Requesting changes will remove all approvals and move the Merge request to `deve
1030910319
"mergerId": null,
1031010320
"mergerName": ""
1031110321
},
10322+
"externalId": "ticket-123",
1031210323
"approvals": [
1031310324
{
1031410325
"approverId": 123,

0 commit comments

Comments
 (0)