feat(bulk-data): accept OData media links for bulk downloads#92
Open
feat(bulk-data): accept OData media links for bulk downloads#92
Conversation
Add a non-breaking media_link option to get_bulk_data() and get_bulk_data_stream() so callers can use the exact OData links returned by DSIS instead of rebuilding entity endpoints. Keep the existing QueryBuilder.entity() flow intact and document the new direct media-link usage with focused tests.
tokams
commented
Apr 14, 2026
tokams
requested review from
Qif-Equinor,
TordAreStromsnes and
Copilot
and removed request for
Qif-Equinor and
TordAreStromsnes
There was a problem hiding this comment.
Pull request overview
Adds optional support for passing DSIS-provided OData media links directly into the bulk download helpers, avoiding the need for callers to rebuild entity endpoints.
Changes:
- Extend
get_bulk_data()/get_bulk_data_stream()with an optionalmedia_linkparameter and endpoint resolution logic. - Add focused tests covering relative links, absolute links under the configured data endpoint, streaming, and rejection of other services.
- Update docs to describe the new
media_linkflow and include examples.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
src/dsis_client/api/client/_bulk_data.py |
Adds endpoint resolution for entity-based vs media-link-based bulk downloads. |
tests/test_bulk_data_media_link.py |
New tests validating media-link normalization and preserving existing entity behavior. |
docs/guides/working-with-binary-data.md |
Documents direct media-link usage for bulk downloads. |
docs/guides/query-builder.md |
Notes that media links from DSIS responses can be passed directly to bulk methods. |
docs/api/index.md |
Updates API reference signatures/parameters and adds media-link usage examples. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Add a non-breaking media_link option to get_bulk_data() and get_bulk_data_stream() so callers can use the exact OData links returned by DSIS instead of rebuilding entity endpoints.
Keep the existing QueryBuilder.entity() flow intact and document the new direct media-link usage with focused tests.