Skip to content

Conversation

@HenrikHL
Copy link
Contributor

@HenrikHL HenrikHL commented Jan 26, 2026

User description

SD-2769: Correct Endorsement Chain description
Removing lines from the Endorsee description and "SME note"


PR Type

Documentation


Description

  • Remove misleading text from Endorse action description

  • Delete SME note about endorsementChain naming agreement

  • Clarify endorsement behavior across multiple API specs


Diagram Walkthrough

flowchart LR
  A["endorsementChain descriptions"] -- "Remove misleading constraint" --> B["Endorse action clarified"]
  A -- "Delete SME note" --> C["Cleaner documentation"]
  B --> D["Updated specs"]
  C --> D
Loading

File Walkthrough

Relevant files
Documentation
EBL_END_v3.0.3.yaml
Remove constraint and note from Endorse action                     

ebl/v3/endorsement/EBL_END_v3.0.3.yaml

  • Removed phrase stating newly appointed endorsee may NOT further
    endorse
  • Deleted SME note about endorsementChain naming agreement
  • Simplified Endorse action description for clarity
+1/-3     
EBL_SUR_v3.0.3.yaml
Remove constraint and note from Endorse action                     

ebl/v3/surrender/EBL_SUR_v3.0.3.yaml

  • Removed phrase stating newly appointed endorsee may NOT further
    endorse
  • Deleted SME note about endorsementChain naming agreement
  • Simplified Endorse action description for clarity
+1/-3     

@qodo-code-review
Copy link

qodo-code-review bot commented Jan 26, 2026

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-2759
🔴 Add a new optional attribute `facilityName` inside the Facility object.
Ensure `facilityName` has `maxLength: 100`.
Ensure `facilityName` description is "The name of the facility."
Update Facility object description to indicate it can be identified by code or
alternatively by name.
🟢
🎫 #SD-2769
🟢 Remove the sentence from the **Endorse** action description stating the newly appointed
endorsee may NOT further endorse the eBL to another party.
Remove the note stating DCSA member carriers agreed the name endorsementChain is still the
correct name for the list of actions.
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

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

@qodo-code-review
Copy link

qodo-code-review bot commented Jan 26, 2026

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Impact
Possible issue
Clarify action description to avoid ambiguity

Restore the clarification that the Endorse action does not permit further
endorsement to avoid ambiguity with the Endorse to Order action.

ebl/v3/endorsement/EBL_END_v3.0.3.yaml [453]

-- **Endorse:** The act of transferring the rights and obligations associated with the eBL to a new endorsee, meaning the designated recipient of the action, allowing them to claim or deal with the goods. Only applicable to negotiable eBL (`isToOrder=true`).
+- **Endorse:** The act of transferring the rights and obligations associated with the eBL to a new endorsee, meaning the designated recipient of the action, allowing them to claim or deal with the goods. The newly appointed endorsee may **NOT** further endorse the eBL to another party. Only applicable to negotiable eBL (`isToOrder=true`).
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies that the PR introduces ambiguity by removing the distinction between the Endorse and Endorse to Order actions, which is a valid concern for API clarity.

Medium
General
Explicitly forbid re-endorsement

Add a note to the Endorse action description to clarify that it does not allow
further endorsement, distinguishing it from Endorse to Order.

ebl/v3/surrender/EBL_SUR_v3.0.3.yaml [505]

-- **Endorse:** The act of transferring the rights and obligations associated with the eBL to a new endorsee, meaning the designated recipient of the action, allowing them to claim or deal with the goods. Only applicable to negotiable eBL (`isToOrder=true`).
+- **Endorse:** The act of transferring the rights and obligations associated with the eBL to a new endorsee, meaning the designated recipient of the action, allowing them to claim or deal with the goods. Only applicable to negotiable eBL (`isToOrder=true`). This endorsement does not allow further endorsement to another party.
  • Apply / Chat
Suggestion importance[1-10]: 7

__

Why: The suggestion correctly identifies that the PR introduces ambiguity by removing the distinction between the Endorse and Endorse to Order actions, which is a valid concern for API clarity.

Medium
  • Update

@HenrikHL HenrikHL merged commit 7a3e539 into master Jan 26, 2026
1 check passed
@HenrikHL HenrikHL deleted the SD-2759_Improve-endorsementchain-description branch January 26, 2026 10:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants