Allows for "expand" option in search requests #77
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Since this utilizes NULL for the default, it should not create any BC breaks. Also, the underlying HTTP transmission code utilizes "http_build_query()" from PHP, and in this function array entries with NULL values are not included in the output. So, this change wouldn't even affect the URLs that are generated.
|
I created this PR as I was trying to get Jira issue descriptions to output as HTML. I first tried using a Markdown parser, but it looks like Jira uses it's own proprietary markup language. As such, the only way to get the HTML version of the description would be to allow for the "expand" field to be added to the API request. For information, read the "Expansion" section on the API documentation: https://docs.atlassian.com/jira/REST/latest/ |
aik099
changed the title
| @@ -453,6 +454,7 @@ public function search($jql, $startAt = 0, $maxResult = 20, $fields = '*navigabl | |||
| 'startAt' => $startAt, | |||
| 'maxResults' => $maxResult, | |||
| 'fields' => $fields, | |||
| 'expand' => $expand, | |||
There was a problem hiding this comment.
Better not to rely on fact, that http_build_query is used in used in underlying client class and do the following:
- move out the parameter array into a separate variable
- add an IF statement that would check for
isset($expand)and only then add array entry - use that array in
->apicall
|
Please rebase and solve conflicts. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since this utilizes NULL for the default, it should not create any BC breaks. Also, the underlying HTTP transmission code utilizes "http_build_query()" from PHP, and in this function array entries with NULL values are not included in the output. So, this change wouldn't even affect the URLs that are generated.