Skip to content

docs: document read/update/delete exceptions on Driver - #27

Open
antcybersec wants to merge 1 commit into
hyperledger-identus:mainfrom
antcybersec:docs/driver-read-update-delete-exceptions-23
Open

docs: document read/update/delete exceptions on Driver#27
antcybersec wants to merge 1 commit into
hyperledger-identus:mainfrom
antcybersec:docs/driver-read-update-delete-exceptions-23

Conversation

@antcybersec

@antcybersec antcybersec commented Jun 5, 2026

Copy link
Copy Markdown

Summary

  • Add DriverExceptions contract describing how drivers signal failures on read, update, and delete
  • Add @throws KDoc on Driver data-access methods
  • Expand README §8 with a per-driver exception table (Database, InMemory, PRISM)

Closes #23.

Part of hyperledger-identus/hyperledger-identus#161.

Test plan

  • Documentation-only change
  • Maintainer review of exception table accuracy

…dentus#23)

Add DriverExceptions contract and KDoc on Driver data-access methods.
Expand README error-handling section with per-driver exception table.

Part of hyperledger-identus/hyperledger-identus#161.

Signed-off-by: Anant Kumar <anant1234466@gmail.com>
@sonarqubecloud

sonarqubecloud Bot commented Jun 5, 2026

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

The Driver interface signature should document the possible exceptions

1 participant