Document missing fields in Merge Request Webhooks
Problem to solve
https://docs.gitlab.com/ee/user/project/integrations/webhooks.html#merge-request-events contains only one example and it doesn't contain the oldrev
field. There are most likely more missing fields like this.
Further details
I stumbled upon the existence of oldrev
trying to find alternatives to figure out how to find the changelist of an MR update, when that field should have been documented in the first place. Properly documenting the webhooks is very important to developers that leverage these webhooks. I'm sure there are more fields that aren't documented for different MR event types, and developers are missing out on information that they didn't know existed.
Proposal
Similar to how Comment Events is broken up into subtypes, break up Merge Request Events into subtypes based on the value of action
.
i.e.
Merge Request Events
- Merge Request Created
- Merge Request Updated
- Merge Request Merged
...
And provide an example for each.
Other links/references
Interesting how gitlab-foss!5535 (merged) got merged without meeting the Documentation created/updated
acceptance criteria.