Skip to content

EBL 3.0: SD-2934: Update What's New for ISS v3.0.3#616

Open
HenrikHL wants to merge 1 commit intomasterfrom
SD-2934_Issuance-whats-new
Open

EBL 3.0: SD-2934: Update What's New for ISS v3.0.3#616
HenrikHL wants to merge 1 commit intomasterfrom
SD-2934_Issuance-whats-new

Conversation

@HenrikHL
Copy link
Contributor

No description provided.

@qodo-code-review
Copy link

Review Summary by Qodo

Document Issuance API v3.0.3 release notes and changes

📝 Documentation

Grey Divider

Walkthroughs

Description
• Added comprehensive What's New section for Issuance v3.0.3
• Documents patch updates including new examples and error code improvements
• Lists platform onboarding updates (DOCU, AEOT, SGTD)
• Details Transport Document schema changes and deprecations
• Includes nested innerPackagings, extended code support, and new address fields
Diagram
flowchart LR
  A["README.md"] -->|Add Release Notes| B["v3.0.3 Section"]
  B -->|Documents| C["Examples & Error Codes"]
  B -->|Documents| D["Platform Updates"]
  B -->|Documents| E["Transport Document Changes"]
  E -->|Includes| F["Deprecations & Extensions"]
  E -->|Includes| G["New Fields & Nesting"]
Loading

Grey Divider

File Changes

1. ebl/v3/issuance/README.md 📝 Documentation +24/-2

Add v3.0.3 release notes with schema updates

• Fixed relative link path from (./../) to (./..)
• Added new Release v3.0.3 section with comprehensive patch notes
• Documented examples, error code updates, and TODO comment removal
• Listed three newly onboarded eBL platforms (DOCU, AEOT, SGTD)
• Detailed Transport Document schema changes including deprecations (HSCodes,
 nationalCommodityCodes, chargeName), extensions (extendedHSCodes, extendedNationalCommodityCodes,
 extendedChargeName), and new features (nested innerPackagings, vessel role, addressLines,
 facilityName, eblPlatform)

ebl/v3/issuance/README.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link

qodo-code-review bot commented Mar 19, 2026

Code Review by Qodo

🐞 Bugs (3) 📘 Rule violations (0) 📎 Requirement gaps (0) 📐 Spec deviations (0)

Grey Divider


Action required

1. Placeholder release date 🐞 Bug ⚙ Maintainability
Description
The new v3.0.3 release entry uses a placeholder date "TBD 2026", unlike other releases which have a
concrete date. If merged, this leaves the changelog in an incomplete/outdated state.
Code

ebl/v3/issuance/README.md[10]

+<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_ISS/3.0.3)
Evidence
The v3.0.3 entry explicitly contains "(TBD 2026)", while the immediately following v3.0.2 entry and
earlier entries use specific release dates (e.g., "14 November 2025").

ebl/v3/issuance/README.md[10-11]
ebl/v3/issuance/README.md[33-34]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The v3.0.3 release note header contains a placeholder date (&quot;TBD 2026&quot;), which will ship as incomplete documentation.

### Issue Context
Other releases in the same file use a concrete date format, e.g. &quot;(14 November 2025)&quot;.

### Fix Focus Areas
- ebl/v3/issuance/README.md[10-10]

### Suggested change
Replace the placeholder with the actual v3.0.3 release date using the same style as other entries (or remove the date entirely until it is known, but avoid leaving &quot;TBD&quot; in `master`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools



Remediation recommended

2. Missing response API link 🐞 Bug ⚙ Maintainability
Description
The Issuance README publications list no longer links to the existing issuance_response module,
reducing discoverability and breaking consistency with other module READMEs. The issuance_response
docs still exist and link back to Issuance, so this creates one-way navigation.
Code

ebl/v3/issuance/README.md[R5-9]

Publications related to the Bill of Lading Issuance API:
- [Glossary of Terms](https://knowledge.dcsa.org/s/glossary) maintained on the [dcsa.org](https://dcsa.org) website
- [Bill of Lading](https://dcsa.org/standards/ebill-of-lading/) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications)
-- [Bill of Lading](./../) maintained here on GitHub
-- [Bill of Lading Issuance Response](./../issuance_response/) maintained here on GitHub (the Issuance Response API linked to this API)
+- [Bill of Lading](./..) maintained here on GitHub
+
Evidence
In the updated Issuance README, the publications list includes only the Bill of Lading link and no
longer includes a link to issuance_response. Other modules (e.g., Surrender) still provide a
Response API link in the same section, and issuance_response/README.md links back to Issuance,
indicating cross-linking is an established pattern in this repo.

ebl/v3/issuance/README.md[5-12]
ebl/v3/surrender/README.md[5-10]
ebl/v3/issuance_response/README.md[7-12]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The publications list in `ebl/v3/issuance/README.md` dropped the link to the existing `issuance_response` module, which makes it harder to find the response API documentation and is inconsistent with how other modules link to their response counterparts.

### Issue Context
- `ebl/v3/issuance_response/` exists and contains its own `README.md`.
- Other module READMEs (e.g. `surrender/README.md`) include a response-module link in their publications section.

### Fix Focus Areas
- ebl/v3/issuance/README.md[5-9]

### Suggested change
Re-add a bullet similar to the previous pattern, e.g.:
- `[Bill of Lading Issuance Response](./../issuance_response/) maintained here on GitHub (the Issuance Response API linked to this API)`

(Optionally also align `./..` to `./../` to match other READMEs.)

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


3. Typos in v3.0.3 notes 🐞 Bug ⚙ Maintainability
Description
The new v3.0.3 changelog text introduces typos (e.g., "gramatical" and "giong"), reducing clarity
and professionalism. This is especially noticeable because the same bullet claims typos/grammatical
errors were corrected.
Code

ebl/v3/issuance/README.md[R21-28]

+  - corrected many descriptions for typos and gramatical errors (`numberOfOriginalsWithCharges`, `numberOfOriginalsWithoutCharges`, Reference and ReferenceConsignmentItem `type`, `OuterPackaging`, `packageCode`, `numberOfPackages`, OuterPackaging `description`, `innerPackagings`, `NetExplosiveContent`, NetExplosiveContent `description`, `InnerPackaging`, `UtilizedTransportEquipment`, `VesselVoyage`, `street`, `streetNumber`, `floor`, `postCode`, `city` and `stateRegion`)
+  - `HSCodes` marked as deprecated everywhere, `extendedHSCodes` to be used instead
+  - `extendedHSCodes` added in order to support 12 character codes
+  - `nationalCommodityCodes` marked as deprecated everywhere, `extendedNationalCommodityCodes` to be used instead
+  - `extendedNationalCommodityCodes` added in order to support 16 character codes
+  - `innerPackagings` can now have a nested `innerPackagings` to allow multiple innerPackaging-layers
+  - `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea giong vessel) or `MOTHER` (Mother vessel)
+  - an unstructured address object called `addressLines` added to: `PlaceOfReceipt`, `PlaceOfDelivery` and `OnwardInlandRouting`. Also added to the following party objects: `Shipper`, `OnBehalfOfShipper`, `Consignee`, `OnBehalfOfConsignee`, `Endorsee`, `CarriersAgentAtDestination`, `NotifyParty`, general `Party` and `IssuingParty`
Evidence
The v3.0.3 section contains misspellings in the narrative text: "gramatical" and "giong" are present
in the newly added bullets.

ebl/v3/issuance/README.md[20-28]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

### Issue description
The v3.0.3 release notes contain typos that should be corrected before merging.

### Issue Context
Examples in the current text:
- &quot;gramatical&quot; should be &quot;grammatical&quot;
- &quot;giong&quot; should be &quot;going&quot;

### Fix Focus Areas
- ebl/v3/issuance/README.md[21-28]

### Suggested change
Correct the misspellings (and any other nearby typos) in the v3.0.3 bullets so the changelog reads cleanly and consistently.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

ⓘ The new review experience is currently in Beta. Learn more

Grey Divider

Qodo Logo

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

Updates the “What’s New” section for the EBL v3 Issuance module to document the upcoming v3.0.3 patch release.

Changes:

  • Adds release notes section for Issuance API v3.0.3.
  • Updates publications links list in the Issuance README.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

- `AEOT` (AEOTrade)
- `SGTD` (SGTraDex)
- **Transport Document** changes:
- corrected many descriptions for typos and gramatical errors (`numberOfOriginalsWithCharges`, `numberOfOriginalsWithoutCharges`, Reference and ReferenceConsignmentItem `type`, `OuterPackaging`, `packageCode`, `numberOfPackages`, OuterPackaging `description`, `innerPackagings`, `NetExplosiveContent`, NetExplosiveContent `description`, `InnerPackaging`, `UtilizedTransportEquipment`, `VesselVoyage`, `street`, `streetNumber`, `floor`, `postCode`, `city` and `stateRegion`)
- `nationalCommodityCodes` marked as deprecated everywhere, `extendedNationalCommodityCodes` to be used instead
- `extendedNationalCommodityCodes` added in order to support 16 character codes
- `innerPackagings` can now have a nested `innerPackagings` to allow multiple innerPackaging-layers
- `role` added to `VesselVoyage` in order to specify the vessel as being: `FIRST_SEA_GOING` (First sea giong vessel) or `MOTHER` (Mother vessel)
- [Bill of Lading](https://dcsa.org/standards/ebill-of-lading/) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications)
- [Bill of Lading](./../) maintained here on GitHub
- [Bill of Lading Issuance Response](./../issuance_response/) maintained here on GitHub (the Issuance Response API linked to this API)
- [Bill of Lading](./..) maintained here on GitHub

<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_ISS/3.0.3)
---
This is a patch version for the DCSA Issuance API. eBL Solution Providers updated:
- [Bill of Lading Issuance Response](./../issuance_response/) maintained here on GitHub (the Issuance Response API linked to this API)
- [Bill of Lading](./..) maintained here on GitHub

<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_ISS/3.0.3)

Choose a reason for hiding this comment

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

Action required

1. Placeholder release date 🐞 Bug ⚙ Maintainability

The new v3.0.3 release entry uses a placeholder date "TBD 2026", unlike other releases which have a
concrete date. If merged, this leaves the changelog in an incomplete/outdated state.
Agent Prompt
### Issue description
The v3.0.3 release note header contains a placeholder date ("TBD 2026"), which will ship as incomplete documentation.

### Issue Context
Other releases in the same file use a concrete date format, e.g. "(14 November 2025)".

### Fix Focus Areas
- ebl/v3/issuance/README.md[10-10]

### Suggested change
Replace the placeholder with the actual v3.0.3 release date using the same style as other entries (or remove the date entirely until it is known, but avoid leaving "TBD" in `master`).

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

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.

2 participants