improve releases links and vessel include documentation#58
Merged
lykmapipo merged 14 commits intofeature/additional-insightsfrom Apr 29, 2026
Merged
improve releases links and vessel include documentation#58lykmapipo merged 14 commits intofeature/additional-insightsfrom
lykmapipo merged 14 commits intofeature/additional-insightsfrom
Conversation
This: - add direct link to GitHub Releases page - add direct link to published package on PyPI
…cumentation This: - align Insights API documentation with official Global Fishing Watch API terminology - enhance docstrings with official documentation references and data caveats - update `VesselInsightDatasetVessel` model to use `VesselDataset` enum for dataset identifiers - improve `VesselInsightBody` request model with explicit field aliases and clearer parameter documentation - extend `get_vessel_insights()` to accept vessel IDs directly (`List[str]`) - add validation tests for invalid request payload scenarios - add unit tests verifying request serialization and default dataset handling - improve test coverage for resource behavior when vessel IDs are passed directly
This:
- update integration tests to pass vessel IDs directly instead of `{dataset_id, vessel_id}` objects
- add integration tests for `VESSEL-IDENTITY-FLAG-CHANGES` insight type
- add integration tests for `VESSEL-IDENTITY-MOU-LIST` insight type
This:
- update caveat references and dataset examples in documentation
- update vessel input examples to use vessel ID strings instead of `{dataset_id, vessel_id}` objects
- expand examples for `FISHING`, `VESSEL-IDENTITY-IUU-VESSEL-LIST`, and `COVERAGE` insights
- expand examples for `GAP`, `VESSEL-IDENTITY-FLAG-CHANGES`, and `VESSEL-IDENTITY-MOU-LIST` insights
- add example showing retrieval of multiple insights for multiple vessels
…ehavior This: - expand `VesselInclude.POTENTIAL_RELATED_SELF_REPORTED_INFO` docstring - add official Vessel Viewer reference link for context and usage understanding - align `VesselResource` parameter documentation with updated include description
lykmapipo
requested review from
aperdizs,
giselamo,
rrequero,
tomaslink and
yaaNuamahGFW
giselamo
reviewed
Apr 16, 2026
tomaslink
approved these changes
Apr 16, 2026
This: - Update docstrings with links to Vessels API documentation - Update docstrings with vessel identity data caveats
This: - Add instructions for enabling `FLAG-CHANGES` and `MOU-LIST` insights - Update caveat links to use "Apparent fishing" terminology
enhance insights API models, documentation, and test coverage
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
3 participants
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.
This:
GitHub ReleasesandPyPI packageon the documentation homepagePOTENTIAL_RELATED_SELF_REPORTED_INFOvessel include optionVesselResourceparameter documentation with updated include descriptions