Icinga API Documentation Error

Icinga 2
1

Hi,

I am not sure where to report this but I found an error in the Icinga API docs, https://icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#event-stream-response the code in the curl example contains an error.

Your example:

$ curl -k -s -u root:icinga -H 'Accept: application/json' \
-X POST 'https://localhost:5665/v1/events' \
-d '{ "queue": "myqueue", "types": "CheckResult", "filter": "event.check_result.exit_status==2" }'

Results in a server 500 error

“types” according to the API documentation is an array (https://icinga.com/docs/icinga2/latest/doc/12-icinga2-api/#icinga2-api-event-streams)

So… the correct call is: -

$ curl -k -s -u root:icinga -H 'Accept: application/json' \
-X POST 'https://localhost:5665/v1/events' \
-d '{ "queue": "myqueue", "types": ["CheckResult"], "filter": "event.check_result.exit_status==2" }'

Cheers!

Ein hefferweitzen für mich denk ich :wink:

2

Hi,

you could create a pull request to apply those changes :slight_smile:
https://github.com/Icinga/icinga2

Greetz

1 Like
3

Heyhey!
As Alex said, a PR on Github would be the way to go :slight_smile:
I’ll just point you to the file while we’re at it to get started :slight_smile:

Have a nice day!
Feu

4

Hi Feu,

I have checked out the code, created a branch and carried out the changes. As I do not have write permissions to the repository I am unable to create a pull requests.

What is your process.

Kind regards
Peter

5

Hey!

The workflow on GitHub is, that you make a “fork” (that’s like a clone of the repository on your account) and then you can create the pull request from there.
When you look at a project, you can usually just select a file and use the web editor to make changes, which automatically generates you a fork, if you don’t have write access. And from there you can also submit the pull request.

If you already made changes to your local clone of the project, I think it would be easiest if you just copy-paste them over into the editor in the web :slight_smile:

You can also have a look at GitHubs forking workflow guide.
When you got the process down, you’ve got your first steps done to contributing more to open source projects! :slight_smile:

Thank you!
Feu

6

Hello Feu,

forking done :wink: (English humour) LOL

pull request executed.

Peter

1 Like
7

Thank you so much!

Onto a bright forking future in the open source community! :grin::+1: