BKG 2.0, EBL 3.0: SD-2395,SD-2396: Deprecate ESSD

[HenrikHL]

User description

SD-2395: Deprecate ESSD in EBL
SD-2396: Deprecate ESSD in Booking

---

PR Type

Documentation

---

Description

• Deprecate ESSD code across all API specifications

• Add deprecation notice directing users to IDT

• Update documentation in BKG and EBL APIs

---

Diagram Walkthrough

flowchart LR
  ESSD["ESSD (EssDOCS)"] -- "deprecated" --> IDT["IDT (ICE Digital Trade)"]
  BKG["BKG API"] --> ESSD
  EBL["EBL API"] --> ESSD
  PINT["PINT API"] --> ESSD

Loading

File Walkthrough

Relevant files

Documentation

BKG_v2.0.3.yaml Deprecate ESSD in BKG API                                                                bkg/v2/BKG_v2.0.3.yaml Add deprecation notice to ESSD code in codeListProvider description Direct users to use IDT instead of deprecated ESSD +1/-1      EBL_v3.0.2.yaml Deprecate ESSD in EBL API                                                                ebl/v3/EBL_v3.0.2.yaml Add deprecation notice to ESSD in eblPlatform field Add deprecation notice to ESSD in codeListProvider field Direct users to use IDT instead +2/-2      EBL_ISS_v3.0.2.yaml Deprecate ESSD in EBL issuance API                                              ebl/v3/issuance/EBL_ISS_v3.0.2.yaml Add deprecation notice to ESSD in eblPlatform field Add deprecation notice to ESSD in codeListProvider field Direct users to use IDT instead +2/-2      EBL_SUR_v3.0.2.yaml Deprecate ESSD in EBL surrender API                                            ebl/v3/surrender/EBL_SUR_v3.0.2.yaml Add deprecation notice to ESSD in eblPlatform field Add deprecation notice to ESSD in codeListProvider field Direct users to use IDT instead +2/-2      EBL_PINT_v3.0.0.yaml Deprecate ESSD in PINT API                                                              pint/v3/EBL_PINT_v3.0.0.yaml Add deprecation notice to ESSD in multiple eblPlatform fields Add deprecation notice to ESSD in codeListProvider field Direct users to use IDT instead +3/-3

---

[qodo-code-review]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅ SD-2395 - PR Code Verified Compliant requirements: Mark ESSD as deprecated wherever it appears in accepted values. Update the description to: "EssDOCS - This value has been deprecated. Please use IDT". Ensure users are directed to use IDT instead of ESSD. Do not remove the ESSD code in EBL 3.0.2; maintain backward compatibility. Requires further human verification: Confirm there are no additional ESSD mentions in EBL 3.0.2 documentation outside the changed YAML that also need deprecation notes (README, changelog, examples). SD-2396 - PR Code Verified Compliant requirements: Mark ESSD as deprecated wherever it appears in accepted values. Update the description to: "EssDOCS - This value has been deprecated. Please use IDT". Ensure users are directed to use IDT instead of ESSD. Do not remove the ESSD code in BKG 2.0.3; maintain backward compatibility. Requires further human verification: Confirm there are no additional ESSD mentions in BKG 2.0.3 documentation outside the changed YAML that also need deprecation notes (README, changelog, examples).

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Consistency Ensure the deprecation phrasing is consistent across all occurrences and files, including punctuation and bolding of "deprecated". The eBL platform of the transaction party. The value **MUST** be one of: - `WAVE` (Wave) - `CARX` (CargoX) - `ESSD` (EssDOCS - This value has been **deprecated**. Please use `IDT`) - `IDT` (ICE Digital Trade) - `BOLE` (Bolero) - `EDOX` (EdoxOnline) - `IQAX` (IQAX) Formatting Verify that Markdown formatting (bold in "deprecated") renders correctly in generated documentation from YAML descriptions. description: | A list of codes identifying a party. Possible values are: - `WAVE` (Wave) - `CARX` (CargoX) - `ESSD` (EssDOCS - This value has been **deprecated**. Please use `IDT`) - `IDT` (ICE Digital Trade) - `BOLE` (Bolero) - `EDOX` (EdoxOnline) - `IQAX` (IQAX) Scope Alignment PINT file updated though not in tickets; validate this change is intended for this PR scope and versioning policy. The eBL platform of the transaction party. The value **MUST** be one of: - `WAVE` (Wave) - `CARX` (CargoX) - `ESSD` (EssDOCS - This value has been **deprecated**. Please use `IDT`) - `IDT` (ICE Digital Trade) - `BOLE` (Bolero) - `EDOX` (EdoxOnline) - `IQAX` (IQAX)

[qodo-code-review]

PR Code Suggestions ✨

No code suggestions found for the PR.