SD-2837-updated iss and surr prompts

[palatsangeetha]

PR Type

Documentation

---

Description

• Enhanced issuance prompt with detailed workflow steps and API endpoints

• Clarified surrender response process with explicit POST request details

• Improved formatting with bold text and structured sections

• Added missing newline at end of platform PSP file

---

Diagram Walkthrough

flowchart LR
  A["Issuance/Surrender<br/>Prompts"] -->|Enhanced with| B["API Endpoint<br/>Details"]
  A -->|Improved| C["Structured<br/>Formatting"]
  A -->|Clarified| D["Response<br/>Workflows"]
  B --> E["POST/PUT<br/>Requests"]
  D --> F["Step-by-step<br/>Instructions"]

Loading

File Walkthrough

Relevant files

Documentation

prompt-iss-reqres-ebltype.md Restructured issuance prompt with workflow details              ebl-issuance/src/main/resources/standards/eblissuance/instructions/prompt-iss-reqres-ebltype.md Restructured prompt with "What Happens" and "Next Steps" sections Added detailed workflow steps showing PUT request to /ebl-issuance-requests and automatic POST response Enhanced formatting with bold text for key variables and action buttons Clarified conformance validation and response processing steps +13/-5    prompt-platform-psp.md Clarified platform response endpoint details                          ebl-issuance/src/main/resources/standards/eblissuance/instructions/prompt-platform-psp.md Clarified that asynchronous response is sent via POST request to /ebl-issuance-responses Added missing newline at end of file for proper formatting +2/-2      prompt-surrender-reqres.md Added surrender response endpoint specification                    ebl-surrender/src/main/resources/standards/eblsurrender/instructions/prompt-surrender-reqres.md Specified that synthetic carrier response is made via POST request to /ebl-surrender-responses Enhanced clarity on the automatic response mechanism +2/-1      prompt-surrender-ssp.md Specified surrender response endpoint requirement                ebl-surrender/src/main/resources/standards/eblsurrender/instructions/prompt-surrender-ssp.md Clarified that system response should be sent via POST request to /ebl-surrender-responses Added missing newline at end of file for proper formatting +3/-2

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
🟢	No security concerns identified No security vulnerabilities detected by AI analysis. Human verification advised for critical code.
Ticket Compliance
🟡	🎫 #SD-2837 🟢 Update/Correct the issuance conformance prompt text so it accurately describes the request/response workflow and participant actions. Update/Correct the surrender conformance prompt text so it accurately describes the request/response workflow and participant actions. Ensure the prompts reference the correct API endpoints and HTTP methods used in the conformance flows. Improve prompt clarity/formatting to reduce ambiguity for users following the conformance steps. ⚪ Confirm the documented endpoints/methods and described “automatic/asynchronous” behavior precisely match the actual conformance platform behavior in runtime (end-to-end scenario execution).
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
🟢	Generic: Comprehensive Audit Trails Objective: To create a detailed and reliable record of critical system actions for security analysis and compliance. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Meaningful Naming and Self-Documenting Code Objective: Ensure all identifiers clearly express their purpose and intent, making code self-documenting Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Robust Error Handling and Edge Case Management Objective: Ensure comprehensive error handling that provides meaningful context and graceful degradation Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Error Handling Objective: To prevent the leakage of sensitive system information through error messages while providing sufficient detail for internal debugging. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Secure Logging Practices Objective: To ensure logs are useful for debugging and auditing without exposing sensitive information like PII, PHI, or cardholder data. Status: Passed Learn more about managing compliance generic rules or creating your own custom rules
	Generic: Security-First Input Validation and Data Handling Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent vulnerabilities Status: Passed Learn more about managing compliance generic rules or creating your own custom rules

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Replace vague placeholder with specific actions In the surrender instructions, replace the vague placeholder RESPONSE with the more specific and contextually appropriate actions "accept or reject". ebl-surrender/src/main/resources/standards/eblsurrender/instructions/prompt-surrender-ssp.md [12-13] -2. Your system should automatically **RESPONSE** the surrender request by making a POST request to +2. Your system should automatically **accept or reject** the surrender request by making a POST request to `/ebl-surrender-responses` Apply / Chat Suggestion importance[1-10]: 7 __ Why: This suggestion correctly identifies and fixes a vague placeholder **RESPONSE** left in the PR. Replacing it with "accept or reject" aligns with the terminology used in another file (prompt-surrender-reqres.md), improving both clarity and consistency.	Medium
	Clarify synchronous vs. asynchronous responses Clarify the workflow by explicitly distinguishing between the synchronous acknowledgement from the PUT request and the subsequent asynchronous POST response. This will help users better understand the sequence of events. ebl-issuance/src/main/resources/standards/eblissuance/instructions/prompt-iss-reqres-ebltype.md [6-10] -1. **Your carrier sends**: PUT request to `/ebl-issuance-requests` with the issuance request details -2. **Synthetic platform responds**: Automatically sends an issuance response by making a POST request to - `/ebl-issuance-responses` with response code **RESPONSE_CODE** -3. **Conformance validates**: Your carrier's request conforms to the DCSA eBL Issuance API standard -4. **Your Carrier**: Process the automatic response from the synthetic platform +1. **Your carrier sends**: PUT request to `/ebl-issuance-requests` with the issuance request details. The synthetic platform will provide a synchronous acknowledgement. +2. **Synthetic platform responds asynchronously**: The platform automatically sends an issuance response by making a POST request to your `/ebl-issuance-responses` endpoint with response code **RESPONSE_CODE**. +3. **Conformance validates**: Your carrier's request conforms to the DCSA eBL Issuance API standard. +4. **Your Carrier**: Process the asynchronous response received from the synthetic platform. Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that the distinction between the synchronous PUT response and the asynchronous POST response is unclear in the PR's text. Improving this distinction enhances the clarity of the instructions for the user.	Low
	Remove unintended line break In the source markdown, merge the sentence currently split across two lines into a single line to improve readability and prevent potential formatting issues. ebl-issuance/src/main/resources/standards/eblissuance/instructions/prompt-iss-reqres-ebltype.md [1-2] -Send an issuance request for an eBL of type **EBL_TYPE** to the platform that has not yet been issued to get response -code **RESPONSE_CODE**. +Send an issuance request for an eBL of type **EBL_TYPE** to the platform that has not yet been issued to get response code **RESPONSE_CODE**. Apply / Chat Suggestion importance[1-10]: 5 __ Why: The suggestion correctly points out that the sentence split across two lines will render as a single line in Markdown due to the lack of a blank line or double spaces. While the proposed change improves source code readability, it does not alter the final rendered output.	Low
More

[HenrikHL]

LGTM