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.

Sign up for GitHub

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

Add long-form help for slack provider #4766

Merged
merged 1 commit into from
Oct 18, 2024
Merged

Add long-form help for slack provider #4766

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions providers/slack/config/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,15 @@ var Config = plugin.Provider{
ConnectionTypes: []string{provider.ConnectionType},
Connectors: []plugin.Connector{
{
Name: "slack",
Use: "slack",
Short: "a Slack team",
Name: "slack",
Use: "slack",
Short: "a Slack team",
Long: `Use the slack provider to query resources in a Slack team.

Examples:
cnquery shell slack --token <api-token>
cnspec scan slack --team-id <team-id> --token <api-token>
`,
MinArgs: 0,
MaxArgs: 0,
Discovery: []string{},
Expand All @@ -27,13 +33,13 @@ var Config = plugin.Provider{
Long: "token",
Type: plugin.FlagType_String,
Default: "",
Desc: "Slack API token",
Desc: "Slack API token (To learn more, read https://mondoo.com/docs/cnspec/saas/slack/)",
},
{
Long: "team-id",
Type: plugin.FlagType_String,
Default: "",
Desc: "Team ID (required for org token)",
Desc: "Team ID (required if the token is an org token)",
},
},
},
Expand Down
Loading