feat: ei-3539 - Update the SDK to handle the allow_upload flag in list connections #44
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
jmayne-iotics
force-pushed
the
ei-3539-update-sdk-to-recognise-allow_upload-flag
branch
from
5b7c858 to
a182dff
Compare
andyantrim
reviewed
Dec 4, 2024
jmayne-iotics
force-pushed
the
ei-3539-update-sdk-to-recognise-allow_upload-flag
branch
2 times, most recently
from
6b7ee4a to
0ec97a3
Compare
vtermanis
reviewed
Dec 5, 2024
nyx_client/nyx_client/client.py
Outdated
| Returns: | ||
| A list of `Connection` objects | ||
|
|
||
| Raises: | ||
| requests.HTTPError: if the API request fails. | ||
| """ | ||
| connections = self._nyx_get(NYX_CONNECTIONS_ENDPOINT) | ||
| params = dict(allow_upload=allow_upload) if allow_upload is not None else None |
There was a problem hiding this comment.
Typically (at least in this repo) we don't instantiate dictionarties using the class syntax but instead do e.g.:
{"allow_upload": allow_upload}.
(It also makes a small perf difference but that's irrelevant here.)
vtermanis
reviewed
Dec 5, 2024
vtermanis
reviewed
Dec 5, 2024
| @@ -937,14 +937,19 @@ def delete_circle(self, circle: Circle): | |||
| """ | |||
| self.delete_circle_by_name(circle.name) | |||
|
|
|||
| def get_connections(self) -> list[Connection]: | |||
| def get_connections(self, allow_upload: bool | None = None) -> list[Connection]: | |||
There was a problem hiding this comment.
If there were a test already for get_connections, I'd say to to add parametrized one to show that this option is passed through. However I see on main we don't have any yet.
jmayne-iotics
force-pushed
the
ei-3539-update-sdk-to-recognise-allow_upload-flag
branch
from
0ec97a3 to
f3e0f65
Compare
vtermanis
reviewed
Dec 6, 2024
| """Lists all connections. | ||
|
|
||
| Args: | ||
| allow_upload: Filter the connections by allow_upload, defaults to show all. |
There was a problem hiding this comment.
I'd say the only thing is it might be clear to uses that there are three options here:
None- allallow_upload=Truejust with upload enabled (write)allow_upload=Falsejust with upload disabled (read-only)
But maybe it doesn't matter.
vtermanis
approved these changes
Dec 6, 2024
andyantrim
approved these changes
Dec 9, 2024
jmayne-iotics
deleted the
ei-3539-update-sdk-to-recognise-allow_upload-flag
branch
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.
Update the SDK to handle the allow_upload flag in list connections