Skip to content

Commit ec0fa6a

Browse files
committed
docs: update example comment
1 parent f08fea6 commit ec0fa6a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

cmd/sponge/commands/generate/swagger.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,15 @@ func HandleSwaggerJSONCommand() *cobra.Command {
3434
Use: "swagger",
3535
Short: "Handle swagger json file",
3636
Long: "Handles Swagger JSON files by standardizing response format data, " +
37-
"converting specifications to OpenAPI 3, and transforming 64-bit integer fields into strings.",
37+
"converting specifications to OpenAPI 3, and transforming 64-bit fields string into integer (default is true).",
3838
Example: color.HiBlackString(` # Standardize response format data in swagger.json
3939
sponge web swagger --enable-standardize-response --file=docs/swagger.json
4040
4141
# Convert swagger2.0 to openapi3.0
4242
sponge web swagger --enable-to-openapi3 --file=docs/swagger.json
4343
44-
# Transform 64-bit integer into string in swagger.json fields
45-
sponge web swagger --enable-integer-to-string --file=docs/swagger.json`),
44+
# Cancel the default conversion of 64 bit integer type fields from strings to integers
45+
sponge web swagger --enable-string-to-integer=false --file=docs/swagger.json`),
4646
SilenceErrors: true,
4747
SilenceUsage: true,
4848
RunE: func(cmd *cobra.Command, args []string) error {
@@ -52,7 +52,7 @@ func HandleSwaggerJSONCommand() *cobra.Command {
5252
if err = handleSwaggerFieldStringToInteger(jsonFile); err != nil {
5353
return err
5454
}
55-
fmt.Printf("Successfully transform 64-bit string to integer in %s fields\n", jsonFile)
55+
fmt.Printf("Successfully transform 64-bit fields string to integer in %s fields\n", jsonFile)
5656
}
5757

5858
if enableUniformResponse {
@@ -78,7 +78,7 @@ func HandleSwaggerJSONCommand() *cobra.Command {
7878
cmd.Flags().BoolVarP(&enableUniformResponse, "enable-standardize-response", "u", false, "standardize response format data in swagger json")
7979
cmd.Flags().BoolVarP(&enableConvertToOpenAPI3, "enable-to-openapi3", "o", false, "convert swagger2.0 to openapi3")
8080
cmd.Flags().BoolVarP(&enableStringToInteger, "enable-string-to-integer", "t", true, "transform string into 64-bit integer in swagger.json fields")
81-
cmd.Flags().BoolVarP(&enableTransformIntegerToString, "enable-integer-to-string", "s", false, "Deprecated, instead use --enable-string-to-integer")
81+
cmd.Flags().BoolVarP(&enableTransformIntegerToString, "enable-integer-to-string", "s", false, "deprecated, instead use --enable-string-to-integer")
8282

8383
return cmd
8484
}

0 commit comments

Comments
 (0)