Loading
Add content-type to Generic Alert docs
What does this MR do?
Since Generic Alert Endpoint expects JSON as a payload it should have a "Content-Type: application/json"
Examples
Before
→ curl --request POST --data '{"title": "Incident title"}' --header "Authorization: Bearer randomtoken" http://localhost:3000/ck3g/playground/alerts/notify
<ActionController::Parameters {"{\"title\": \"Incident title\"}"=>nil, "controller"=>"projects/alerting/notifications", "action"=>"create", "namespace_id"=>"ck3g", "project_id"=>"playground"} permitted: false>produces invalid parameter
{"{\"title\": \"Incident title\"}"=>nil
After
→ curl --request POST --data '{"title": "Incident title"}' --header "Authorization: Bearer randomtoken" --header "Content-Type: application/json" http://localhost:3000/ck3g/playground/alerts/notify
<ActionController::Parameters {"title"=>"Incident title", "controller"=>"projects/alerting/notifications", "action"=>"create", "namespace_id"=>"ck3g", "project_id"=>"playground", "notification"=>{"title"=>"Incident title"}} permitted: false>Related issues
Related to the Generic Alert Endpoint.
Author's checklist
- Follow the Documentation Guidelines and Style Guide.
- If applicable, update the permissions table.
- 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.