Skip to content

implement vessel insights and fourwings API endpoints#13

Merged
lykmapipo merged 10 commits intofeature/references-api-endpointsfrom
feature/insights-api-endpoints
Apr 8, 2025
Merged

implement vessel insights and fourwings API endpoints#13
lykmapipo merged 10 commits intofeature/references-api-endpointsfrom
feature/insights-api-endpoints

Conversation

@lykmapipo
Copy link
Copy Markdown
Collaborator

This:

  • Add InsightResource and VesselInsightEndPoint for accessing vessel insights API
  • Add FourWingsResource and FourWingsReportEndPoint for 4Wings report API access

This:

- add `InsightResource` for interacting with the vessels insights API
- add `VesselInsightEndPoint` for handling API requests
- add `VesselInsightBody`, `VesselInsightDatasetVessel`, `VesselInsightInclude` for validating and serializing request data
- add `VesselInsightItem`, `VesselInsightResult`, etc. for deserializing and validating API responses
This:

- add `FourWingsResource`, a high-level resource class for making requests to the 4Wings API
- add `FourWingsReportEndPoint`, an endpoint class for handling specific report requests
- add `FourWingsReportParams` and `FourWingsReportBody` for serializing and validating request parameters and bodies
- add `FourWingsReportItem` and `FourWingsReportResult` for deserializing and validating API responses
This:

- add `VesselResource` class for high-level API interaction
- add `VesselSearchEndPoint`, `VesselListEndPoint`, and `VesselDetailEndPoint` for specific API calls
- add `VesselSearchParams`, `VesselListParams`, and `VesselDetailParams` Pydantic models for request parameters
- add `VesselSearchItem`, `VesselSearchResult`, `VesselListItem`, `VesselListResult`, `VesselDetailItem`, `VesselDetailResult` Pydantic models for API response data
This:

- add clear instructions on setting up and running integration tests.
- add a naming convention guide for integration tests.
This:
- add `EventResource` class for high-level API interaction
- add `EventListEndPoint`, `EventDetailEndPoint`, and `EventStatsEndPoint` for specific API calls
- add `EventListParams`, `EventListBody`, `EventDetailParams`, `EventStatsBody` Pydantic models for request parameters
- add `EventListItem`, `EventListResult`, `EventDetailItem`, `EventDetailResult`, `EventStatsItem`, `EventStatsResult` Pydantic models for API response data
- add integration tests for all implemented endpoints
@lykmapipo lykmapipo added the enhancement New feature or request label Apr 7, 2025
@lykmapipo lykmapipo self-assigned this Apr 7, 2025
Copy link
Copy Markdown
Collaborator

@tomaslink tomaslink left a comment

Choose a reason for hiding this comment

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

LGTM

Comment thread src/gfwapiclient/client/client.py
@lykmapipo lykmapipo merged commit 19cce77 into feature/references-api-endpoints Apr 8, 2025
1 check passed
@lykmapipo lykmapipo deleted the feature/insights-api-endpoints branch April 8, 2025 05:06
Copy link
Copy Markdown

@rrequero rrequero left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants