Skip to content

EBL 3.0: SD-2502: Add shippingInstructionsRevisionNumber to SI #578

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
Nov 25, 2025
Merged

EBL 3.0: SD-2502: Add shippingInstructionsRevisionNumber to SI #578

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.

15 changes: 15 additions & 0 deletions ebl/v3/EBL_v3.0.3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3055,6 +3055,11 @@ components:
The `Shipping Instructions` is an enrichment to the original booking shared by the Shipper to the Carrier. The information given by the Shipper through the `Shipping Instructions` is the information required to create a `Draft Transport Document`.
title: Create Shipping Instructions
properties:
shippingInstructionsRevisionNumber:
type: integer
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

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

The shippingInstructionsRevisionNumber field lacks constraints. Consider adding minimum: 1 to ensure the revision number is always positive, as the description indicates it increments starting from 1.

Suggested change
type: integer
type: integer
minimum: 1

Copilot uses AI. Check for mistakes.
description: |
The version number of the **Shipping Instructions** provided by the customer to ensure the carrier uses the most recent update when creating the **Transport Document**. This value is expected to increment by one with each **Shipping Instructions** update, with higher values representing newer versions.
Comment on lines +3058 to +3061
Copy link

Copilot AI Nov 25, 2025

Choose a reason for hiding this comment

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

The field is not marked as required in the CreateShippingInstructionsRequest schema. If version tracking is essential for ensuring carriers use the correct version, consider whether this field should be required, or document the behavior when it's omitted.

Copilot uses AI. Check for mistakes.
example: 1
transportDocumentReference:
type: string
pattern: ^\S(?:.*\S)?$
Expand Down Expand Up @@ -3371,6 +3376,11 @@ components:
description: |
The identifier for a `Shipping Instructions` provided by the carrier for system purposes.
example: e0559d83-00e2-438e-afd9-fdd610c1a008
shippingInstructionsRevisionNumber:
type: integer
description: |
The version number of the **Shipping Instructions** provided by the customer to ensure the carrier uses the most recent update when creating the **Transport Document**. This value is expected to increment by one with each **Shipping Instructions** update, with higher values representing newer versions.
example: 1
transportDocumentReference:
type: string
pattern: ^\S(?:.*\S)?$
Expand Down Expand Up @@ -3688,6 +3698,11 @@ components:
description: |
The identifier for a `Shipping Instructions` provided by the carrier for system purposes.
example: e0559d83-00e2-438e-afd9-fdd610c1a008
shippingInstructionsRevisionNumber:
type: integer
description: |
The version number of the **Shipping Instructions** provided by the customer to ensure the carrier uses the most recent update when creating the **Transport Document**. This value is expected to increment by one with each **Shipping Instructions** update, with higher values representing newer versions.
example: 1
transportDocumentReference:
type: string
pattern: ^\S(?:.*\S)?$
Expand Down