Skip to content

Releases: grpc-ecosystem/grpc-gateway

v2.3.0

25 Feb 18:33
@johanbrandhorst johanbrandhorst
v2.3.0
bcc34ef
Compare
Choose a tag to compare
v2.3.0

This release migrates our internal generation strategy to using buf, and also updates the installation instructions to instruct users how to use buf to manage the googleapis dependencies in their own projects. If you are used to copying the third_party folder for your dependencies, you are now encouraged to check out the usage instructions again to see how to use buf to manage your dependencies instead.

The boilerplate repo contains an example.

v2.3.0 (2021-02-25)

Full Changelog

Implemented enhancements:

  • Support optional annotation in proto3 files in generators #1278

Fixed bugs:

  • grpc-gateway v2 misreads grpc protobuf field_mask behavior, breaks existing valid behavior #1766

Closed issues:

  • grpc-gateway service run error #1996
  • ../proto/api/proto/service.pb.gw.go:129:95: cannot use *StringMessage value as type protoreflect.ProtoMessage in return argument: *StringMessage does not implement protoreflect.ProtoMessage (missing ProtoReflect method) #1989
  • Grpc healthcheck docs are unclear #1977
  • Gateway protoc does not generate protoreflect.ProtoMessage messages #1959
  • [bazel] Got "missing strict dependencies" when use protoc-gen-grpc-gateway as bazel-gazelle grpc compiler #1941
  • Non official implementation #1940
  • Empty fields included in response. #1871

Merged pull requests:

  • fix(deps): update module google.golang.org/grpc to v1.36.0 (master) #1999 (renovate[bot])
  • fix(deps): update google.golang.org/genproto commit hash to 063164c (master) #1998 (renovate[bot])
  • chore(deps): update dependency com_google_protobuf to v3.15.2 (master) #1995 (renovate[bot])
  • chore(deps): update bufbuild/buf docker tag to v0.37.1 (master) #1994 (renovate[bot])
  • fix(deps): update google.golang.org/genproto commit hash to 22b48be (master) #1993 (renovate[bot])
  • fix(deps): update google.golang.org/genproto commit hash to 3e1e516 (master) #1991 (renovate[bot])
  • fix(deps): update google.golang.org/genproto commit hash to aa3ee6e (master) #1990 (renovate[bot])
  • chore(deps): update dependency com_google_protobuf to v3.15.1 (master) #1987 (renovate[bot])
  • fix(deps): update golang.org/x/oauth2 commit hash to 9bb9049 (master) #1986 (renovate[bot])
  • fix(deps): update google.golang.org/genproto commit hash to d891e3c (master) #1985 (renovate[bot])
  • chore(deps): update dependency com_google_protobuf to v3.15.0 (master) #1984 (renovate[bot])
  • fix(deps): update golang.org/x/oauth2 commit hash to ba52d33 (master) #1983 (renovate[bot])
  • fix(deps): update google.golang.org/genproto commit hash to fe80b38 (master) #1982 (renovate[bot])
  • chore(deps): update google.golang.org/genproto commit hash to c185827 (master) #1979 (renovate[bot])
  • Use base64.URLEncoding for []byte parameters in query #1978 (tvoll)
  • chore(deps): update golang docker tag to v1.16.0 (master) #1976 (renovate[bot])
  • chore(deps): update golang.org/x/oauth2 commit hash to 16ff188 (master) #1974 (renovate[bot])
  • adding UnimplementedGreeterServer to server struct #1973 (nwandabridges)
  • [Bazel] Update protobuf, rules_go and gazelle #1972 (aaliddell)
  • Migrate generation, linting to buf #1971 (johanbrandhorst)
  • chore(deps): update google.golang.org/genproto commit hash to e7f2df4 (master) #1970 (renovate[bot])
  • chore(deps): update google.golang.org/genproto commit hash to 4ccc9a5 (master) #1969 (renovate[bot])
  • Bump nokogiri from 1.10.10 to 1.11.1 in /docs #1967 (dependabot[bot])
  • docs/Gemfile.lock: Fix dependabot security warning #1966 (ivucica)
  • chore(deps): update google.golang.org/genproto commit hash to 3a9a48d (master) #1965 (renovate[bot])
  • chore(deps): update golang.org/x/oauth2 commit hash to 6667018 (master) #1964 (renovate[bot])
  • Update CONTRIBUTING.md on release description #1960 (adambabik)
  • gen-grpc-gateway, gen-openapiv2: add support for proto3 optional #1951 (adambabik)
  • FAQ Adding related projects to the documentation #1946 (rodoufu)
Assets 9
Loading

v2.2.0

09 Feb 17:56
@adambabik adambabik
v2.2.0
c961cad
Compare
Choose a tag to compare
v2.2.0

v2.2.0 (2021-02-09)

Full Changelog

Fixed bugs:

  • [protoc-gen-openapiv2] [BUG] Incorrect handling of non-wildcard google.api.http.body when using field_behaviour annotation #1937
  • Duplicate tags seen in Swagger Specification #1913
  • Poor error message when using message in path parameter #1863

Closed issues:

  • can we add HTTPStatusFromCode to mux? #1954
  • Missing types in generated gw.go file for C++ server #1942
  • What is the recommend way to bind 3rd party APIs (e.g. Health/Check to /healthzf #1931
  • Patch request with field_masks #1930
  • Working from the helloworld example but getting an error on HTTP requests: grpc: the client connection is closing. Would like to improve the docs. #1924
  • Action Required: Fix Renovate Configuration #1918
  • F #1917
  • Is any method to access the raw request body in metadata? #1908
  • Custom incoming header matcher isn't working as expected #1902
  • README.md links to https://pkg.go.dev/github.com/golang/protobuf/jsonpb which does not exist #1901
  • Is it possible to setup CORS? #1889

Merged pull requests:

Assets 9
Loading

v2.1.0

07 Jan 11:47
@johanbrandhorst johanbrandhorst
v2.1.0
c989b80
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.1.0

v2.1.0 (2021-01-07)

Full Changelog

Implemented enhancements:

  • protoc-gen-grpc-gateway: can't generate gateway stubs for multiple packages in one go #1612
  • Addition of Prettier GitHub action to prettified the markdown files #1575
  • add support for field_behavior options on swagger plugin #1806 (ewhauser)

Fixed bugs:

  • The "Use go templates" page is missing its actual go templates #1773
  • FieldMask Generation causes a 400 when a google.protobuf.Struct field has populated values #1570
  • Support openapiv2_tag option in swagger generator #690

Closed issues:

  • Ignore some fields in HTTP Response and OpenAPI #1886
  • Using runtime.WithMarshalerOption() breaks swagger docs #1882
  • Data is Getting Encoded while returning response as HTML #1880
  • jsonPB is not supporting in grpc gateway v2 migration #1878
  • Move generator and descriptor packages into the public API #1877
  • Add -module flag to protoc-gen-openapiv2 plugin #1876
  • Load Balancing with multiple instances of a grpc-server. #1875
  • Building with Bazel not compatible when using Gazelle and disable_global #1847
  • Unexpected response on /v2/example/errorwithdetails #1842
  • openapi_configuration option in protoc_gen_openapiv2 Bazel rule fails. #1838
  • Link to v2 migration guide broken #1836
  • add header in http.Handler,but not take effect #1835
  • protoc-gen-openapiv2 rule should expose all of the relevant flags available #1831
  • if there a flag set the metadata first letter not change to uppower #1830
  • Clarification about return Access-Control-Allow-Origin header #1827
  • generate\_unbound\_methods option and FieldMask fields don't work together. #1816
  • openapiv2: panic when SecurityRequirement is missing a value #1811
  • Cannot resolve import 'google/api/http.proto' #1809
  • add version information at compile-time #1803
  • 🚀 protoc\_gen\_openapiv2 should allow to pass generate\_unbound\_methods option #1792
  • Can't generate python client #1785
  • Issue with converting to the bytes data type #1781
  • Possible way to access request header key,value #1780
  • Run demo failed! #1777
  • protoc-gen-swagger: Implement Response Header(s) object, Implement Field Enum,Example&Format attributes #1729

Merged pull requests:

Read more
Assets 9
Loading

v1.16.0

28 Oct 10:30
@johanbrandhorst johanbrandhorst
v1.16.0
094a6fe
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.16.0

The grpc-gateway v1 is in maintenance mode, you are encouraged to migrate to v2. Check out our v2 migration guide.

v1.16.0 (2020-10-28)

Full Changelog

Merged pull requests:

  • feat: protoc-gen-swagger: Implement Response Header(s) object, Implem… #1730 (elijah-roberts)
Assets 9
Loading

v2.0.1

21 Oct 10:16
@johanbrandhorst johanbrandhorst
v2.0.1
5c1639c
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.1

v2.0.1 (2020-10-21)

Full Changelog

Closed issues:

  • why was swagger removed #1765
  • Option -module does not work anymore for protoc-gen-grpc-gateway v2 #1753
  • grpc-gateway_out Cannot set flag #1751

Merged pull requests:

Assets 9
Loading

v2.0.0

14 Oct 08:16
@johanbrandhorst johanbrandhorst
v2.0.0
75c0d83
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v2.0.0

The grpc-gateway maintainers are pleased to announce the long anticipated release of v2.0.0

v2.0.0 includes ground-up rewrites of many parts of the runtime and generators to be compatible with the Go APIv2 Protobuf release. To help transition users to v2, we've put together a migration guide. Among the notable changes in v2 are:

  • Support the Go APIv2 Protobuf stack
  • Many changes to make the grpc-gateway behaviour more consistent with Protobuf JSON conventions
  • Rename protoc-gen-swagger to protoc-gen-openapiv2
  • Minimize the public API
  • Consolidation of error handling configuration
  • Enable HTTPBodyMarshaler by default
  • Use the gRPC status JSON representation for errors
  • Much more!

For a complete list of all the changes, please see the full changelog.

Note that GOPATH users will no longer be supported with this release. This was not a decision taken lightly, but on balance we expect the community to have moved to modules, or be in a position to move to modules, and the maintenance burden is significant smaller for us. If this is a significant issue for your or your organization, please let us know on the Slack channel or by raising an issue.

Assets 9
Loading

v1.15.2

10 Oct 14:46
@johanbrandhorst johanbrandhorst
v1.15.2
90c3950
Compare
Choose a tag to compare
v1.15.2

The grpc-gateway v1 is in maintenance mode, you are encouraged to migrate to v2.

See #1223 for more information and check out our v2 migration guide.

v1.15.2 (2020-10-10)

Full Changelog

Assets 2
Loading

v1.15.1

10 Oct 14:44
@johanbrandhorst johanbrandhorst
v1.15.1
90c3950
Compare
Choose a tag to compare
v1.15.1

This will be the last release of v1 on the master branch

The grpc-gateway v1 is in maintenance mode, you are encouraged to migrate to v2.

See #1223 for more information and check out our v2 migration guide.

v1.15.1 (2020-10-10)

Full Changelog

Assets 9
Loading

v2.0.0-beta.5

24 Sep 12:53
@johanbrandhorst johanbrandhorst
v2.0.0-beta.5
462ce8c
Compare
Choose a tag to compare
v2.0.0-beta.5

We've got some really cool new features in this release:

  • New support for using YAML to annotate the generated swagger output. See the docs for more information. This was implemented by @jasonewang.
  • New support for generating a gateway for completely unannotated proto files. See the docs for more information. The was implemented by @plaflamme.

v2.0.0-beta.5 (2020-09-24)

Full Changelog

Closed issues:

  • Sending NULL for int64/uint64 types calls gRPC server with zero-value #1681
  • protoc-gen-swagger: allow -output dir #1679
  • Empty json array is passed as nil #1673
  • Lightweight support for custom protobuf annotations on RPCs #1666
  • undefined: runtime.ServerTransportStream #1664
  • Merge swagger definitions generated by swaggo/swag init and protoc --swagger_out command #1651
  • Add base_path as constant in generated gateway files #1650
  • Support service definitions without any annotations. #1649
  • proto directory names preclude using protos in python code #1647
  • Generated files contain calls to methods that don't exist #1643
  • TestConvertDuration/invalid_duration failure #1630
  • runtime.WithForwardResponseOption\(\) is not respected #1625
  • same field in params #1621
  • Use grpc gateway to create rest API whose body is a list #1617
  • grpc-gateway equivalent in the grpc python package #1613
  • Migrate away from importing github.com/golang/protobuf/{descriptor,proto} in generated code (similar to #1260). #1608
  • runtime.WithForwardResponseOption compile error #1607
  • Apply FiedMask to the GET (and LIST) returns #1605
  • code: 32603, message types.Coin is neither a v1 or v2 Message #1603
  • protoc-gen-swagger map type filed doesn't support options.openapiv2_field #1601
  • 🐛HttpRule is stated in unannotated_echo_service.yaml, but warning is still issued #1578
  • CVE-2020-14001: Unintended read access in kramdown gem #1579

Merged pull requests:

Read more
Assets 9
Loading

v1.15.0

18 Sep 10:33
@johanbrandhorst johanbrandhorst
v1.15.0
96e0d89
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.15.0

The grpc-gateway v1 is in maintenance mode, you are encouraged to migrate to v2.

See #1223 for more information and check out our v2 migration guide.

v1.15.0 (2020-09-18)

Full Changelog

New Features:

Closed issues:

  • Empty json array is passed as nil #1673
  • Lightweight support for custom protobuf annotations on RPCs #1666
  • undefined: runtime.ServerTransportStream #1664
  • Merge swagger definitions generated by swaggo/swag init and protoc --swagger_out command #1651
  • Add base_path as constant in generated gateway files #1650
  • Support service definitions without any annotations. #1649
  • proto directory names preclude using protos in python code #1647

Merged pull requests:

Assets 9
Loading