Skip to content

Add proof chain and set documentation to credential issuance #503

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

Merged
merged 3 commits into from
Jul 30, 2025

Conversation

bparth24
Copy link
Contributor

@bparth24 bparth24 commented Jul 29, 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.

Background
This PR replaces PR #495, which had corrupted commit history due to a rebase issue that lost proper attribution. I apologize for my mistake - this clean branch preserves everyone's contributions with correct authorship.

Individual Contributions

📋 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

Note
This replaces PR #495 due to commit history corruption. All improvements are preserved here with proper attribution.

If merged it will close: #422 and replaces: PR #495. In any case PR #495 should be closed right away.

@dlongley @msporny @TallTed - ready for review & merge.


Preview | Diff

@msporny
Copy link
Contributor

msporny commented Jul 30, 2025

@bparth24 Still not quite right, you have to make sure the author is set to the right value for each commit. Given the commits you've done, we'd have to manually go through each commit to assign provenance instead of just using the commit author field. We have a script to do the tallying automatically based on git author (not commit message, which we can't depend on because of the varied way that people do commit comments).

You will want to do something like:

git rebase -i FIRST_COMMIT_IN_PR
for each commit:
  git commit --amend --author="New Author Name <[email protected]>" --no-edit
  git rebase --continue
git push --force

Also, please use a consistent commit message format:

https://github.com/digitalbazaar/bedrock/blob/main/CONTRIBUTING.md#commit-messages

@bparth24 bparth24 force-pushed the bparth24-issue-422-fix-contributions branch from c817e55 to 961b721 Compare July 30, 2025 16:50
@bparth24
Copy link
Contributor Author

@bparth24 Still not quite right, you have to make sure the author is set to the right value for each commit. Given the commits you've done, we'd have to manually go through each commit to assign provenance instead of just using the commit author field. We have a script to do the tallying automatically based on git author (not commit message, which we can't depend on because of the varied way that people do commit comments).

You will want to do something like:

git rebase -i FIRST_COMMIT_IN_PR
for each commit:
  git commit --amend --author="New Author Name <[email protected]>" --no-edit
  git rebase --continue
git push --force

Also, please use a consistent commit message format:

https://github.com/digitalbazaar/bedrock/blob/main/CONTRIBUTING.md#commit-messages

@msporny

  • Thank you for reviewing and guiding me. I updated the author for each commit using your script.
  • I will make sure to read the commit message format instructions a few more times before committing.
  • Now, for this PR, if you want me to update the commit message as per the commit format, I'm happy to do those as well.

@msporny
Copy link
Contributor

msporny commented Jul 30, 2025

if you want me to update the commit message as per the commit format, I'm happy to do those as well.

yes, please do. Ideally, all commits should follow that format.

bparth24 and others added 3 commits July 30, 2025 13:49
- Defines three approaches for handling existing proofs: Proof Sets, Proof Chains, and Error Handling
- Clarifies behavior when credentials already contain proofs

Addresses w3c-ccg#422
- Improves sentence structure and clarity throughout the section

Addresses w3c-ccg#422
- Enhances technical precision in proof handling descriptions

Addresses w3c-ccg#422
@bparth24 bparth24 force-pushed the bparth24-issue-422-fix-contributions branch from 961b721 to 2026200 Compare July 30, 2025 20:56
@bparth24
Copy link
Contributor Author

if you want me to update the commit message as per the commit format, I'm happy to do those as well.

yes, please do. Ideally, all commits should follow that format.

@msporny I understood and updated the commit messages.

@msporny
Copy link
Contributor

msporny commented Jul 30, 2025

@msporny I understood and updated the commit messages.

Excellent! LGTM, merging.

@msporny msporny merged commit be5922a into w3c-ccg:main Jul 30, 2025
1 check passed
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.

Add support for proof chains to VC API POST credential/issue endpoint
4 participants