standardize region models and improve documentation#52
Merged
Conversation
This: - add `RegionDataset` enum for supported regions datasets - add `Region` base model with dataset and id fields - add comprehensive tests for region serialization and validation
This: - refactor `EEZRegionItem`, `MPARegionItem`, and `RFMORegionItem` to inherit from `Region` and `ResultItem` - replace raw dataset strings with `RegionDataset` enum for stronger typing - normalize region IDs to strings across region models - update tests to assert `id` is coerced to string - update `Region` docstrings for clarity and consistency
This: - reuse base Region model for Bulk Download, Events, and 4Wings request regions - expand Region and references docstrings with official data caveats links
lykmapipo
requested review from
aperdizs,
giselamo,
tomaslink and
yaaNuamahGFW
lykmapipo
added
documentation
Collaborator
|
Hello there,
Thank you for contacting the Global Fishing Watch API Team. This automated
message confirms that we have received your inquiry. We appreciate your
interest in our APIs and are happy to support your project.
*Response time:*
Due to the volume of requests, replies may take up to five working days.
For urgent matters, please reply with “*URGENT*” in the subject and our
team will prioritize your request. We appreciate your patience and
understanding during this time while we offer assistance.
*Helpful resources*:
▸ Postman Collection
<https://globalfishingwatch.org/our-apis/documentation#get-your-gfw-postman-collection-for-version-3>,
Access pre-built API requests
▸ Data Caveats
<https://globalfishingwatch.org/our-apis/documentation#data-caveat> for
limitations and usage notes
▸ Reference Data
<https://globalfishingwatch.org/our-apis/documentation#reference-data> for
key API fields
▸ Canny Feedback Board <https://global-fishing-watch.canny.io/> for
feedback and platform improvements
*Other contacts*:
▸ Media and press: ***@***.***
▸ Research and data requests: ***@***.***
▸ General platform support: ***@***.***
▸ Careers: ***@***.***
If you have additional details, such as screenshots, request samples, or
error logs, please reply to this email so we can assist you more
efficiently.
Thank you for your patience as we work to provide you with the best
possible support for using Global Fishing Watch's APIs.
Warm regards,
*API Team*
*Global Fishing Watch*
|
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
4 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:
Regionbase model andRegionDatasetenumEEZRegionItem,MPARegionItem, andRFMORegionItemitems to use the common region modelidfields to stringsRegionmodel acrossBulk Download,Events, and4Wingsrequests