Add include_shared_data parameter to list_share function#1400
Open
maanijou wants to merge 3 commits into
Open
Conversation
|
If integration tests don't run automatically, an authorized user can run them manually by following the instructions below: Trigger: Inputs:
Checks will be approved automatically on success. |
This file contains hidden or 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
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.
Summary
Adds
include_shared_dataparam to list_shares function just like get function so that while fetching the shareinfo, their object info is also fetched.Why
Currently we can use list_shares to fetch share info but unlike get function, there's no way to also specify that we also need to get shared_data information (objects key).
The PR adds
include_shared_dataparam just like get function so that user can indicate the need to getch shared data.Alternative to this approach is to use
getfunction independently on each share again to fetch shared_data for them which is an extra unnecessary step since we can do it inside list_shares.What changed
Interface changes
Adds an optional param to list_shares function with default to None (not changing existing behaviours). If this param is provided with True value, it will fetch the sahred data:
Behavioral changes
Existing behavior is not changed.
Internal changes
Addition of extra param: include_shared_data with default value
None.How is this tested?
Built the package and ran locally to fetch the shared data (no unit test available for this module at the moment)