search

dcsaorg / DCSA-OpenAPI

DCSA - Digital Container Shipping Association
https://app.swaggerhub.com/apis/dcsaorg/DCSA_OAS
68 stars 13 forks source link

SD-1801: Modify GET /portCallService #452

Closed HenrikHL closed 1 day ago

HenrikHL commented 1 day ago

User description

SD-1801: Modified the GET /port-call-services/{portCallServiceID} call to return a list of Port Call Services

PR Type

enhancement

Description

Changes walkthrough 📝

Relevant files
Enhancement
JIT_v2.0.0.yaml
Enhance GET /port-call-services endpoint with filters       
jit/v2/JIT_v2.0.0.yaml
  • Modified the GET endpoint to return a list of Port Call Services.
  • Added multiple query parameters for filtering the Port Call Services.
  • Updated the response schema to return an array of Port Call Services.
  • Introduced new components for query parameters and response schemas.
    		•  +300/-38
    Additional files (token-limit)
    styleguide.json
    ...                                                                                                           
    .stoplight/styleguide.json ...
    		+2/-2     

    🔍 To retrieve JIRA tickets as context to your PR description, please register your organization.

    codiumai-pr-agent-pro[bot] commented 1 day ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 3 🔵🔵🔵⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Validation Issue
    The startDateTime and endDateTime query parameters are defined with format 'date' but example shows date-time format. Schema validation should be aligned with actual requirements. Documentation Issue
    Description for startDateTime and endDateTime parameters contains typos ("Sercie" instead of "Service") and unclear default value definitions that should be clarified. Schema Validation
    Several query parameters have pattern restrictions that may need review - particularly the voyage reference patterns and vessel identifier formats to ensure they match business requirements.
    codiumai-pr-agent-pro[bot] commented 1 day ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    ✅ Fix spelling error in API documentation that could cause confusion ___
    Suggestion Impact:The suggestion corrected the spelling error "Sercie" to "Service" in the API documentation. code diff: ```diff - The **start date time** of the period for which **Port Call Service** information is requested. If a date and time of any **Timestamp** inside a **Port Call Service** matches a date and time on or after (≥) the `startDateTime` **Port Call Service** will be included in the result. All matching is done towards local Date and time at the place of the**Port Call Service**. The matched **Timestamp** in the timestamps of the **Port Call Service** must be included in the **Port Call Sercie** objects returned. + The **start date time** of the period for which **Port Call Service** information is requested. If a date and time of any **Timestamp** inside a **Port Call Service** matches a date and time on or after (≥) the `startDateTime` **Port Call Service** will be included in the result. All matching is done towards local Date and time at the place of the**Port Call Service**. The matched **Timestamp** in the timestamps of the **Port Call Service** must be included in the **Port Call Service** objects returned. ```
    ___ **Fix typo in startDateTime query parameter description where "Sercie" is misspelled
    as "Service"** [jit/v2/JIT_v2.0.0.yaml [979]](https://github.com/dcsaorg/DCSA-OpenAPI/pull/452/files#diff-9515d70681d4860776aad1fa65c622e5b362021ad1f0c0ae1352067f49108299R979-R979) ```diff -The matched **Timestamp** in the timestamps of the **Port Call Service** must be included in the **Port Call Sercie** objects returned. +The matched **Timestamp** in the timestamps of the **Port Call Service** must be included in the **Port Call Service** objects returned. ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 3 Why: The suggestion fixes a minor typo in the API documentation where "Service" is misspelled as "Sercie". While this is a valid correction that improves documentation quality, it has minimal impact on functionality.
    		3

    💡 Need additional feedback ? start a PR chat

    HenrikHL commented 1 day ago

    I had already pushed for the draft description update before you wrote your teams message @emiliodcsa. Sorry...