Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add support for filter_entity_type on transfer client endpoint search #1109

Conversation

pjhinton-globus
Copy link
Contributor

@pjhinton-globus pjhinton-globus commented Nov 12, 2024

Added a new keyword argument to TransferClient.endpoint_search() that supports filtering by the collection entity type. Updated filter_non_functional argument to indicate its mutual exclusivity with filter_entity_type.

Once this has passed through review, a separate PR will be opened for the CLI that adds a --filter-entity-type option to globus endpoint search.

refs sc-37389


📚 Documentation preview 📚: https://globus-sdk-python--1109.org.readthedocs.build/en/1109/

@pjhinton-globus pjhinton-globus force-pushed the pjhinton/sc-37389-transfer-client-collection-search-filter-entity-type branch from a1df63c to 96d7880 Compare November 25, 2024 14:42
Added a new keyword argument to TransferClient.endpoint_search() that
supports filtering by the collection entity type. Updated
filter_non_functional argument to indicate its mutual exclusivity
with filter_entity_type.

refs sc-37389
@pjhinton-globus pjhinton-globus force-pushed the pjhinton/sc-37389-transfer-client-collection-search-filter-entity-type branch from 96d7880 to 794c708 Compare December 3, 2024 20:07
Changes implemented per review from @sirosen.

* Uncommented out header lines for scriv and
removed lines not pertinent to change.

* Updated annotation for filter_entity_type to use
Literal[] with list of five recognized entity
types as the API only accepts a single entity
type as a value.

* Updated documentation for filter_entity_type
be more explicit that it filters on only one
type. That is, you can't combine them into a
comma-delimited list.
Copy link
Member

@sirosen sirosen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great; thanks for making those adjustments!

I spotted one final thing before we can approve+merge, and then we should be good to go.

Per @sirosen guidance. Fixing my RST noob error by
doubling backticks on inline code.
@sirosen sirosen merged commit 8f3f664 into globus:main Dec 3, 2024
2 checks passed
@pjhinton-globus pjhinton-globus deleted the pjhinton/sc-37389-transfer-client-collection-search-filter-entity-type branch January 9, 2025 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants