Removed incorrect typehint of $data in Api::api() which caused setWatchers to throw a warning

[alopex06]

setWatchers Method pass a String as Data for the api call and not an array. This produces an warning that crash some applications.

PHP Error:

PHP Catchable fatal error: Argument 3 passed to chobie\Jira\Api::api() must be an array, string given

[aik099]

Interesting. More issues related to this, that I've found:

1. set setWatchers method is the only one, that does so
2. the ClientInterface::sendRequest method (in all implementations) that is called from Api::api when we're doing GET request is expecting $data to be array (passes it into http_build_query), but don't care in all other request methods (e.g. POST)

[jpastoor]

https://docs.atlassian.com/jira/REST/latest/#api/2/issue-addWatcher
seems indeed valid to add as string, so I don't think we can enforce data to be an array. (regression in 49615cf)

[aik099]

The change (when typehint was added) was a result of wrong DocBlock comment on the sendRequest and api methods. To avoid such mistake in future I'm proposing:

1. update data type (+ reformat DocBlock) for Api::api to array|string
2. update data type (+ reformat DocBlock) for all sendRequest methods (2 implementation + interface) to array|string
3. in sendRequest implementations throw an InvalidArgumentException when GET request is made, but $data isn't an array

[jpastoor]

Agree with aik099 points and would very much like to see that in this PR.

Some additional wishes (but if you aint sure how to do it I'll add it soon in a separate PR)
4. Unittest to validate 3.
5. Unittest to validate setWatcher propagates correctly to the sendRequest interface

[aik099]

Please reformat DocBlock to alight parameter names and their descriptions.

[aik099]

Please mention in DocBlock via @throws tag, that this exception is being thrown.

[aik099]

Also PHPClient and ClientInterface where not changed.

[alopex06]

Ok thank you for the quick responses.
@jpastoor that would be nice if you could update the unittests later.

[aik099]

@jpastoor that would be nice if you could update the unittests later.

Not used to writing unit tests?

[jpastoor]

Merged, thanks

[aik099]

This needs to be moved up. Otherwise you already get notice about wrong parameter usage in http_build_query call.

[aik099]

And same part in PHPClient is still missing.

[aik099]

@jpastoor , this PR is incomplete. It not only misses tests, but also misses points we've mentioned as needed.

Therefore until you check that all requested items were done don't merge it.