Skip to content

EBL 3.0: SD-2934: Update What's New for SUR v3.0.3#615

Open
HenrikHL wants to merge 1 commit intomasterfrom
SD-2934_WhatsNewIssuance
Open

EBL 3.0: SD-2934: Update What's New for SUR v3.0.3#615
HenrikHL wants to merge 1 commit intomasterfrom
SD-2934_WhatsNewIssuance

Conversation

@HenrikHL
Copy link
Contributor

No description provided.

@qodo-code-review
Copy link

Review Summary by Qodo

Document Issuance v3.0.3 release notes and updates

📝 Documentation

Grey Divider

Walkthroughs

Description
• Add What's New section for Issuance v3.0.3 release
• Document new platform onboardings (DOCU, AEOT, SGTD)
• Update API changes including examples and property additions
• Fix relative path links in documentation
Diagram
flowchart LR
  A["README.md"] -- "Add v3.0.3 release notes" --> B["What's New section"]
  B -- "Platform updates" --> C["DOCU, AEOT, SGTD"]
  B -- "API changes" --> D["Examples, descriptions, properties"]
Loading

Grey Divider

File Changes

1. ebl/v3/surrender/README.md 📝 Documentation +13/-2

Add v3.0.3 release notes and platform updates

• Added new "Release v3.0.3 (TBD 2026)" section documenting patch version updates
• Listed three newly onboarded eBL Solution Providers (DOCU, AEOT, SGTD)
• Documented API improvements including added examples and updated descriptions
• Fixed relative path links from (./../) to (./..)
• Added optional feedbackElements property on Surrender Response

ebl/v3/surrender/README.md


Grey Divider

Qodo Logo

@qodo-code-review
Copy link

qodo-code-review bot commented Mar 19, 2026

Code Review by Qodo

🐞 Bugs (2) 📘 Rule violations (0) 📎 Requirement gaps (0) 📐 Spec deviations (0)

Grey Divider


Action required

1. Release date left TBD 🐞 Bug ⚙ Maintainability
Description
The new v3.0.3 changelog header is published with a placeholder date "(TBD 2026)", unlike other
release entries that use concrete dates, leaving the changelog ambiguous for readers and any
release-note consumers.
Code

ebl/v3/surrender/README.md[10]

+<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_SUR/3.0.3)
Evidence
The v3.0.3 entry introduces a placeholder date, while adjacent releases in the same changelog use
specific dates, indicating this is inconsistent with the established documentation pattern.

ebl/v3/surrender/README.md[10-23]
ebl/v3/surrender/README.md[22-23]

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 header uses a placeholder date &quot;(TBD 2026)&quot;, which makes the changelog non-final and inconsistent with other releases.

## Issue Context
Other releases in the same README use specific dates (e.g., v3.0.2).

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

## Suggested fix
Replace &quot;(TBD 2026)&quot; with the actual release date (or remove the date entirely until it is known, but keep formatting consistent with other entries).

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



Remediation recommended

2. Response module link removed 🐞 Bug ⚙ Maintainability
Description
The Surrender README no longer links to the existing v3 "surrender_response" documentation, making
cross-module navigation inconsistent with other v3 READMEs that still link to their (deprecated)
response modules.
Code

ebl/v3/surrender/README.md[R5-9]

Publications related to the Bill of Lading Surrender API:
- [Glossary of Terms](https://knowledge.dcsa.org/s/glossary) maintained on the [dcsa.org](https://dcsa.org) website
- [Bill of Lading](https://dcsa.org/standards/ebill-of-lading/) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications)
-- [Bill of Lading](./../) maintained here on GitHub
-- [Bill of Lading Surrender Response](./../surrender_response/) maintained here on GitHub (the Surrender Response API linked to this API)
+- [Bill of Lading](./..) maintained here on GitHub
+
Evidence
The repo still contains the surrender_response module and the v3 root README still links to it as a
deprecated module; the issuance README also continues to link to its response module, so removing
this link from the surrender README reduces discoverability and consistency.

ebl/v3/surrender/README.md[5-10]
ebl/v3/README.md[8-13]
ebl/v3/issuance/README.md[5-10]
ebl/v3/surrender_response/README.md[1-12]

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 Surrender module README no longer references the existing `ebl/v3/surrender_response/` docs, reducing navigation consistency with other modules.

## Issue Context
- `ebl/v3/surrender_response/README.md` still exists and describes the response API as discontinued but present.
- `ebl/v3/README.md` still links to `./surrender_response/` as deprecated.
- `ebl/v3/issuance/README.md` still links to `./../issuance_response/`.

## Fix Focus Areas
- ebl/v3/surrender/README.md[5-9]

## Suggested fix
Re-add a bullet link to `./../surrender_response/` in the publications list (optionally marking it as **DEPRECATED** to match the root README), or update the surrounding docs consistently across modules if the intent is to remove all such links.

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


Grey Divider

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

Grey Divider

Qodo Logo

@HenrikHL HenrikHL requested a review from Copilot March 19, 2026 14:00
@HenrikHL HenrikHL changed the title EBL 3.0: SD-2934: Update What's New for ISS v3.0.3 EBL 3.0: SD-2934: Update What's New for SUR v3.0.3 Mar 19, 2026
- [Bill of Lading Surrender Response](./../surrender_response/) maintained here on GitHub (the Surrender Response API linked to this API)
- [Bill of Lading](./..) maintained here on GitHub

<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_SUR/3.0.3)

Choose a reason for hiding this comment

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

Action required

1. Release date left tbd 🐞 Bug ⚙ Maintainability

The new v3.0.3 changelog header is published with a placeholder date "(TBD 2026)", unlike other
release entries that use concrete dates, leaving the changelog ambiguous for readers and any
release-note consumers.
Agent Prompt
## Issue description
The v3.0.3 release header uses a placeholder date "(TBD 2026)", which makes the changelog non-final and inconsistent with other releases.

## Issue Context
Other releases in the same README use specific dates (e.g., v3.0.2).

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

## Suggested fix
Replace "(TBD 2026)" with the actual release date (or remove the date entirely until it is known, but keep formatting consistent with other entries).

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

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the Bill of Lading Surrender (EBL_SUR) v3 documentation to include “What’s New” details for the upcoming v3.0.3 patch release.

Changes:

  • Adds a new Release v3.0.3 section with a summary of patch updates.
  • Adjusts the “Publications related to…” link list near the top of the README.

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

You can also share your feedback on Copilot code review. Take the survey.

- [Bill of Lading](https://dcsa.org/standards/ebill-of-lading/) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications)
- [Bill of Lading](./../) maintained here on GitHub
- [Bill of Lading Surrender Response](./../surrender_response/) maintained here on GitHub (the Surrender Response API linked to this API)
- [Bill of Lading](./..) maintained here on GitHub
- [Bill of Lading](https://dcsa.org/standards/ebill-of-lading/) maintained on the [dcsa.org](https://dcsa.org) website (contains documents and publications)
- [Bill of Lading](./../) maintained here on GitHub
- [Bill of Lading Surrender Response](./../surrender_response/) maintained here on GitHub (the Surrender Response API linked to this API)
- [Bill of Lading](./..) maintained here on GitHub
- [Bill of Lading Surrender Response](./../surrender_response/) maintained here on GitHub (the Surrender Response API linked to this API)
- [Bill of Lading](./..) maintained here on GitHub

<a name="v303"></a>[Release v3.0.3 (TBD 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL_SUR/3.0.3)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants