- Notifications
You must be signed in to change notification settings - Fork 123
Description
Currently, all of the public methods (direct calls to the Api::api method outside of the library or internal calls to the Api::api method from inside the library) follow this pattern in preparation of the upcoming API call:
- (
URLpart) build an URL from method parameters (e.g.sprintf('/rest/api/2/issue/%s/worklog', $issue_key)) or hardcode it inside the method (e.g.'/rest/api/2/issuetype') - (
Request bodypart) either specify method parameters as-is to the performed API call (e.g.Api::getIssuemethod) or transform them as needed (e.g.Api::addWorklog) - (only for GET requests currently;
Query parameterspart) specify what should be appended to the URL - specify if this a file-uploading request
- specify if the request needs to be debugged
Proposing these changes:
Before:
// Before: $api->deleteWorklog('JRE-123', 124353, array('custom' => 'param')); $api->addWorklog('JRE-123', '12m', array('comment' => 'test', '_query' => array('notifyUsers' => false)); // After: $api->withRequestBody(array('custom' => 'param'))->deleteWorklog('JRE-123', 124353); $api->withRequestBody(array('comment' => 'test'))->withQueryParameters(array('notifyUsers' => false))->addWorklog('JRE-123', '12m');The file support could be added using withFile(...) method.
This way the with... methods will just collect the data and supply it to the Api::api method. The API method itself will consume these parameters and clear previously stored ones to avoid them being passed to the next API call made.
The proposed approach greatly reduces boilerplate code for new API call method creation and adds built-in support for Request body and Query parameters support for every API call.
P.S.
The mentioned _query key of the $params array will be supported only after #222 merge.