Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #719

Merged
merged 1 commit into from
Sep 16, 2022
Merged

Update docs #719

merged 1 commit into from
Sep 16, 2022

Conversation

renovate-bot
Copy link
Collaborator

Mend Renovate

This PR contains the following updates:

Package Type Update Change
github.com/grpc-ecosystem/grpc-gateway/v2 require minor v2.0.1 -> v2.11.3
go (source) golang minor 1.15 -> 1.19
google.golang.org/grpc/cmd/protoc-gen-go-grpc require minor v1.0.1 -> v1.2.0
google.golang.org/protobuf require minor v1.25.0 -> v1.28.1

Release Notes

grpc-ecosystem/grpc-gateway

v2.11.3

Compare Source

This release adds signed release binaries with SLSA signatures. Please see the README for more information.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.2...v2.11.3

v2.11.2

Compare Source

This fixes an issue with the openapiv2 generator if there is a colon in the verb, and updates the minimum supported Go version to Go 1.17.

What's Changed

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.1...v2.11.2

v2.11.1

Compare Source

This release fixes a crash in the grpc-gateway handling of requests containing invalid an Grpc-Timeout or Grpc-Metadata-Bin header (#​2822). It is strongly recommended that users upgrade both the runtime and generator versions.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.11.0...v2.11.1

v2.11.0

Compare Source

What's Changed
New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.3...v2.11.0

v2.10.3

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.2...v2.10.3

v2.10.2

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.1...v2.10.2

v2.10.1

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.10.0...v2.10.1

v2.10.0

Compare Source

This release contains a new annotation that allows you to configure the path parameter names generated in your swagger.json, which can be useful in some circumstances. Please see https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#path-parameters for documentation on how to use this new capability.

Note that in order to take advantage of the new annotation, you will need to update your vendored dependency, or update your buf.build/grpc-ecosystem/grpc-gateway dependency to at least f85c60ac38544f2d8f346491c9d916e5. This can be accomplished by running buf mod update in the folder where you have your buf.yaml.

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.9.0...v2.10.0

v2.9.0

Compare Source

This release adds the ability to filter properties (Services, RPCs, Fields, Enum values) from being rendered in the OpenAPI v2 spec generated by protoc-gen-openapiv2. See https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#hiding-fields-methods-services-and-enum-values for more information about this new exciting capability!

Other new features:

  • A new option to generate the OpenAPI v2 spec in YAML format
  • Allow serving a health endpoint at an arbitrary path with the new WithHealthEndpointAt ServeMux option

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.8.0...v2.9.0

v2.8.0

Compare Source

Overview

This release introduces the new WithHealthzEndpoint which makes it easy to forward your gRPC health check endpoint to your gRPC-gateway server, and fixes a long standing bug in protoc-gen-openapiv2 where path parameters were included in both the path and the body of the generated spec (#​1670 and #​1015).

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.3...v2.8.0

v2.7.3

Compare Source

What's Changed
New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.2...v2.7.3

v2.7.2

Compare Source

What's Changed
New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.1...v2.7.2

v2.7.1

Compare Source

What's Changed
New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.7.0...v2.7.1

v2.7.0

Compare Source

What's Changed

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.6.0...v2.7.0

v2.6.0

Compare Source

Changes in this release

Major features in this release include:

As well as various bug fixes, including the auto generation of the Www-Authenticate header when returning an 401 Unauthorized error (#​2314), better google.protobuf.Any representation in openapiv2 files (#​2292) and much more.

This is also the first release to automatically publish the Protobuf plugins to the Buf Schema Registry. See https://buf.build/grpc-ecosystem/plugins. These can be used together with the new buf generate remote plugins feature: https://docs.buf.build/configuration/v1/buf-gen-yaml#name-or-remote. An example buf.gen.yaml using these new plugins looks like this:

version: v1
plugins:
  - remote: buf.build/library/plugins/go:v1.27.1-1
    out: gen/go
    opt: paths=source_relative
  - remote: buf.build/library/plugins/go-grpc:v1.1.0-2
    out: gen/go
    opt: paths=source_relative
  - remote: buf.build/grpc-ecosystem/plugins/grpc-gateway:v2.6.0-1
    out: gen/go
    opt: paths=source_relative
  - remote: buf.build/grpc-ecosystem/plugins/openapiv2:v2.6.0-1
    out: gen/openapiv2

v2.5.0

Compare Source

Changes in this release

This release adds support for extracting the HTTP path for an incoming request through the request context. Thanks to @​0daryo for the contribution!

Note that this release slightly changes the behavior of the generator, so you must ensure that you are using the new version of the runtime library after updating the generator to this new version.

v2.4.0

Compare Source

This release adds support for customizing routing error HTTP status codes. Thanks to @​electrofelix for the contribution!

Other changes

New Contributors

Full Changelog: grpc-ecosystem/grpc-gateway@v2.3.0...v2.4.0

v2.3.0

Compare Source

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:

v2.2.0

Compare Source

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:

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

  • If you want to rebase/retry this PR, click this checkbox.

This PR has been generated by Mend Renovate. View repository job log here.

@andrewpollock
Copy link
Contributor

/gcbrun

@oliverchang oliverchang merged commit 7d35236 into google:master Sep 16, 2022
@renovate-bot renovate-bot deleted the renovate/docs branch September 16, 2022 05:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliverchang oliverchang oliverchang approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@renovate-bot @andrewpollock @oliverchang