Uploaded image for project: 'REST Client'
  1. REST Client
  2. MGNLRESTCL-68

RestClient has ability to add query parameters

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Closed
    • Priority: Neutral
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0.1
    • Component/s: None
    • Labels:
      None
    • Release notes required:
      Yes
    • Documentation update required:
      Yes
    • 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:

      https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters

      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.
      https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/search-parameters/ranges/query-entries/console/curl)

      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:
      queryParams:
       category: destinations
       pageSize: ${pageSize}
      I expect you can pass a different pageSize, and add new query parameters, but not override the category

      To be determined:

      Is a RestClient modifiable in this way by default, or what has to be configured in order to make it modifiable?

        Checklists

        Acceptance criteria

          Attachments

            Issue Links

              Activity

                People

                Assignee:
                jsimak Jaroslav Simak
                Reporter:
                czimmermann Christopher Zimmermann
                Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                  Dates

                  Created:
                  Updated:
                  Resolved:

                    Checklists

                    DoD

                      Time Tracking

                      Estimated:
                      Original Estimate - Not Specified
                      Not Specified
                      Remaining:
                      Remaining Estimate - 0d
                      0d
                      Logged:
                      Time Spent - 2.75d
                      2.75d