Skip to content
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

Merged
merged 2 commits into from
Mar 7, 2025

Conversation

fmenezes
Copy link
Collaborator

@fmenezes fmenezes commented Mar 7, 2025

Proposed changes

Add operationId to API commands and restructure docs generation tool

Jira ticket: CLOUDP-304933

Closes #[issue number]

Checklist

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works
  • I have added any necessary documentation in document requirements section listed in CONTRIBUTING.md (if appropriate)
  • I have addressed the @mongodb/docs-cloud-team comments (if appropriate)
  • I have updated test/README.md (if an e2e test has been added)
  • I have run make fmt and formatted my code

Further comments

@fmenezes fmenezes changed the title CLOUDP-304933 Add operationId to commands and restructure docs generation tool CLOUDP-304933 Add operationId to API commands and restructure docs generation tool Mar 7, 2025
@fmenezes fmenezes marked this pull request as ready for review March 7, 2025 12:00
@fmenezes fmenezes requested a review from a team as a code owner March 7, 2025 12:00
Copy link
Collaborator

@cveticm cveticm left a 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

Comment on lines 37 to -111

for _, cmd := range atlasBuilder.Commands() {
if plugin.IsPluginCmd(cmd) && !isFirstClassPlugin(cmd) {
atlasBuilder.RemoveCommand(cmd)
}
}

Copy link
Collaborator

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.

Copy link
Collaborator Author

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?

Copy link
Collaborator

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!

@fmenezes fmenezes requested a review from cveticm March 7, 2025 12:22
Copy link
Collaborator

@cveticm cveticm left a comment

Choose a reason for hiding this comment

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

LGTM!

@fmenezes fmenezes enabled auto-merge (squash) March 7, 2025 12:27
Copy link
Contributor

github-actions bot commented Mar 7, 2025

Coverage Report 📈

Branch Commit Coverage
master 37f565e 37.9%
CLOUDP-304933 185fb98 37.9%
Difference 0%

@fmenezes fmenezes merged commit bf5bcf6 into master Mar 7, 2025
20 of 21 checks passed
@fmenezes fmenezes deleted the CLOUDP-304933 branch March 7, 2025 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants