Skip to content

Commit

Permalink
chore: remove repetitive words
Browse files Browse the repository at this point in the history
Signed-off-by: shandongbinzhou <shandongbinzhou@outlook.com>
  • Loading branch information
shandongbinzhou authored and fredbi committed Mar 30, 2024
1 parent 2086881 commit be3ed1d
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion cmd/swagger/commands/serve.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ type ServeCmd struct {
BasePath string `long:"base-path" description:"the base path to serve the spec and UI at"`
Flavor string `short:"F" long:"flavor" description:"the flavor of docs, can be swagger or redoc" default:"redoc" choice:"redoc" choice:"swagger"`
DocURL string `long:"doc-url" description:"override the url which takes a url query param to render the doc ui"`
NoOpen bool `long:"no-open" description:"when present won't open the the browser to show the url"`
NoOpen bool `long:"no-open" description:"when present won't open the browser to show the url"`
NoUI bool `long:"no-ui" description:"when present, only the swagger spec will be served"`
Flatten bool `long:"flatten" description:"when present, flatten the swagger spec before serving it"`
Port int `long:"port" short:"p" description:"the port to serve this site" env:"PORT"`
Expand Down
2 changes: 1 addition & 1 deletion design.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Binding makes use of plain vanilla golang serializers and they are identified by

Binding is not only about request bodies but also about values obtained from headers, query string parameters and potentially the route path pattern. So the binding should make use of the full request object to produce a model.

It determines a serializer to use by looking in the the merged consumes values and the `Content-Type` header to determine which deserializer to use.
It determines a serializer to use by looking in the merged consumes values and the `Content-Type` header to determine which deserializer to use.
When a result is produced it will do the same thing by making use of the `Accept` http header etc and the merged produces clauses for the operation endpoint.

```go
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/todo-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -439,7 +439,7 @@ api.TodosDestroyOneHandler = todos.DestroyOneHandlerFunc(func(params todos.Destr
})
```

After deleting the item from the store, you need to provide a response. The code generator created responders for each response you defined in the the swagger specification, and you can see how one of those is being used in the example above.
After deleting the item from the store, you need to provide a response. The code generator created responders for each response you defined in the swagger specification, and you can see how one of those is being used in the example above.

The other 3 handler implementations are similar to this one. They are provided in the [source for this tutorial](https://github.com/go-swagger/go-swagger/blob/master/examples/tutorials/todo-list/server-complete/restapi/configure_todo_list.go).

Expand Down
2 changes: 1 addition & 1 deletion docs/usage/serve_ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Help Options:
--base-path= the base path to serve the spec and UI at
-F, --flavor=[redoc|swagger] the flavor of docs, can be swagger or redoc (default: redoc)
--doc-url= override the url which takes a url query param to render the doc ui
--no-open when present won't open the the browser to show the url
--no-open when present won't open the browser to show the url
--no-ui when present, only the swagger spec will be served
-p, --port= the port to serve this site [$PORT]
--host= the interface to serve this site, defaults to 0.0.0.0 [$HOST]
Expand Down

0 comments on commit be3ed1d

Please sign in to comment.