Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Oct 3, 2025

User description

SD-42: Add vesselOperatorSMDGLinerCode as filter


PR Type

Enhancement


Description

  • Add vesselOperatorSMDGLinerCode query parameter filter

  • Enable filtering by SMDG liner code for vessel operators


Diagram Walkthrough

flowchart LR
  API["OVS API"] --> Filter["vesselOperatorSMDGLinerCode Filter"] --> Results["Filtered Schedule Results"]
Loading

File Walkthrough

Relevant files
Enhancement
OVS_v3.0.1.yaml
Add vessel operator SMDG liner code filter                             

ovs/v3/OVS_v3.0.1.yaml

  • Add new query parameter vesselOperatorSMDGLinerCode
  • Set maximum length of 10 characters with MSK example
  • Include description for SMDG carrier code filtering
+8/-0     

@qodo-code-review
Copy link

qodo-code-review bot commented Oct 3, 2025

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢
No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🎫 No ticket provided
  • Create ticket/issue
Codebase Duplication Compliance
Codebase context is not defined

Follow the guide to enable codebase context checks.

Custom Compliance
No custom compliance provided

Follow the guide to enable custom compliance check.

  • Update
Compliance status legend 🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

@qodo-code-review
Copy link

qodo-code-review bot commented Oct 3, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
General
Adjust maxLength for better validation

Reduce the maxLength for the vesselOperatorSMDGLinerCode parameter from 10 to a
more accurate and restrictive value to improve input validation.

ovs/v3/OVS_v3.0.1.yaml [153]

-maxLength: 10
+maxLength: 5
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly points out that the maxLength is likely too permissive and recommends a stricter value, which improves the API's input validation and contract accuracy.

Medium
Improve parameter description for clarity
Suggestion Impact:The commit updated the parameter description to be clearer and more precise about the vessel operator's SMDG code, aligning with the intent to improve clarity, though it did not include the full filtering behavior wording proposed.

code diff:

           description: |
-            `SMDG` code of the carrier in charge with the vessel operation.
+            `SMDG` code of the carrier responsible for vessel operation.

Expand the description for the vesselOperatorSMDGLinerCode parameter to clarify
its filtering behavior, making it consistent with other parameter descriptions
in the file.

ovs/v3/OVS_v3.0.1.yaml [149-150]

 description: |
-  `SMDG` code of the carrier in charge with the vessel operation.
+  The `SMDG` liner code for the vessel operator. Specifying this filter will return schedules for voyages where the vessel is operated by the carrier matching this `SMDG` code.

[Suggestion processed]

Suggestion importance[1-10]: 6

__

Why: This suggestion improves the clarity and consistency of the API documentation by aligning the new parameter's description with the style of existing parameters.

Low
  • Update

Co-authored-by: Pedro Carvalho <pedro.carvalho@dcsa.org>
@HenrikHL HenrikHL merged commit 090ab1e into master Oct 6, 2025
1 check passed
@HenrikHL HenrikHL deleted the SD-42_Add-smdglinercode-filter branch October 6, 2025 11:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants