docs: document KeyEndorsementPolicy class for State-Based Endorsement (#307)#500
Merged
Merged
Conversation
Signed-off-by: Sourav <souravkjha2007@gmail.com>
JhaSourav07
force-pushed
the
issue-307-fix
branch
from
22f1961 to
4f9318f
Compare
bestbeforetoday
requested changes
May 31, 2026
Member
bestbeforetoday
left a comment
bestbeforetoday
left a comment
There was a problem hiding this comment.
Thank you for contributing this enhancement. See inline comments for issues that need to be resolved.
…dorsementPolicy Signed-off-by: Sourav Jha <souravkjha2007@gmail.com>
JhaSourav07
force-pushed
the
issue-307-fix
branch
from
c2fe8ad to
ed0f5b8
Compare
Contributor
Author
I think i resolved the issues, please let me know if there is anything else |
bestbeforetoday
requested changes
Jun 2, 2026
Member
bestbeforetoday
left a comment
bestbeforetoday
left a comment
There was a problem hiding this comment.
Sorry, just one more change needed that I should have spotted on the first pass. Otherwise looks good to me now.
…aincode module Signed-off-by: Sourav Jha <souravkjha2007@gmail.com>
Contributor
Author
No issues |
bestbeforetoday
approved these changes
Jun 2, 2026
Member
bestbeforetoday
left a comment
bestbeforetoday
left a comment
There was a problem hiding this comment.
Thank you for the contribution.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR Closes ** #307** by adding documentation for the
KeyEndorsementPolicyclass to the official Node.js reference documentation.The
KeyEndorsementPolicyclass is essential for implementing State-Based Endorsement (SBE) but was previously missing from the generated API docs.This update ensures the class and its methods are properly documented and visible in the generated documentation, improving discoverability and developer usability.
Changes
Documentation Configuration
docs/_jsdoc.jsonto includelibraries/fabric-shim/lib/utils/statebased.jsin the source scanning path so the class is included during documentation generation.JSDoc Enhancements
Added comprehensive JSDoc comments for the
KeyEndorsementPolicyclass and its methods:addOrgsdelOrgslistOrgsgetPolicyTypeScript Definitions
KeyEndorsementPolicyclass tolibraries/fabric-shim/types/index.d.ts.Library Export
KeyEndorsementPolicyis correctly exported inlibraries/fabric-shim/index.jsso it can be used by consumers.Verification
npm run buildinside thedocsfolder. TheKeyEndorsementPolicyclass now appears in the sidebar with full method documentation.npm run lintinsidelibraries/fabric-shimwith 0 errors.rush rebuildfor the entire monorepo.Checklist
Screenshots
Closes #307