BKG 2.0: SD-2267: Fix GET, PUT and PATCH description

[HenrikHL]

User description

Fixing a breaking backward compatible bug in the GET, PUT and PATCH endPoint. The semantics of the endPoint has been changed to allow the use of the CBRR (carrierBookingRequestRefreence) throughout the lifecyckle of the Booking - also after it has been Confirmed.
This change is needed as the Standard would be useless in case a Shipper does not support PUSH messages (as there is no way for a Shipper to receive the CBR (carrierBookingReference)

---

PR Type

Bug fix

---

Description

• Fixed API endpoint descriptions for GET, PUT, PATCH operations

• Removed restriction requiring carrierBookingReference after booking confirmation

• Updated README to document the semantic changes

• Enabled use of carrierBookingRequestReference throughout booking lifecycle

---

Changes walkthrough 📝

	Relevant files
Bug fix	BKG_v2.0.2.yaml Remove booking reference restrictions from endpoint descriptions bkg/v2/BKG_v2.0.2.yaml Removed restriction in PUT endpoint description requiring carrierBookingReference after confirmation Updated GET endpoint description to allow carrierBookingRequestReference usage throughout lifecycle Modified PATCH endpoint description to remove confirmation-based reference restrictions +3/-3
Documentation	README.md Document endpoint description bug fix in release notes      bkg/v2/README.md Added explanation of the bug fix in endpoint descriptions Updated release notes to document semantic changes Clarified the need for CBRR usage when shippers don't support PUSH notifications Updated commit link date range +4/-3

---

Need help?

Type /help how to ... in the comments thread for any questions about Qodo Merge usage.

Check out the documentation for more information.

[qodo-code-review]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

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

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Breaking Change The semantic change allowing carrierBookingRequestReference usage after booking confirmation is described as backward compatible but actually changes API behavior. This could impact existing integrations that rely on the previous restriction. Updates the `Booking Request` with the `bookingReference`. The path can contain one of `carrierBookingRequestReference` or `carrierBookingReference`. This endPoint corresponds with one of - **UseCase 3 - Submit updated Booking request** Typo There is a spelling error in the changelog description where "chaning" should be "changing". This is a patch release for the DCSA Booking API. A bug in the `GET`, `PUT` and `PATCH` description has been fixed (chaning the semantics of the endPoints) and a lot of minor changes have been added to this patch, here is a list of changes

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Fix typo in documentation Fix the typo "chaning" which should be "changing". This improves the professional appearance of the documentation. bkg/v2/README.md [12] -This is a patch release for the DCSA Booking API. A bug in the `GET`, `PUT` and `PATCH` description has been fixed (chaning the semantics of the endPoints) and a lot of minor changes have been added to this patch, here is a list of changes +This is a patch release for the DCSA Booking API. A bug in the `GET`, `PUT` and `PATCH` description has been fixed (changing the semantics of the endPoints) and a lot of minor changes have been added to this patch, here is a list of changes Apply / Chat Suggestion importance[1-10]: 2 __ Why: The suggestion correctly identifies and fixes the typo 'chaning' to 'changing' in the README.md file. This is a minor but valid improvement for documentation clarity and professionalism.	Low
More