New search method to return custom fields + bonus missing idReadable #34
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As per #19,
IssueEndpoint.search
method does not return the issue's custom fields.This forces developers to run additional requests for each issue returned by the search to get the required data.
This is inefficient.
This PR aims to solve the main issue of the missing custom fields.
I also added
idReadable
toReducedIssueImpl
(as a separate commit), as I think it's a fundamental property of an issue.Long story
I initially tried to reuse the
IssueEndpoint.search
method using generics, but theimplementation
parameter, required byBaseEndpoint.getResourceWithFields
, prevented me from doing that.I've also tried the overload pattern, but I still struggled with that
implementation
parameter.I ended up defining a new
searchIssues
method that returnsIssue[]
(instead ofReducedIssue[]
) and usesIssueImpl
(instead ofReducedIssueImpl
).An ideal option might be to redefine
IssueEndpoint.search
, which would introduce a breaking change.