Skip to content

Conversation

@lykmapipo
Copy link
Collaborator

No description provided.

This:
- clarify descriptions for reports
- add explicit "learn more" links alongside data caveats in documentation and notebooks
- include note highlighting differences between AIS vessel presence and SAR vessel detection
- update Python version in notebooks metadata (3.11.11 → 3.11.14)
Update dependencies and improve 4Wings documentation clarity
…ownload API

This:
- add `BulkReportItem`, `BulkReportGeography`, and `BulkReportStatus` Pydantic models for API response data
- add `BulkReportDataset`, and `BulkReportFileType` Pydantic models for request parameters
- add `BulkReportFormat`, `BulkReportGeometry`, and `BulkReportRegion` Pydantic models for request parameters
- add unit tests and fixtures validating model serialization and data handling
…models

This:
- add `BulkReportCreateEndPoint`, an endpoint class for handling specific bulk report create requests
- add `BulkReportCreateBody` for serializing and validating request bodies
- add `BulkReportCreateItem` and `BulkReportCreateResult` for deserializing and validating API responses
…models

This:
- add `BulkReportDetailEndPoint`, an endpoint class for handling specific bulk report detail requests
- add `BulkReportDetailItem` and `BulkReportDetailResult` for deserializing and validating API responses
…dels

This:
- add `BulkReportListEndPoint`, an endpoint class for handling specific bulk report list requests
- add `BulkReportListParams` for serializing and validating request parameters
- add `BulkReportListItem` and `BulkReportListResult` for deserializing and validating API responses
…dels

This:
- add `BulkReportFileEndPoint`, an endpoint class for handling specific bulk report file requests
- add `BulkReportFileParams` for serializing and validating request parameters
- add `BulkReportFileItem` and `BulkReportFileResult` for deserializing and validating API responses
This:
- implement `BulkDownloadResource` class for high-level API interaction
- implement `create_bulk_report` API endpoint
- implement `get_bulk_report_by_id` API endpoint
- implement `get_all_bulk_reports` API endpoint
- implement `get_bulk_report_file_download_url` API endpoint
add base request and response models for Bulk Download API
…odels

This:
- add `BulkReportQueryEndPoint`, an endpoint class for handling specific bulk report query requests
- add `BulkReportQueryParams` for serializing and validating request parameters
- add `BulkReportQueryItem` and `BulkReportQueryResult` for deserializing and validating API responses
- add `BulkFixedInfrastructureDataQueryEndPoint` for handling fixed infrastructure bulk report query requests
- add `fixtures` and `unit tests` for `BulkReportQueryParams`, and `BulkFixedInfrastructureDataQueryEndPoint`
…-create

implement bulk report create API endpoints and request/response models
…-detail

implement get bulk report by id (detail) API endpoints and response models
…-list

implement get all bulk reports by user (list) API endpoints and request/response models
…-file

implement download bulk report file url (file) API endpoints and request/response models
…-resource

implement Bulk Download API resource and client integration
…-query

implement get bulk report data in JSON Format (query) API endpoints and request/response models
improve API documentation, prerequisites, and usage examples
This also:
- enable MyST-NB for rendering and executing Markdown and Jupyter notebooks
- configure notebook execution settings for docs builds
- add workflow guides to documentation navigation and index
- link workflow guides from getting started and usage guides
This:
- add missing `vessel_ids` in `docs/source/getting-started.md`
- add jupyter notebooks to black dependency i.e `black[jupyter]`
- add make tasks for formatting and linting notebooks
This:
- document async-first behavior in getting-started guide
- add tips for running async code in interactive environments
- link usage guides and notebooks to official GFW API documentation pages
add API workflow guides and jupyter notebooks
…aveats

This:
- replace generic data caveats with AIS apparent fishing effort data caveats
- replace generic data caveats with AIS vessel presence data caveats
- replace generic data caveats with SAR vessel detections data caveats
improve documentation, notebooks, and async usage guidance
@lykmapipo lykmapipo self-assigned this Jan 13, 2026
@lykmapipo lykmapipo added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 13, 2026
@lykmapipo lykmapipo merged commit 757f4ab into main Jan 13, 2026
4 checks passed
@lykmapipo lykmapipo deleted the release/1.4.0 branch January 13, 2026 09:46
@lykmapipo lykmapipo restored the release/1.4.0 branch January 13, 2026 09:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants