Skip to content

Commit

Permalink
[INJIMOB-1862] modify adr doc file name as per decision
Browse files Browse the repository at this point in the history
Signed-off-by: KiruthikaJeyashankar <[email protected]>
  • Loading branch information
KiruthikaJeyashankar committed Oct 9, 2024
1 parent 20d4dfd commit 80aa456
Showing 1 changed file with 3 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,19 @@ The current design accepts credential as a string and performs the logic of vc v

## Decision

- Accept ``format`` parameter in the verification method to identify the format of the vc
- Accept ``credentialFormat`` parameter in the verification method to identify the format of the vc
- Implement Factory pattern for verification of different format of VCs to keep the design of the library extensible for different formats of VC
- Support for current consumers?
- To continue the support for existing consumers using the `verifyCredentials` method, the current method will be still exposed as a deprecated method to avoid breaking changes introduction
- Other changes
- method name for verification will have the name ``verify`` state the functionality of the method
- Method signature: verify(credential: String, credentialFormat: CredentialFormat): Boolean
![img_2.png](verify_without_format.png) ![img_3.png](verify_with_format.png)

## Consequences

- Existing consumers using the `verifyCredentials` method for verifying `ldp_vc` format VCs are not required to modify the usage of this library as the older method will still be supported in deprecated mode
- The introduction of the format method will be used further to identify the verification logic that needs to be applied over the credential
- The introduction of the new method `verify` will be used further to identify the verification logic that needs to be applied over the `credential` based on the input `credentialFormat`, providing support for other credential formats (as per CredentialFormat constant exposed)


## People involved
Expand Down

0 comments on commit 80aa456

Please sign in to comment.