Skip to content

Commit 58213a4

Browse files
README: replace Swagger by OpenAPI (#1749)
Also remove paragraph duplicated during the merge v2->master
1 parent 03195a1 commit 58213a4

File tree

1 file changed

+1
-13
lines changed

1 file changed

+1
-13
lines changed

README.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ Make sure that your `$GOBIN` is in your `$PATH`.
277277
protoc -I . --openapiv2_out ./gen/openapiv2 --openapiv2_opt logtostderr=true your/service/v1/your_service.proto
278278
```
279279
280-
Note that this plugin also supports generating swagger definitions for unannotated methods; use the `generate_unbound_methods` option to enable this.
280+
Note that this plugin also supports generating OpenAPI definitions for unannotated methods; use the `generate_unbound_methods` option to enable this.
281281
282282
## Video intro
283283
@@ -312,18 +312,6 @@ through protoc using one of 2 patterns:
312312
--openapiv2_opt logtostderr=true --openapiv2_opt repeated_path_param_separator=ssv
313313
```
314314
315-
* using additional `--<tool_suffix>_opt` parameters: `--<tool_suffix>_opt=<flag>[,<flag>]*`
316-
317-
```sh
318-
--grpc-gateway_opt logtostderr=true,repeated_path_param_separator=ssv
319-
# or separately
320-
--grpc-gateway_opt logtostderr=true --grpc-gateway_opt repeated_path_param_separator=ssv
321-
322-
--swagger_opt logtostderr=true,repeated_path_param_separator=ssv
323-
# or separately
324-
--swagger_opt logtostderr=true --swagger_opt repeated_path_param_separator=ssv
325-
```
326-
327315
`protoc-gen-grpc-gateway` supports custom mapping from Protobuf `import` to
328316
Golang import paths. They are compatible with
329317
[the parameters with the same names in `protoc-gen-go`](https://github.com/golang/protobuf#parameters).

0 commit comments

Comments
 (0)