Releases: grpc-ecosystem/grpc-gateway
Releases · grpc-ecosystem/grpc-gateway
v2.2.0
v2.2.0 (2021-02-09)
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:
- Add documenation for standalone gateway generation #1955 (dgparker)
- Update google.golang.org/genproto commit hash to bba0dbe (master) #1953 (renovate[bot])
- Make fieldmask parser output deterministic #1950 (johanbrandhorst)
- Update golang Docker tag to v1.15.8 (master) #1949 (renovate[bot])
- Fix verb parsing #1947 (jefferai)
- Update google.golang.org/genproto commit hash to deb8283 (master) #1945 (renovate[bot])
- Fix malformed Schema Reference during field_behavior generation #1944 (gganley)
- Update dependency com_github_bazelbuild_buildtools to v4 (master) #1939 (renovate[bot])
- Update google.golang.org/genproto commit hash to 3206188 (master) #1936 (renovate[bot])
- Update google.golang.org/genproto commit hash to 646a494 (master) #1934 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to 0101308 (master) #1933 (renovate[bot])
- Update google.golang.org/genproto commit hash to 94839c0 (master) #1932 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to f9ce19e (master) #1928 (renovate[bot])
- Update rules_proto commit hash to a0761ed (master) #1927 (renovate[bot])
- Update google.golang.org/genproto commit hash to 44e461b (master) #1926 (renovate[bot])
- Update google.golang.org/genproto commit hash to f46fe6c (master) #1923 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to af13f52 (master) #1922 (renovate[bot])
- Multiple repeated fields are allowed #1921 (topherCantrell)
- Update google.golang.org/genproto commit hash to 8081c04 (master) #1920 (renovate[bot])
- Update google.golang.org/genproto commit hash to fc48d45 (master) #1919 (renovate[bot])
- Update google.golang.org/genproto commit hash to f5e8c5e (master) #1915 (renovate[bot])
- Update golang Docker tag to v1.15.7 (master) #1912 (renovate[bot])
- Update google.golang.org/genproto commit hash to e258113 (master) #1910 (renovate[bot])
- Update docs for bug fix and expanding HTTP status codes in Customizing your gateway #1907 (bconway)
- Update rules_proto commit hash to cfdc2fa (master) #1906 (renovate[bot])
- Remove jsonpb reference #1904 (johanbrandhorst)
- Update google.golang.org/genproto commit hash to 6edceaf (master) #1903 (renovate[bot])
- Update module google.golang.org/grpc to v1.35.0 (master) #1899 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to d3ed898 (master) #1898 (renovate[bot])
- Update google.golang.org/genproto commit hash to ae06605 (master) #1897 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to 8b1d76f (master) #1896 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to 01de73c (master) #1895 (renovate[bot])
- Reworked Error message in newParam() in services.go #1894 (gunadhya)
- Update google.golang.org/genproto commit hash to 22ae2b1 (master) #1893 (renovate[bot])
- Update module google.golang.org/grpc to v1.34.1 (master) #1891 (renovate[bot])
- Update google.golang.org/genproto commit hash to c7d5778 (master) #1890 (renovate[bot])
- Update google.golang.org/genproto commit hash to ffc7fda (master) #1888 (renovate[bot])
v2.1.0
v2.1.0 (2021-01-07)
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 passgenerate\_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:
- Update google.golang.org/genproto commit hash to 07624b5 (master) #1885 (renovate[bot])
- Add a ## Docs section to highlight the docs URL #1884 (VinGarcia)
- Fix broken 'Field Mask' documentation link #1883 (adolfo)
- Update google.golang.org/genproto commit hash to 8c77b98 (master) #1874 (renovate[bot])
- Fix link to "gRPC API configuration" in README #1873 (alpire)
- Update google.golang.org/genproto commit hash to 40ec1c2 (master) #1872 (renovate[bot])
- Update google.golang.org/genproto commit hash to e3217be (master) #1870 (renovate[bot])
- Update google.golang.org/genproto commit hash to f927205 (master) #1869 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to 08078c5 (master) #1867 (renovate[bot])
- protoc-gen-openapiv2: Add openapiv2_tag support #1866 (rcgoodfellow)
- Update golang.org/x/oauth2 commit hash to 9317641 (master) #1864 (renovate[bot])
- Update google.golang.org/genproto commit hash to 9ee31aa (master) #1862 (renovate[bot])
- Update Season of Docs page #1861 (johanbrandhorst)
- Refactored the documentation files of gRPC-Gateway #1860 (iamrajiv)
- Update google.golang.org/genproto commit hash to 06b3db8 (master) #1858 (renovate[bot])
- Update golang Docker tag to v1.15.6 (master) #1857 (renovate[bot])
- Update google.golang.org/genproto commit hash to 6486ece (master) #1854 (renovate[bot])
- Update golang.org/x/oauth2 commit hash to 0b49973 (master) #1853 (renovate[bot])
- Update module google.golang.org/grpc to v1.34.0 (master) #1852 (renovate[bot])
- [GSoD] Refactored the documentation files of gRPC-Gateway #1851 (iamrajiv)
- Update google.golang.org/genproto commit hash to 55d61f9 (master) #1850 (renovate[bot])
- Update rules_proto commit hash to 84ba6ec (master) #1849 (renovate[bot])
- Update google.golang.org/genproto commit hash to b05cb90 (master) #1846 (renovate[bot])
- [GSoD] Added new architecture introduction diagram for gRPC-Gateway #1845 (iamrajiv)
- [GSoD] Added more faq for gRPC-Gateway #1844 (iamrajiv)
- Fix broken example #1843 (isbang)
- Feature/implement response headers v2 #1841 (elijah-roberts)
- Update module google/go-cmp to v0.5.4 (master) #1840 (renovate[bot])
- Fix some broken docs links #1839 (johanbrandhorst)
- Sets proper context property for openapi_configuration option #1837 (zoido)
- Adjust protoc-gen-openapiv2/main.go flags docs as suggested during #1832 review #1833 (zoido)
- Rest protoc-gen-openapiv2 flags as rule attrs #1832 (zoido)
- [GSoD] Added tutorials directo...
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)
Merged pull requests:
- feat: protoc-gen-swagger: Implement Response Header(s) object, Implem… #1730 (elijah-roberts)
v2.0.1
v2.0.1 (2020-10-21)
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:
- Update module google.golang.org/grpc to v1.33.1 (master) #1768 (renovate[bot])
- Update google.golang.org/genproto commit hash to 1ed22bb (master) #1764 (renovate[bot])
- Update dependency io_bazel_rules_go to v0.24.4 (master) #1762 (renovate[bot])
- Update google.golang.org/genproto commit hash to 32ed001 (master) #1761 (renovate[bot])
- Update module golang/protobuf to v1.4.3 (master) #1760 (renovate[bot])
- Update golang Docker tag to v1.15.3 (master) #1759 (renovate[bot])
- fix import alias issue with protoc-gen-grpc-gateway #1757 (danielhochman)
- Refactor registry and generator to use protogen #1756 (adambabik)
- Adapt usage instructions to use protoc-gen-go-grpc #1755 (olivierlemasle)
- Fix -module option for protoc-gen-grpc-gateway #1754 (olivierlemasle)
- fix empty parameter fatal in protoc-gen-grpc-gateway #1752 (danielhochman)
- Update google.golang.org/genproto commit hash to 03b6142 (master) #1750 (renovate[bot])
- Update Readme + remove duplicated paragraph #1749 (olivierlemasle)
- Update gorelease base for master #1747 (johanbrandhorst)
- Update google.golang.org/genproto commit hash to 7f9ee70 (master) #1745 (renovate[bot])
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.
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)
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)
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)
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:
- Update dependency com_github_bazelbuild_buildtools to v3.5.0 (v2) #1690 (renovate[bot])
- Update google.golang.org/genproto commit hash to 5646d36 (v2) #1688 (renovate[bot])
- Add devcontainer.json #1687 (johanbrandhorst)
- Update dependency io_bazel_rules_go to v0.24.3 (v2) #1686 (renovate[bot])
- Update dependency bazel_gazelle to v0.22.1 (v2) #1685 (renovate[bot])
- Support generating unbound methods #1684 (johanbrandhorst)
- Update google.golang.org/genproto commit hash to b9da36f (v2) #1682 (renovate[bot])
- Fix link in migration doc #1678 (johanbrandhorst)
- Update google.golang.org/genproto commit hash to d0d6055 (v2) #1677 (renovate[bot])
- Update google.golang.org/genproto commit hash to bb4cff5 (v2) #1674 (renovate[bot])
- Update google.golang.org/genproto commit hash to f6a2fa7 (v2) #1672 (renovate[bot])
- Update google.golang.org/genproto commit hash to 9f80d06 (v2) #1671 (renovate[bot])
- Update google.golang.org/genproto commit hash to 75d14da (v2) #1669 (renovate[bot])
- refactor: upgrade protoc-gen-grpc-gateway to use the new Go code generator #1668 (adambabik)
- End default swagger response desc with period - v2 #1667 (rubda)
- Add support for OpenAPI YAML annotations #1665 (jasonewang)
- Update google.golang.org/genproto commit hash to 645f7a4 (v2) #1662 (renovate[bot])
- Update google.golang.org/genproto commit hash to 8ad3c7e (v2) #1661 (renovate[bot])
- Update golang Docker tag to v1.15.2 (v2) #1658 (renovate[bot])
- Update dependency io_bazel_rules_go to v0.24.2 (v2) #1656 (renovate[bot])
- Update module google.golang.org/grpc to v1.32.0 (v2) #1654 (renovate[bot])
- Update google.golang.org/genproto commit hash to 0bd0a95 (v2) #1648 (renovate[bot])
- Update dependency bazel_gazelle to v0.22.0 (v2) #1622 (renovate[bot])
- Update golang.org/x/oauth2 #1645 (johanbrandhorst)
- Update google.golang.org/genproto commit hash to 9bfcb51 (v2) #1642 (renovate[bot])
- fix SendHeader/SetTrailer when use grpc-gateway standalone server (v2) #1638 (ghostiam)
- Change example field #1636 (johanbrandhorst)
- Update golang Docker tag to v1.15.1 (v2) #1635 (renovate[bot])
- Update dependency io_bazel_rules_go to v0.24.1 (v2) #1633 (renovate[bot])
- Update google.golang.org/genproto commit hash to b3bf27a (v2) #1632 (renovate[bot])
- Update google.golang.org/genproto commit hash to d751682 (v2) #1629 (renovate[bot])
- Update google.golang.org/genproto commit hash to 2bf3329 (v2) #1626 (renovate[bot])
- Update google.golang.org/genproto commit hash to 73b5761 (v2) #1624 (renovate[bot])
- Update dependency io_bazel_rules_go to v0.24.0 (v2) #1623 (renovate[bot])
- Update google.golang.org/genproto commit hash to ac2560b (v2) #1620 (renovate[bot])
- Update dependency bazel_skylib to v1.0.3 (v2) [#1619](https://github.c...
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)
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:
- Regenerate files #1676 (johanbrandhorst)
- End default response desc with period #1663 (rubda)
- Update golang Docker tag to v1.15.2 (master) #1657 (renovate[bot])
- Update module google.golang.org/grpc to v1.32.0 (master) #1653 (renovate[bot])
- Deprecate example field #1637 (johanbrandhorst)
v1.14.8
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.14.8 (2020-09-03)
Closed issues:
- 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
Merged pull requests:
- Add ignore for golang.org/x/oauth2 #1644 (johanbrandhorst)
- fix SendHeader/SetTrailer when use grpc-gateway standalone server (master) #1639 (ghostiam)
- Update golang Docker tag to v1.15.1 (master) #1634 (renovate[bot])
- runtime: fix duration test #1631 (johanbrandhorst)
- Update dependency bazel_skylib to v1.0.3 (master) #1618 (renovate[bot])
- Update module google.golang.org/grpc to v1.31.1 (master) #1614 (renovate[bot])
- Control warning behavior on unbound methods using a flag #1606 (yousseftelda)
- protoc-gen-swagger: fix map field options (#1601) #1602 (yangxikun)
- protoc-gen-swagger: remove boolean format #1597 (algas)
- document optional swagger plugin for unannotated grpc_api_configuration #1588 (piengeng)