-
Notifications
You must be signed in to change notification settings - Fork 84
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
CLOUDP-304933 Add operationId to API commands and restructure docs generation tool #3715
Conversation
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.
Plugin commands need to be removed before generating docs. Otherwise, LGTM
|
||
for _, cmd := range atlasBuilder.Commands() { | ||
if plugin.IsPluginCmd(cmd) && !isFirstClassPlugin(cmd) { | ||
atlasBuilder.RemoveCommand(cmd) | ||
} | ||
} | ||
|
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.
Still need to remove non-first-class plugins to avoid generating docs for plugins.
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.
added back, but the way I see it, we will never run into this edge case, given we won't install plugins on CI, right?
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.
Not in CI, yes. But this just makes life easier on us as devs if we do work where we need to generate some docs changes and also have some plugin installed. Thanks for the change!
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.
LGTM!
Coverage Report 📈
|
Proposed changes
Add operationId to API commands and restructure docs generation tool
Jira ticket: CLOUDP-304933
Closes #[issue number]
Checklist
make fmt
and formatted my codeFurther comments