Skip to content

EBL 3.0: SD-3041: Move displayedToOrderText next to isToOrder #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HenrikHL merged 1 commit into from
Aug 24, 2026
Merged

EBL 3.0: SD-3041: Move displayedToOrderText next to isToOrder #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stoplight/styleguide.json
View file
Open in desktop

Large diffs are not rendered by default.

128 changes: 64 additions & 64 deletions ebl/v3/EBL_v3.0.4.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4266,6 +4266,22 @@ components:

`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).
example: false
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.
Comment on lines +4269 to +4272

@qodo-code-review qodo-code-review Bot Aug 24, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Action required

1. displayedtoordertext not gated by istoorder 📎 Requirement gap ≡ Correctness

The schema defines displayedToOrderText as a regular optional root property, so payloads can
include it even when isToOrder=false because no schema-level restriction ties the two fields. This
violates the requirement that displayedToOrderText is only permitted when isToOrder=true.
Agent Prompt 
## Issue description
`displayedToOrderText` is documented as only applicable when `isToOrder=TRUE`, but the OpenAPI schemas currently allow it to be provided regardless of the value of `isToOrder`.

## Issue Context
PR Compliance ID 3 requires that `Displayed To Order Text` is only permitted/processed when `isToOrder` is true, so the schema should enforce that `displayedToOrderText` cannot appear unless `isToOrder=true`.

## Fix Focus Areas
- ebl/v3/EBL_v3.0.4.yaml[4262-4284]
- ebl/v3/issuance/EBL_ISS_v3.0.4.yaml[807-829]
- pint/v3/EBL_PINT_v3.0.0.yaml[1466-1488]

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


If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
numberOfCopiesWithCharges:
type: integer
format: int32
Expand Down Expand Up @@ -4401,22 +4417,6 @@ components:
example: false
documentParties:
$ref: '#/components/schemas/DocumentPartiesShippingInstructions'
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
isCargoDeliveredInICS2Zone:
type: boolean
description: |
Expand Down Expand Up @@ -4603,6 +4603,22 @@ components:

`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).
example: false
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
numberOfCopiesWithCharges:
type: integer
format: int32
Expand Down Expand Up @@ -4738,22 +4754,6 @@ components:
example: false
documentParties:
$ref: '#/components/schemas/DocumentPartiesShippingInstructions'
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
isCargoDeliveredInICS2Zone:
type: boolean
description: |
Expand Down Expand Up @@ -4964,6 +4964,22 @@ components:

`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).
example: false
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
numberOfCopiesWithCharges:
type: integer
format: int32
Expand Down Expand Up @@ -5099,22 +5115,6 @@ components:
example: false
documentParties:
$ref: '#/components/schemas/DocumentPartiesShippingInstructions'
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
isCargoDeliveredInICS2Zone:
type: boolean
description: |
Expand Down Expand Up @@ -10071,6 +10071,22 @@ components:

`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).
example: false
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
numberOfCopiesWithCharges:
type: integer
format: int32
Expand Down Expand Up @@ -10363,22 +10379,6 @@ components:
$ref: '#/components/schemas/PartyContactDetail'
documentParties:
$ref: '#/components/schemas/DocumentParties'
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
consignmentItems:
type: array
minItems: 1
Expand Down
32 changes: 16 additions & 16 deletions ebl/v3/issuance/EBL_ISS_v3.0.4.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -811,6 +811,22 @@ components:

`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).
example: false
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
numberOfCopiesWithCharges:
type: integer
format: int32
Expand Down Expand Up @@ -1104,22 +1120,6 @@ components:
$ref: '#/components/schemas/PartyContactDetail'
documentParties:
$ref: '#/components/schemas/DocumentParties'
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
consignmentItems:
type: array
minItems: 1
Expand Down
32 changes: 16 additions & 16 deletions pint/v3/EBL_PINT_v3.0.0.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1470,6 +1470,22 @@ components:

`isToOrder` must be `false` if `transportDocumentTypeCode='SWB'` (Sea Waybill).
example: false
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
numberOfCopiesWithCharges:
type: integer
format: int32
Expand Down Expand Up @@ -1763,22 +1779,6 @@ components:
$ref: '#/components/schemas/PartyContactDetail'
documentParties:
$ref: '#/components/schemas/DocumentParties'
displayedToOrderText:
type: array
description: |
Text to be displayed in the Transport Document visualisation of a negotiable BL to represent the endorsee, typically shown in the consignee field in the traditional BL layout. This attribute can be used instead of providing endorsee party details when no specific information (e.g. address, contact details) should be displayed.

If endorsee details are also provided as a document party, this text takes precedence in the visual representation of the Transport Document. **👉 Please note** that if using this property and communicating with a lower version (e.g. 3.0.3 or lower) this property will be ignored and the endorsee details will be used (if provided).

**Condition:** Only applicable when `isToOrder=TRUE`.

**Condition:** The order of the items in this array **MUST** be preserved as by the provider of the API.
maxItems: 6
items:
type: string
maxLength: 35
description: A line in the displayed text for the visualisation of the Endrosee.
example: TO ORDER OF SHIPPER
consignmentItems:
type: array
minItems: 1
Expand Down
Loading