Docs feedback: provide specification for confusing fields/behavior in Webhook events
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
When you search for "Gitlab Webhook", you eventually end up on the page https://docs.gitlab.com/ee/user/project/integrations/webhook_events.html. On that page, there is one example for each of the events which a Webhook can be configured to report to a specified URL. However, there is no specification. For example, in Pipeline events, it is unclear:
- What are the possible values of
status
and what do they mean? Specifically, what UI behavior in Gitlab do they correlate to? (green check mark, red cross, blue crescent moon symbol, etc.) - What's the difference between
merge_request.id
andmerge_request.iid
? - What exactly is meant by "only latest jobs". (I ended up looking in the changes of !53159 (merged) to understand this has to do with retries; my first thought was it would be related to stages)
Further details
I reckon a full-blown specification may not be needed. However, some fields, especially enums, need extra information.
Edited by 🤖 GitLab Bot 🤖