Skip to content

Commit 73a380e

Browse files
Re-add api help docs template
1 parent c8b2513 commit 73a380e

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

internal/cli/api/api.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ For more information on
7979
- Getting started with the Atlas Administration API: https://www.mongodb.com/docs/atlas/configure-api-access/#std-label-atlas-admin-api-access`,
8080
}
8181

82-
rootCmd.SetHelpTemplate(cli.HelpTemplate)
82+
rootCmd.SetHelpTemplate(cli.APICommandHelpTemplate)
8383

8484
return rootCmd
8585
}

internal/cli/help_templates.go

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,11 @@ const (
2020
HelpTemplate = `{{.Short | trimTrailingWhitespaces}} {{.Long | trimTrailingWhitespaces}}
2121
2222
{{if or .Runnable .HasSubCommands}}{{.UsageString}}{{end}}`
23+
24+
ExperimentalText = "The atlas api sub-command, " +
25+
"automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API.\n" +
26+
"Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint " +
27+
"documentation link.\n\n"
28+
29+
APICommandHelpTemplate = ExperimentalText + HelpTemplate
2330
)

0 commit comments

Comments
 (0)