EBL 3.0: SD-2812: Add "Cancel SI" option #609
Conversation
PR Compliance Guide 🔍(Compliance updated until commit 742b54c)Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label Previous compliance checksCompliance check up to commit 61b731e
Compliance check up to commit 4f3beba
Compliance check up to commit 8de0151
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PR Code Suggestions ✨Latest suggestions up to 61b731e
Previous suggestions✅ Suggestions up to commit 4f3beba
✅ Suggestions up to commit 5a9adbe
✅ Suggestions up to commit 8de0151
|
|||||||||||||||||||||||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Pull request overview
Extends the Shipping Instructions cancel endpoint to support cancelling both an SI update and the full Shipping Instructions, while updating the schema and documentation (including typo fixes).
Changes:
- Expanded PATCH
/shipping-instructions/{documentReference}docs to cover UseCase 5 and UseCase 15, including new examples. - Refactored
CancelShippingInstructionsUpdateusingoneOfto supportUPDATE_CANCELLEDandCANCELLED. - Added
CANCELLED/DECLINEDstatus wording to Shipping Instructions status descriptions and adjusted docs/typos.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| ebl/v3/EBL_v3.0.3.yaml | Extends cancel endpoint semantics, updates request schema via oneOf, adds examples, and updates SI statuses/docs. |
| .stoplight/styleguide.json | Minor Stoplight styleguide configuration tweak. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 8 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 6 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 6 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
2 participants
User description
SD-2812: Add the option to CANCEL a Shipping Instructions
Also fix a typo in descriptions
PR Type
Enhancement
Description
Extend cancel endpoint to support full Shipping Instructions cancellation
Add
CANCELLEDandDECLINEDstatus values to Shipping InstructionsUpdate
CancelShippingInstructionsUpdateschema with oneOf patternClarify preconditions and postconditions for both cancel scenarios
Add example payloads for cancelling Shipping Instructions
Diagram Walkthrough
File Walkthrough
EBL_v3.0.3.yaml
Extend cancel endpoint for full Shipping Instructions supportebl/v3/EBL_v3.0.3.yaml
/shipping-instructions/{documentReference}endpoint tosupport cancelling both
Updated Shipping Instructionsand fullShipping Instructions15
each cancellation type
CancelShippingInstructionsUpdateschema usingoneOfpatternto support both
updatedShippingInstructionsStatus: UPDATE_CANCELLEDand
shippingInstructionsStatus: CANCELLEDCANCELLEDandDECLINEDstatus values toshippingInstructionsStatusenum in Shipping Instructions schemaInstructions
updatedShippingInstructionStatus→updatedShippingInstructionsStatus)styleguide.json
Styleguide configuration updates.stoplight/styleguide.json