EBL 3.0: SD-520: Update Transport object description

[HenrikHL]

User description

SD-520: Update transport description

---

PR Type

Documentation

---

Description

• Update Transports object description in EBL API specifications

• Replace generic description with detailed explanation of consolidated transport information

---

Diagram Walkthrough

flowchart LR
  A["Old Description"] -- "Replace with" --> B["New Detailed Description"]
  B --> C["EBL v3.0.2"]
  B --> D["PINT v3.0.0"]

Loading

File Walkthrough

Relevant files

Documentation

EBL_v3.0.2.yaml Enhanced Transports object description                                      ebl/v3/EBL_v3.0.2.yaml Updated Transports object description from generic "All transport locations relevant to the Bill of Lading" to detailed explanation New description explains the object consolidates dates, origin/destination points, transport modes, and vessel details +1/-1      EBL_PINT_v3.0.0.yaml Enhanced Transports object description                                      pint/v3/EBL_PINT_v3.0.0.yaml Updated Transports object description identical to EBL specification Replaced generic description with comprehensive explanation of consolidated transport information +1/-1

---

[qodo-code-review]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ SD-520 - PR Code Verified Compliant requirements: Ensure all relevant OpenAPI objects and properties have clear, meaningful descriptions. Update missing or generic descriptions to be more detailed and informative. Apply updates consistently across related API specs (e.g., EBL and PINT). Requires further human verification: Confirm via Spectral rule run that there are no remaining objects/properties lacking descriptions across the entire specs, not just the 'Transports' object. Product/tech writer approval that the new wording accurately reflects domain intent and terminology.

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Wording Clarity Consider hyphenation/grammar: "pre- and on-carriage mode of transport and vessel details" could be ambiguous; verify intended meaning and whether plural "modes" is preferable. description: | This object consolidates information related to dates, origin and destination points, pre- and on-carriage mode of transport and vessel details. properties: Consistency Ensure the description matches domain terminology used elsewhere in the spec for pre/on-carriage and aligns with property names under this object. description: | This object consolidates information related to dates, origin and destination points, pre- and on-carriage mode of transport and vessel details. properties:

[qodo-code-review]

PR Code Suggestions ✨

No code suggestions found for the PR.