Skip to content

Commit 4251b97

Browse files
committed
edit flag descriptions
1 parent cbbd8ab commit 4251b97

File tree

5 files changed

+19
-19
lines changed

5 files changed

+19
-19
lines changed

docs/stackit_beta_security-group_rule_create.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,16 @@ stackit beta security-group rule create [flags]
3030

3131
```
3232
--description string The rule description
33-
--direction ingress The direction of the traffic which the rule should match. The possible values are: ingress, `egress`
33+
--direction string The direction of the traffic which the rule should match. The possible values are: "ingress", "egress"
3434
--ether-type string The ethertype which the rule should match
3535
-h, --help Help for "stackit beta security-group rule create"
3636
--icmp-parameter-code int ICMP code. Can be set if the protocol is ICMP
3737
--icmp-parameter-type int ICMP type. Can be set if the protocol is ICMP
3838
--ip-range string The remote IP range which the rule should match
3939
--port-range-max int The maximum port number. Should be greater or equal to the minimum. This should only be provided if the protocol is not ICMP
4040
--port-range-min int The minimum port number. Should be less or equal to the maximum. This should only be provided if the protocol is not ICMP
41-
--protocol-name protocol-name The protocol name which the rule should match. If a protocol is to be defined, either protocol-name or `protocol-number` must be provided
42-
--protocol-number protocol-name The protocol number which the rule should match. If a protocol is to be defined, either protocol-name or `protocol-number` must be provided
41+
--protocol-name string The protocol name which the rule should match. If a protocol is to be defined, either "protocol-name" or "protocol-number" must be provided
42+
--protocol-number int The protocol number which the rule should match. If a protocol is to be defined, either "protocol-name" or "protocol-number" must be provided
4343
--remote-security-group-id string The remote security group which the rule should match
4444
--security-group-id string The security group ID
4545
```

internal/cmd/beta/security-group/rule/create/create.go

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -123,18 +123,18 @@ func NewCmd(p *print.Printer) *cobra.Command {
123123
}
124124

125125
func configureFlags(cmd *cobra.Command) {
126-
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, "The security group ID")
127-
cmd.Flags().String(directionFlag, "", "The direction of the traffic which the rule should match. The possible values are: `ingress`, `egress`")
128-
cmd.Flags().String(descriptionFlag, "", "The rule description")
129-
cmd.Flags().String(etherTypeFlag, "", "The ethertype which the rule should match")
130-
cmd.Flags().Int64(icmpParameterCodeFlag, 0, "ICMP code. Can be set if the protocol is ICMP")
131-
cmd.Flags().Int64(icmpParameterTypeFlag, 0, "ICMP type. Can be set if the protocol is ICMP")
132-
cmd.Flags().String(ipRangeFlag, "", "The remote IP range which the rule should match")
133-
cmd.Flags().Int64(portRangeMaxFlag, 0, "The maximum port number. Should be greater or equal to the minimum. This should only be provided if the protocol is not ICMP")
134-
cmd.Flags().Int64(portRangeMinFlag, 0, "The minimum port number. Should be less or equal to the maximum. This should only be provided if the protocol is not ICMP")
135-
cmd.Flags().Var(flags.UUIDFlag(), remoteSecurityGroupIdFlag, "The remote security group which the rule should match")
136-
cmd.Flags().Int64(protocolNumberFlag, 0, "The protocol number which the rule should match. If a protocol is to be defined, either `protocol-name` or `protocol-number` must be provided")
137-
cmd.Flags().String(protocolNameFlag, "", "The protocol name which the rule should match. If a protocol is to be defined, either `protocol-name` or `protocol-number` must be provided")
126+
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, `The security group ID`)
127+
cmd.Flags().String(directionFlag, "", `The direction of the traffic which the rule should match. The possible values are: "ingress", "egress"`)
128+
cmd.Flags().String(descriptionFlag, "", `The rule description`)
129+
cmd.Flags().String(etherTypeFlag, "", `The ethertype which the rule should match`)
130+
cmd.Flags().Int64(icmpParameterCodeFlag, 0, `ICMP code. Can be set if the protocol is ICMP`)
131+
cmd.Flags().Int64(icmpParameterTypeFlag, 0, `ICMP type. Can be set if the protocol is ICMP`)
132+
cmd.Flags().String(ipRangeFlag, "", `The remote IP range which the rule should match`)
133+
cmd.Flags().Int64(portRangeMaxFlag, 0, `The maximum port number. Should be greater or equal to the minimum. This should only be provided if the protocol is not ICMP`)
134+
cmd.Flags().Int64(portRangeMinFlag, 0, `The minimum port number. Should be less or equal to the maximum. This should only be provided if the protocol is not ICMP`)
135+
cmd.Flags().Var(flags.UUIDFlag(), remoteSecurityGroupIdFlag, `The remote security group which the rule should match`)
136+
cmd.Flags().Int64(protocolNumberFlag, 0, `The protocol number which the rule should match. If a protocol is to be defined, either "protocol-name" or "protocol-number" must be provided`)
137+
cmd.Flags().String(protocolNameFlag, "", `The protocol name which the rule should match. If a protocol is to be defined, either "protocol-name" or "protocol-number" must be provided`)
138138

139139
err := flags.MarkFlagsRequired(cmd, securityGroupIdFlag, directionFlag)
140140
cmd.MarkFlagsMutuallyExclusive(protocolNumberFlag, protocolNameFlag)

internal/cmd/beta/security-group/rule/delete/delete.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
9393
}
9494

9595
func configureFlags(cmd *cobra.Command) {
96-
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, "The security group ID")
96+
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, `The security group ID`)
9797

9898
err := flags.MarkFlagsRequired(cmd, securityGroupIdFlag)
9999
cobra.CheckErr(err)

internal/cmd/beta/security-group/rule/describe/describe.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ func NewCmd(p *print.Printer) *cobra.Command {
7676
}
7777

7878
func configureFlags(cmd *cobra.Command) {
79-
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, "The security group ID")
79+
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, `The security group ID`)
8080

8181
err := flags.MarkFlagsRequired(cmd, securityGroupIdFlag)
8282
cobra.CheckErr(err)

internal/cmd/beta/security-group/rule/list/list.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ func NewCmd(p *print.Printer) *cobra.Command {
103103
}
104104

105105
func configureFlags(cmd *cobra.Command) {
106-
cmd.Flags().Int64(limitFlag, 0, "Maximum number of entries to list")
107-
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, "The security group ID")
106+
cmd.Flags().Int64(limitFlag, 0, `Maximum number of entries to list`)
107+
cmd.Flags().Var(flags.UUIDFlag(), securityGroupIdFlag, `The security group ID`)
108108

109109
err := flags.MarkFlagsRequired(cmd, securityGroupIdFlag)
110110
cobra.CheckErr(err)

0 commit comments

Comments
 (0)