EBL 3.0: SD-2934: Update What's New for eBL v3.0.3

[HenrikHL]

No description provided.

[qodo-code-review]

Review Summary by Qodo

Document eBL v3.0.3 release notes with Direct Transport Document amendments

📝 Documentation

Walkthroughs

Description

• Add comprehensive What's New documentation for eBL v3.0.3
• Document Direct Transport Document amendment flow with 3 new endpoints
• List new shipping instructions cancellation and status states
• Detail party object restructuring and new address fields
• Document commodity code and packaging enhancements
• Update platform integrations and remove deprecated features

Diagram

flowchart LR
  A["eBL v3.0.3 Release"] --> B["Direct Transport Document<br/>Amendment Flow"]
  A --> C["Shipping Instructions<br/>Enhancements"]
  A --> D["Party Objects &<br/>Address Updates"]
  A --> E["Commodity & Packaging<br/>Improvements"]
  B --> B1["3 New Endpoints:<br/>GET/PUT/DELETE"]
  B --> B2["Amendment Status<br/>States Added"]
  C --> C1["Cancel Capability<br/>Added"]
  C --> C2["New Status Codes:<br/>CANCELLED/DECLINED"]
  D --> D1["Party Objects<br/>Split & Prefixed"]
  D --> D2["addressLines Field<br/>Added"]
  E --> E1["Extended HS/Commodity<br/>Codes Support"]
  E --> E2["Nested innerPackagings<br/>Support"]

Loading

File Changes

1. ebl/v3/README.md 📝 Documentation +58/-6

Add eBL v3.0.3 release notes and documentation updates

• Removed deprecated Bill of Lading Notification and Issuance Response references
• Fixed URL formatting by removing trailing slashes
• Added comprehensive v3.0.3 release notes section with 60+ lines of detailed changes
• Documented Direct Transport Document amendment endpoints and status states
• Listed party object restructuring with new Shipper-prefixed objects
• Detailed new fields for addresses, commodity codes, and packaging structures
• Updated platform integrations list with new eBL platform providers

ebl/v3/README.md

---

[qodo-code-review]

Code Review by Qodo

🐞 Bugs (1)   📘 Rule violations (0)   📎 Requirement gaps (0)   🎨 UX Issues (0)

🐞\ ≡ Correctness (1)

1. Schema casing mismatch 🐞 ≡

Description

The v3.0.3 release notes list new objects notifyPartyShipper and partyShipper, but the spec
schema names are NotifyPartyShipper and PartyShipper (and the README itself already uses
PartyShipper earlier). This inconsistency can cause implementers to look for the wrong schema
names.

Code

ebl/v3/README.md[R46-47]

+  - `notifyPartyShipper` object added
+  - `partyShipper` object added

Evidence

The README bullets use lower-cased names that do not match the actual schema identifiers in the
v3.0.3 spec, and the README also uses PartyShipper with correct casing elsewhere, demonstrating
internal inconsistency.

ebl/v3/README.md[40-47]
ebl/v3/EBL_v3.0.3.yaml[6854-6862]
ebl/v3/EBL_v3.0.3.yaml[7253-7262]

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 reference schema/object names with incorrect casing (`notifyPartyShipper`, `partyShipper`) that do not match the OpenAPI schema names (`NotifyPartyShipper`, `PartyShipper`). The README also uses `PartyShipper` earlier, making the notes internally inconsistent.

### Issue Context
Schema names are case-sensitive identifiers in the OpenAPI document and are what readers will search for when implementing.

### Fix Focus Areas
- ebl/v3/README.md[40-47]

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

---

2. Notification name typo ☑ 🐞 ≡

Description

The v3.0.3 release notes say “Transport Transport Document Notification”, but the spec defines the
notification schema as TransportDocumentNotification (“Transport Document Notification”). This
mismatch can mislead readers about where amendedTransportDocumentStatus is present and what to
search for in the spec.

Code

ebl/v3/README.md[22]

+  - added `amendedTransportDocumentStatus` to the Transport Transport Document Notification and to the amended Transport Document endpoint (the Transport Document object has **NOT** changed). Following states are possible:

Evidence

The README uses a duplicated/incorrect notification term, while the OpenAPI spec defines the actual
schema name and includes amendedTransportDocumentStatus on that notification object.

ebl/v3/README.md[22-22]
ebl/v3/EBL_v3.0.3.yaml[4016-4022]
ebl/v3/EBL_v3.0.3.yaml[4121-4129]

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 refer to a non-existent/typoed notification name (“Transport Transport Document Notification”), which conflicts with the actual schema name in the v3.0.3 OpenAPI spec.

### Issue Context
The spec defines `TransportDocumentNotification` (title: “Transport Document Notification”) and includes `amendedTransportDocumentStatus` on that schema.

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

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

---

3. Typos in release notes ☑ 🐞 ⚙

Description

The new v3.0.3 notes include multiple spelling/grammar issues (e.g., “Cancel a Shipping
Instructions”, “gramatical”, “descriptrions”, “giong”) that reduce clarity in a user-facing
changelog. These are directly in the newly added section and should be corrected for readability and
trust.

Code

ebl/v3/README.md[R37-42]

+  - many description updates (typos and gramatical errors fixed)
+  - `shippingInstructionsStatus` two new status codes added (see above)
+- `errorCode` description updated
+- `AddressHBL` object created to improve the description for House B/L party objects
+- `PartyShipper` object created to improve the description for parties provided by the Shipper (as part of the Shipping Instructions) vs parties provided by the carrier (as part of the Transport Document)
+- Party objects previously shared between SI and TD have now been split into two. Objects created for SI have been prefixed with `Shipper` (as they are provided by the shipper). There are no structural changes - only changes to the descriptrions. This goes for:

Evidence

The added release notes section contains several user-visible typos and grammar errors across
multiple lines.

ebl/v3/README.md[13-13]
ebl/v3/README.md[37-37]
ebl/v3/README.md[42-42]
ebl/v3/README.md[61-61]

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 introduce several typos/grammar issues that reduce readability and can undermine confidence in the accuracy of the change summary.

### Issue Context
These are user-facing release notes; correcting them improves comprehension and professionalism.

### Fix Focus Areas
- ebl/v3/README.md[13-13]
- ebl/v3/README.md[37-37]
- ebl/v3/README.md[42-42]
- ebl/v3/README.md[61-61]

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

---

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

[Copilot]

Pull request overview

Updates the eBL v3 README “What’s New” content to document the upcoming v3.0.3 patch release changes, primarily focused on Direct Transport Document amendment flow and related schema/description updates.

Changes:

• Refreshes the publications list and removes deprecated sub-doc links.
• Adds a new “Release v3.0.3” section describing new amendment endpoints and schema/status updates.
• Expands release notes with additional object/status/code-list changes for v3.0.3.

---

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

[HenrikHL]

Update publication date