-
Notifications
You must be signed in to change notification settings - Fork 8.9k
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
Implement 'osnadmin channel info' subcommand and update tests #4892
Conversation
Signed-off-by: Priyansu Rout <[email protected]>
Signed-off-by: Priyansu Rout <[email protected]>
Signed-off-by: Priyansu Rout <[email protected]>
8306268
to
e95740a
Compare
Signed-off-by: Priyansu Rout <[email protected]>
Signed-off-by: Priyansu Rout <[email protected]>
548a688
to
ebc72d5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You got a check failure because anytime you change commands, you need to regenerate the doc to match.
See the instructions at
https://github.com/hyperledger/fabric/blob/main/docs/source/docs_guide.md#commands-reference-updates
Basically, the command help will be called when you regenerate the doc with each of the subcommands (including the new one which needs to be added in scripts/generateHelpDocs.sh), and this help text will be injected into the osnadminchannel.md doc topic which also needs to be included in the pull request.
You'll also need to add some text to the doc topic preamble and postscript.
To better understand, you can look at the commit that added the initial osnadmin help doc. This will show all the updates that are needed.
1e90c88
info := channel.Command("info", "Get detailed information about a specific channel.") | ||
infoChannelID := info.Flag("channelID", "Channel ID").Short('c').Required().String() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm thinking we can do this in a backward compatible way.
Keep the support for passing channel id to list with this line:
listChannelID := list.Flag("channelID", "Channel ID").Short('c').String()
Then add an entirely new "info" command.
Change the function osnadmin.ListSingleChannel() to osnadmin.Info() and have both of them call it.
The help text doesn't need to mention that you can pass channel id to list command anymore, but keep the functionality there so that any existing users that depend on it don't break.
Implemented the
osnadmin channel info
subcommand to retrieve detailed information about a specific channel from an Ordering Service Node (OSN). This involved modifying the CLI commands and adding corresponding functionality to interact with the channel participation API.Type of change
Implemented the
osnadmin channel info
subcommand to retrieve detailed information about a specific channel from an Ordering Service Node (OSN).info
subcommand underosnadmin channel
to support querying individual channel details.Closes #4890