Update outdated example in HTTP API documentation

Open Beginner friendly
#455 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
go
Domain
api, documentation

Research direction

Locate the HTTP API documentation containing the outdated curl example and read the surrounding request description. Update the example payload so it sets at least one of 'incident' or 'muted', then verify that the documented request no longer produces the reported validation error.

Written by the indexing model from the issue text.

Description

doc

The changes to Event.Validate in Icinga/icinga-go-library#212 - introduced here via #442 - invalidated the curl example in the HTTP API documentation. The example payload now errors out with "invalid event: at least one of 'incident' or 'muted' must be set".

Dominant language
Go
Stars
26
Forks
3
Avg merge
1d 23h
Merged PRs (30d)
17

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Icinga/icinga-notifications

All issues in Icinga/icinga-notifications

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.