BKG 2.0, EBL 3.0: SD-2703: Add addressLines and align conditions#605
BKG 2.0, EBL 3.0: SD-2703: Add addressLines and align conditions#605
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds support for unstructured address lines (addressLines) alongside the existing structured address object across multiple API schemas (EBL PINT, EBL Issuance, EBL, OVS, and BKG). The change provides a fallback mechanism for specifying addresses when structured address fields are unavailable, with version-specific conditions to ensure backward compatibility.
Changes:
- Added
addressLinesarray property to location and party schemas across all affected API versions - Updated location and party descriptions to clarify that addresses can be specified in either structured (
address) or unstructured (addressLines) format - Added backward compatibility conditions for API consumers/providers on versions 3.0.2/2.0.3 and earlier
- Fixed minor formatting issues in existing descriptions (apostrophes, spacing)
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pint/v3/EBL_PINT_v3.0.0.yaml | Adds addressLines to PlaceOfReceipt, PlaceOfDelivery, OnwardInlandRouting, and various party schemas (Shipper, DocumentParty, Consignee, Endorsee, NotifyParty); updates condition statements and fixes formatting |
| ovs/v3/OVS_v3.0.2.yaml | Fixes formatting in address field descriptions |
| ebl/v3/issuance/EBL_ISS_v3.0.3.yaml | Adds addressLines to location schemas (PlaceOfReceipt, PlaceOfDelivery, OnwardInlandRouting) and party schemas (Shipper, DocumentParty, Consignee, Endorsee, NotifyParty); fixes formatting and adds blank lines |
| ebl/v3/EBL_v3.0.3.yaml | Adds addressLines to party schemas (Shipper variants, DocumentParty variants, Consignee variants, Endorsee variants, NotifyParty variants, CarriersAgentAtOrigin, CarriersAgentAtDestination, ShippingInstructionsRequestor, BookingParty); updates titles, condition statements, and fixes formatting |
| bkg/v2/BKG_v2.0.4.yaml | Adds addressLines to party schemas (BookingParty, Shipper, Consignee, NotifyParty, CarriersAgentAtOrigin, DocumentParty) and location schemas (Location, EmptyContainerPickupLocation, EmptyContainerDropOffLocation, LoadLocation, DischargeLocation); updates condition statements and fixes formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
PR Compliance Guide 🔍(Compliance updated until commit 1eebae1)Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label Previous compliance checksCompliance check up to commit 73b117c
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PR Code Suggestions ✨Explore these optional code suggestions:
|
||||||||||||||||
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 9 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
User description
SD-2703: Add
addressLinesnext toaddressobjectImprove encoding
Align conditions
Added:
SD-2848: Remove SI conditions from TD party objects
PR Type
Enhancement
Description
Add
addressLinesproperty to multiple party and location schemasAlign and clarify conditional requirements across schemas
displayedAddressreferences to includeaddressLinesImprove documentation clarity and consistency
Diagram Walkthrough
File Walkthrough
EBL_v3.0.3.yaml
Add addressLines and align version-specific conditionsebl/v3/EBL_v3.0.3.yaml
addressLinesarray property (max 5 items, 250 chars each) to 11party schemas (Shipper, ShippingAgent, Consignee, ConsigneeAgent,
Endorsee, EndorseeAgent, NotifyParty, Company,
ShippingInstructionsRequestor) and 3 location schemas (PlaceOfReceipt,
PlaceOfDelivery, OnwardInlandRouting)
earlier) and v3.0.3 (or later) requirements
displayedAddressreplaces bothaddressandaddressLinesin Transport Document
destination")
EBL_ISS_v3.0.3.yaml
Add addressLines and align version conditionsebl/v3/issuance/EBL_ISS_v3.0.3.yaml
addressLinesarray property to 8 party schemas and 3 locationschemas with consistent structure and constraints
v3.0.3 (or later) requirements
unstructured address options
EBL_PINT_v3.0.0.yaml
Add addressLines and clarify address specificationspint/v3/EBL_PINT_v3.0.0.yaml
addressLinesarray property to 8 party schemas and 3 locationschemas
unstructured address options
later)
BKG_v2.0.4.yaml
Add addressLines to BKG v2.0.4 schemasbkg/v2/BKG_v2.0.4.yaml
addressLinesarray property to 6 party schemas and 5 locationschemas
unstructured address options
addressLines usage
PreCarriagePickUpLocation, EmptyDepotReleaseLocation, LoadLocation,
and DischargeLocation
OVS_v3.0.2.yaml
Fix quote formatting in address descriptionsovs/v3/OVS_v3.0.2.yaml
properties (street, streetNumber, floor, postCode, city, stateRegion,
country)
styleguide.json
Styleguide configuration updates.stoplight/styleguide.json
analysis)