feat: add support for setting URL parameters on client requests #234
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
Several NS1 API endpoints allow setting URL parameters to alter the behavior of the endpoint. For instance, a `limit` parameter can be set on the `/account/activity` endpoint to control how many events are returned in the response. This would be useful in ns1#233. This commit adds support for URL parameters by adding a new struct `Param` to the `rest` package, and updating `rest.client.Do()` and `rest.client.DoWithPagination()` to accept a variable amount of params. In order for higher level services based off of the common service to set url params, they will need to pass them through when invoking the client's `Do()` method, like so: ```golang resp, err := s.client.Do(req, &al, params...) ```
tjhop
added a commit
to tjhop/ns1-go
that referenced
this pull request
Apr 4, 2024
tjhop
added a commit
to tjhop/ns1-go
that referenced
this pull request
Apr 4, 2024
Zach-Johnson
reviewed
Apr 4, 2024
Zach-Johnson
reviewed
Apr 4, 2024
tjhop
added a commit
to tjhop/ns1-go
that referenced
this pull request
Apr 4, 2024
Depends on ns1#234 Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
tjhop
added a commit
to tjhop/ns1-go
that referenced
this pull request
Apr 4, 2024
Depends on ns1#234 Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
Updating doc comments to reflect what these URL parameter configs are/do. Signed-off-by: TJ Hoplock <t.hoplock@gmail.com>
Zach-Johnson
approved these changes
Apr 4, 2024
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.
Several NS1 API endpoints allow setting URL parameters to alter the behavior of the endpoint. For instance, a
limitparameter can be set on the/account/activityendpoint to control how many events are returned in the response. This would be useful in #233.This commit adds support for URL parameters by adding a new struct
Paramto therestpackage, and updatingrest.client.Do()andrest.client.DoWithPagination()to accept a variable amount of params. In order for higher level services based off of the common service to set url params, they will need to pass them through when invoking the client'sDo()method, like so: