Skip to content

Add proof chain and set documentation to credential issuance #495

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

bparth24
Copy link
Contributor

@bparth24 bparth24 commented Jul 12, 2025

This PR addresses #422 by clarifying how the /credentials/issue endpoint handles credentials with existing proofs as agreed upon in the 2025-05-27 call.

📋 Changes Made

  • Enhanced Issue Credential section to document three configuration-based behaviors:

    • Proof Sets: Append proofs in parallel for cryptographic flexibility
    • Proof Chains: Link proofs sequentially for approval workflows
    • Error Handling: Reject credentials with existing proofs when configured
  • Clarified instance configuration determines proof processing behavior

🔧 Files Changed

  • index.html - Updated "Issue Credential" section documentation

🤔 Reviewer Input Requested

  • Should I also perform schema updates?

Potential changes:

  1. Update components/Credential.yml file - enhance UnsecuredCredential proof property description to An optional proof or array of proofs for credentials that are secured using proof sets or chains. When present, the issuer instance configuration determines how these existing proofs are processed (appended to create proof sets/chains, or trigger an error).
  2. Update components/IssueCredentialOptions.yml - add optional proofId and previousProof properties
  3. Update root level issuer.yml file - enhance endpoint description for proof handling

@msporny @dlongley

Please review this documentation approach first and guide me if the schema enhancements are needed to resolve issue #422.


Preview | Diff

bparth24 and others added 2 commits July 14, 2025 14:32
Corrected from its to their.

Co-authored-by: Ted Thibodeau Jr <[email protected]>
corrected `its` to `their`.

Co-authored-by: Ted Thibodeau Jr <[email protected]>
bparth24 and others added 2 commits July 22, 2025 10:21
Updated language for Proof Sets.

Co-authored-by: Dave Longley <[email protected]>
Updated language for Proof Chains

Co-authored-by: Dave Longley <[email protected]>
@bparth24
Copy link
Contributor Author

@dlongley thanks for the input. It makes sense to me.

@BigBlueHat BigBlueHat requested a review from TallTed July 22, 2025 19:10
@BigBlueHat
Copy link
Collaborator

Group discussed on 7/22 and agreed to merge this pending an addition from @bparth24 and/or confirmation of no additional schema changes being needed.

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.

4 participants