From 28d229a6d3e09df011cd0668eaf1708e261d5096 Mon Sep 17 00:00:00 2001 From: Neal Date: Mon, 9 Sep 2024 13:02:13 -0700 Subject: [PATCH] update --- docs/API_DESIGN.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/API_DESIGN.md b/docs/API_DESIGN.md index 7ab1fd5b..f31dcf49 100644 --- a/docs/API_DESIGN.md +++ b/docs/API_DESIGN.md @@ -166,6 +166,7 @@ CLASS VerifiablePresentation PUBLIC DATA issuance_date: datetime PUBLIC DATA expiration_date: datetime? PUBLIC DATA verifiable_credential: []string + PUBLIC DATA additional_data: Map? CONSTRUCTOR create(holder: string, vc_jwts: []string, options: VerifiablePresentationCreateOptions?) CONSTRUCTOR from_vp_jwt(vp_jwt: string, verify: bool) @@ -182,6 +183,7 @@ CLASS VerifiablePresentationCreateOptions PUBLIC DATA type: []string? PUBLIC DATA issuance_date: datetime? PUBLIC DATA expiration_date: datetime? + PUBLIC DATA additional_data: Map? ``` ## Presentation Exchange (PEX) @@ -196,6 +198,7 @@ CLASS PresentationDefinition PUBLIC DATA input_descriptors: []InputDescriptor METHOD select_credentials(vc_jwts: []string): []string + METHOD create_presentation_from_credentials(vc_jwts: []string): (PresentationSubmission, []string) ``` ### `InputDescriptor` @@ -246,6 +249,46 @@ CLASS Filter PUBLIC DATA contains: Filter? ``` +### `PresentationSubmission` + +```pseudocode! +CLASS PresentationSubmission + PUBLIC DATA id: string + PUBLIC DATA definition_id: string + PUBLIC DATA descriptor_map: []InputDescriptorMapping +``` + +### `InputDescriptorMapping` + +```pseudocode! +CLASS InputDescriptorMapping + PUBLIC DATA id: string + PUBLIC DATA format: string + PUBLIC DATA path: string + PUBLIC DATA path_nested: InputDescriptorMapping? +``` + +### `SubmissionRequirement` + +```pseudocode! +CLASS SubmissionRequirement + PUBLIC DATA rule: SubmissionRequirementRule + PUBLIC DATA from: string? + PUBLIC DATA from_nested: []SubmissionRequirement? + PUBLIC DATA name: string? + PUBLIC DATA purpose: string? + PUBLIC DATA count: uint32? + PUBLIC DATA min: uint32? + PUBLIC DATA max: uint32? +``` + +### `SubmissionRequirementRule` + +```pseudocode! +ENUM SubmissionRequirementRule + All + Pick +``` # Crypto ## `Jwk`