[MGNLRESTCL-68] RestClient has ability to add query parameters Created: 10/Sep/19 Updated: 19/May/20 Resolved: 13/May/20 |
|
| Status: | Closed |
| Project: | REST Client |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 2.0.1 |
| Type: | Story | Priority: | Neutral |
| Reporter: | Christopher Zimmermann | Assignee: | Jaroslav Simak |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | 0d | ||
| Time Spent: | 2.75d | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||||||||||||||||||||||
| Template: |
|
||||||||||||||||||||||||||||||||||||||||||||
| Acceptance criteria: |
Empty
|
||||||||||||||||||||||||||||||||||||||||||||
| Task DoD: |
[ ]*
Doc/release notes changes? Comment present?
[ ]*
Downstream builds green?
[ ]*
Solution information and context easily available?
[ ]*
Tests
[ ]*
FixVersion filled and not yet released
[ ] 
Architecture Decision Record (ADR)
|
||||||||||||||||||||||||||||||||||||||||||||
| Release notes required: |
Yes
|
||||||||||||||||||||||||||||||||||||||||||||
| Documentation update required: |
Yes
|
||||||||||||||||||||||||||||||||||||||||||||
| Epic Link: | Declarative REST clients | ||||||||||||||||||||||||||||||||||||||||||||
| Sprint: | HL & LD 2 | ||||||||||||||||||||||||||||||||||||||||||||
| Story Points: | 5 | ||||||||||||||||||||||||||||||||||||||||||||
| Description |
|
It must be possible to configure a RestClient in such a way that the caller can add query parameters (the API allows that already for additional values). User story As a developer using a configured RestClient I want to be able to provide completely custom fragments, parameters, headers and cookies, so that I can hit the RestEndpoint in ways that the RestClient configurer could not predict, so I can use RestClients effectively and without too much hassel Rationale Some API's are very flexible and it would be difficult or impossible to configure all of the available options. It is a common usecase that a developer will configure a RestClient mostly to capture the basic connection information, but wants to leave it open to usages (such as freemarker templates) to use the RestClient as they see fit. Example Contentful Delivery API has very many query parameters. It would be a pain to configure them all: Further, there are dynamic parameters, so whoever configures the restClient might not know all parametes ahead of time. (You can actually use one of your contentTypes attributes as a parameter. Details Usage can provide additional values, but cannot change any values "hardcoded" in the RestClient definition. For example, if you have two query params configured on your restCall as: To be determined: Is a RestClient modifiable in this way by default, or what has to be configured in order to make it modifiable? |