Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Oct 24, 2025

User description

SD-2594: Removed cursor, limit query parameters and removed the Next-Cursor header in the response
SD-2595: Changed SDMG -> SCAC
Added an extra example to show a result where there are 2 endorsement chain results for the same transportDocumentReference


PR Type

Enhancement


Description

  • Removed pagination support (limit and cursor query parameters)

  • Removed Next-Page-Cursor response header for pagination

  • Renamed carrier code from SMDG to SCAC throughout API

  • Added note clarifying endpoint does not support pagination

  • Added new example showing multiple endorsement chains for same transport document reference


Diagram Walkthrough

flowchart LR
  A["Endorsement Chain API"] -->|Remove| B["Pagination Parameters<br/>limit, cursor"]
  A -->|Remove| C["Next-Page-Cursor Header"]
  A -->|Rename| D["carrierSMDGCode<br/>to carrierSCACCode"]
  A -->|Add| E["Documentation Note<br/>No pagination support"]
  A -->|Add| F["Example: Multiple<br/>Endorsement Chains"]
Loading

File Walkthrough

Relevant files
Enhancement
EBL_END_v3.0.2.yaml
Remove pagination and update carrier code standard             

ebl/v3/endorsement/EBL_END_v3.0.2.yaml

  • Renamed carrierSMDGCode parameter and property to carrierSCACCode with
    updated documentation referencing NMFTA instead of SMDG
  • Removed limit and cursor query parameters from the GET endpoint
  • Removed Next-Page-Cursor response header and its detailed
    documentation
  • Added note to endpoint description stating pagination is not supported
  • Added new example (twoTDSRExample) demonstrating multiple endorsement
    chains for the same transportDocumentReference
  • Updated EndorsementChain schema description to clarify relationship
    with transport document references
+74/-37 

@HenrikHL HenrikHL requested a review from Copilot October 24, 2025 12:10
@qodo-code-review
Copy link

qodo-code-review bot commented Oct 24, 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
🟢
🎫 #SD-2594
🟢 Remove pagination support from the Endorsement Chain API so it returns whatever is
available (no paging).
Remove the limit factor (no limit query parameter).
Remove any pagination cursor mechanism (no cursor query parameter and no
Next-Page-Cursor/Next-Cursor response header).
Ensure documentation clearly states that pagination is not supported.
🟢
🎫 #SD-2595
🟢 Rename carrier code from SMDG to SCAC across the API (query parameter, schema property,
examples, and documentation references).
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

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates the EBL Endorsement API v3.0.2 by removing pagination support and changing the carrier code terminology from SMDG to SCAC. The changes include removing pagination-related query parameters (cursor, limit) and response headers (Next-Page-Cursor), updating all references from SMDG to SCAC throughout the specification, and adding a new example demonstrating multiple endorsement chains for the same transport document reference.

  • Removed pagination functionality (cursor, limit parameters and Next-Page-Cursor header)
  • Changed carrier code terminology from SMDG to SCAC with updated provider references (SMDG → NMFTA)
  • Added example showing multiple endorsement chains for the same B/L

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@qodo-code-review
Copy link

qodo-code-review bot commented Oct 24, 2025

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Fix contradictory actions in example

Remove the contradictory SURRENDERED action from the v1 endorsement chain
example, as it already contains a SURRENDER_FOR_AMENDMENT action and the
description specifies it was surrendered for amendment.

ebl/v3/endorsement/EBL_END_v3.0.2.yaml [276-315]

 - transportDocumentReference: '62CD536BA8D34C469AFD'
   transportDocumentSubReference: 'v1'
   carrierSCACCode: 'YMLU'
   endorsementChain:
-    - actionDateTime: '2025-09-12T17:23:12Z'
-      actionCode: 'SURRENDERED'
-      actor:
-        partyName: 'Yang Ming Marine Transport Corporation'
-        eblPlatform: 'WAVE'
-        identifyingCodes:
-          - codeListProvider: 'WAVE'
-            partyCode: '4bd196da-0d8b-436d-bad4-4cc88f04a035'
     - actionDateTime: '2025-09-12T17:23:12Z'
       actionCode: 'SURRENDER_FOR_AMENDMENT'
       actor:
         partyName: 'Suzano Brazil'
         eblPlatform: 'WAVE'
         identifyingCodes:
           - codeListProvider: 'WAVE'
             partyCode: 'ee92b6b7-ac27-4537-87df-019c69389346'
       recipient:
         partyName: 'Yang Ming Marine Transport Corporation'
         eblPlatform: 'WAVE'
         identifyingCodes:
           - codeListProvider: 'WAVE'
             partyCode: '4bd196da-0d8b-436d-bad4-4cc88f04a035'
     - actionDateTime: '2025-09-09T12:55:31Z'
       actionCode: 'ISSUE'
       actor:
         partyName: 'Yang Ming Marine Transport Corporation'
         eblPlatform: 'WAVE'
         identifyingCodes:
           - codeListProvider: 'WAVE'
             partyCode: '4bd196da-0d8b-436d-bad4-4cc88f04a035'
       recipient:
         partyName: 'Suzano Brazil'
         eblPlatform: 'WAVE'
         identifyingCodes:
           - codeListProvider: 'WAVE'
             partyCode: 'ee92b6b7-ac27-4537-87df-019c69389346'
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies a logical contradiction in a newly added API example, where an endorsement chain has both SURRENDERED and SURRENDER_FOR_AMENDMENT actions, which is impossible. Fixing this improves the clarity and correctness of the API documentation.

Medium
  • Update

@HenrikHL HenrikHL merged commit 84dbd14 into master Oct 24, 2025
1 check passed
@HenrikHL HenrikHL deleted the SD-2594_SD-2595 branch October 24, 2025 12:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants