You need to sign in or sign up before continuing.
Fix job event webhook documentation inconsistency with its actual request body
What does this MR do?
Fix job event webhook documentation inconsistency with its actual request body.
- The actual value for
object_kind
is not "job" but "build" - The
job_xxx
fields is actuallybuild_xxx
The implementation may not be changed to keep backward compatibility, although "job" might be better in keeping consistency with web UI and documentation.
- Code for building the requeset body: lib/gitlab/data_builder/build.rb
- Documentation: https://docs.gitlab.com/ce/user/project/integrations/webhooks.html#job-events
Author's checklist
-
Follow the Documentation Guidelines and Style Guide. -
Link docs to and from the higher-level index page, plus other related docs where helpful. -
Apply the ~Documentation label.
Review checklist
All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.
1. Primary Reviewer
-
Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.
2. Technical Writer
-
Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
3. Maintainer
-
Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review. -
Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist. -
If there has not been a technical writer review, create an issue for one using the Doc Review template.