Skip to content

docs: fix getCreator and ProposalCreator type documentation#498

Merged
bestbeforetoday merged 1 commit intohyperledger:mainfrom
JhaSourav07:fix/issue-308
Mar 11, 2026
Merged

docs: fix getCreator and ProposalCreator type documentation#498
bestbeforetoday merged 1 commit intohyperledger:mainfrom
JhaSourav07:fix/issue-308

Conversation

@JhaSourav07
Copy link
Contributor

Description

This PR fixes the JSDoc documentation for the getCreator() method and the submitter's identity object to accurately reflect the TypeScript definitions (SerializedIdentity) found in fabric-shim-api.

Previously, the JSDoc incorrectly referred to the identity object as an instantiable class named ProposalCreator and incorrectly listed the certificate bytes property as id_bytes instead of the camelCased idBytes.

Changes Made:

  • Renamed ProposalCreator to SerializedIdentity in libraries/fabric-shim/lib/stub.js.
  • Updated the certificate bytes property name from id_bytes to idBytes.
  • Removed the @class tag from the identity object typedef so it is no longer falsely documented as a constructible class.
  • Updated the getCreator() return type and other relevant references (like SignedProposal and SignatureHeader) to use SerializedIdentity.

Related Issues

Fixes #308

Checklist:

  • I have added a Developer Certificate of Origin (DCO) sign-off to my commit(s).
  • I have run the linter and unit tests locally to verify my changes do not break existing code.
  • I have built the documentation locally to verify the changes display correctly.

Fixes hyperledger#308

Signed-off-by: Sourav <souravkjha2007@gmail.com>
@JhaSourav07 JhaSourav07 requested a review from a team as a code owner March 10, 2026 14:33
Copy link
Member

@bestbeforetoday bestbeforetoday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the contribution.

@bestbeforetoday bestbeforetoday enabled auto-merge (squash) March 11, 2026 09:26
@bestbeforetoday bestbeforetoday merged commit 5ec1616 into hyperledger:main Mar 11, 2026
8 checks 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.

getCreator and ProposedCreator documentation looks to be incorrect

2 participants