Fix bug in nb_lookup if api_filter contains multiple id
#1042
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
In the `nb_lookup` plugin, if we provide an `api_filter` containing the `id` field, it will use `.get()` instead of `.filter()`, thus returning the item instead of a list. See PR netbox-community#376 for more information. This is fine if you supply only one id. But let's say you want to get a list of items by ids? For example: `id=1 id=5` I would expect to get a list of 2 items. But at the moment, it will return the first item only. This change adds a simple check to see if we're supplying multiple ids.
|
At the very least, this needs a test that exercises sending two IDs as a filter and verifying the desired behavior |
sc68cal
requested changes
Aug 1, 2023
There was a problem hiding this comment.
missing new integration test in https://github.com/netbox-community/ansible_modules/blob/devel/tests/integration/targets/v3.5/tasks/netbox_lookup.yml
make sure you add it to all the targets that we track
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.
Related Issue
New Behavior
In the
nb_lookupplugin, when supplying multipleidfields to theapi_filterparameter, it will return a list of items.Contrast to Current Behavior
In the
nb_lookupplugin, if we provide anapi_filtercontaining theidfield, it will use.get()instead of.filter(), thus returning the item instead of a list. See PR #376 for more information.This is fine if you supply only one id. But let's say you want to get a list of items by ids?
For example:
id=1 id=5I would expect to get a list of 2 items. But at the moment, it will return the first item only.
This change adds a simple check to see if we're supplying multiple ids.
Discussion: Benefits and Drawbacks
This fixes a bug where supplying multiple ids in the
api_filterends up returning only one item.In fact, I'd even expect that supplying a single id would return a list of one item, since we're querying a collection. So maybe a
many=True|Falseparameter would be better?This bugfix as it is is backward-compatible.
Double Check
develbranch.