Add `WithHealthzEndpoint` as `ServeMuxOption` to register a `/healthz`endpoint #2319

brumhard · 2021-08-31T09:23:01Z

References to other Issues or PRs

Brief description of what is fixed or changed

This PR adds a WithHealthzEndpoint as ServeMuxOption to runtime.NewServeMux().
It registers a /healthz route in the resulting ServeMux that forwards each request to the backing grpc server's health check endpoint.
Like this it's possible to check the whole system's health from the grpc-gateway instead of checking the gateway and grpc server on their own.
This is especially useful if you only expose the grpc-gateway.

google-cla · 2021-08-31T09:23:12Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-31T09:33:41Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-31T09:34:27Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-08-31T09:34:57Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

johanbrandhorst

This is a really fantastic contribution, even includes a doc update, I'm very impressed! I just had one tiny nit for the tests but it's otherwise good to go! Make sure you run the commands in CONTRIBUTING.md and sign the CLA so we can merge this :).

runtime/mux_test.go

google-cla · 2021-09-01T05:51:59Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

google-cla · 2021-09-01T06:10:23Z

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

What to do if you already signed the CLA

Individual signers

It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

codecov-commenter · 2021-09-01T06:16:25Z

Codecov Report

Merging #2319 (445428d) into master (77176e3) will increase coverage by 0.25%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #2319      +/-   ##
==========================================
+ Coverage   59.64%   59.90%   +0.25%     
==========================================
  Files          35       35              
  Lines        4500     4524      +24     
==========================================
+ Hits         2684     2710      +26     
+ Misses       1525     1523       -2     
  Partials      291      291

Impacted Files	Coverage Δ
runtime/mux.go	`70.13% <100.00%> (+5.97%)`	⬆️
runtime/errors.go	`57.95% <0.00%> (+2.27%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dbe2d42...445428d. Read the comment docs.

brumhard · 2021-09-01T06:18:17Z

Hi there. I'm really glad that you like my contribution. Sadly I'll have to wait a bit for my employer to get ready with the CLA, but I will update as soon as it works.
Also I ran the commands you mentioned and noticed that the github packages link is a bit outdated.

I would change the following

docker run -v $(pwd):/src/grpc-gateway --rm docker.pkg.github.com/grpc-ecosystem/grpc-gateway/build-env:1.16 \
    /bin/bash -c 'cd /src/grpc-gateway && \
        make install && \
        make clean && \
        make generate'

to

docker run -v $(pwd):/grpc-gateway -w /grpc-gateway --rm ghcr.io/grpc-ecosystem/grpc-gateway/build-env:1.16 \
    /bin/bash -c 'make install && \
        make clean && \
        make generate'

and also update the link to point to the container registry instead of the outdated docker registry.
Should I do this in this PR or are there reasons that you stick to the docker registry for now?

johanbrandhorst · 2021-09-03T00:15:36Z

Should I do this in this PR or are there reasons that you stick to the docker registry for now?

Please make a separate PR for this, but I would much appreciate that fix!

johanbrandhorst · 2021-09-03T02:31:17Z

Should I do this in this PR or are there reasons that you stick to the docker registry for now?

Please make a separate PR for this, but I would much appreciate that fix!

Nevermind, I went and added these changes to #2320

stale · 2021-11-16T12:34:23Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

brumhard · 2021-11-17T09:39:40Z

Hi there, sadly I'm still waiting for my company to sign the CLA. I'll update the PR asap, but not sure how long it will take.

johanbrandhorst · 2021-11-17T12:52:55Z

That's okay, thanks for the update!

lovromazgon · 2021-12-23T13:08:09Z

@brumhard any update on the CLA? I'd love to see this merged, it would be very useful!

brumhard · 2021-12-23T13:37:21Z

Hi @lovromazgon, sadly no. I'll ask again right after the holidays and make sure that it gets merged asap :)

brumhard · 2022-03-01T07:33:36Z

@googlebot I signed it!

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

brumhard · 2022-03-01T08:43:51Z

So finally the CLA is signed, just took 6 months 🕺🏻

johanbrandhorst · 2022-03-02T03:56:13Z

runtime/mux.go

+func WithHealthzEndpoint(conn grpc.ClientConnInterface) ServeMuxOption {
+	healthCheckClient := grpc_health_v1.NewHealthClient(conn)


I know I've already reviewed this, but now that I'm looking at it, wouldn't it make more sense for this parameter to be an instantiation of the health client? That way it'll be easier to test and the user can decide how to dial the client.

Suggested change

func WithHealthzEndpoint(conn grpc.ClientConnInterface) ServeMuxOption {

healthCheckClient := grpc_health_v1.NewHealthClient(conn)

func WithHealthzEndpoint(healthCheckClient grpc_health_v1.HealthClient) ServeMuxOption {

Sure I can definitely change that 👍🏻

That was a really nice hint, feels much cleaner now. I was not sure if you are using any mocking framework and couldn't find one, so I kept the fake approach.

Signed-off-by: Tobias Brumhard <tobias.brumhard@mail.schwarz>

johanbrandhorst

LGTM

johanbrandhorst · 2022-03-02T14:05:42Z

Thank you for your contribution! This is a great new feature.

johanbrandhorst · 2022-03-02T17:58:47Z

This was released in https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.8.0!

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/grpc-ecosystem/grpc-gateway/v2](https://github.com/grpc-ecosystem/grpc-gateway) | require | minor | `v2.0.1` -> `v2.11.3` | | [go](https://go.dev/) ([source](https://github.com/golang/go)) | golang | minor | `1.15` -> `1.19` | | [google.golang.org/grpc/cmd/protoc-gen-go-grpc](https://github.com/grpc/grpc-go) | require | minor | `v1.0.1` -> `v1.2.0` | | [google.golang.org/protobuf](https://github.com/protocolbuffers/protobuf-go) | require | minor | `v1.25.0` -> `v1.28.1` | --- ### Release Notes <details> <summary>grpc-ecosystem/grpc-gateway</summary> ### [`v2.11.3`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.11.3) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.11.2...v2.11.3) This release adds signed release binaries with SLSA signatures. Please see the [README](https://github.com/grpc-ecosystem/grpc-gateway#download-the-binaries) for more information. #### What's Changed - fix: unnecessary -e arg for echo command in dockerfile by [@MakDon](https://github.com/MakDon) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2840](https://github.com/grpc-ecosystem/grpc-gateway/pull/2840) - Fix identifiers generated from snake-cased enums not matching pb.go definitions by [@jbaxx](https://github.com/jbaxx) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2826](https://github.com/grpc-ecosystem/grpc-gateway/pull/2826) - switch ci build env version to 1.19 by [@MakDon](https://github.com/MakDon) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2845](https://github.com/grpc-ecosystem/grpc-gateway/pull/2845) - Signed release binaries with SLSA signatures by [@laurentsimon](https://github.com/laurentsimon) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2847](https://github.com/grpc-ecosystem/grpc-gateway/pull/2847) - protoc-gen-openapiv2 generating the wrong schema fixing the issue [#2635](https://github.com/grpc-ecosystem/grpc-gateway/issues/2635) by [@lakshkeswani](https://github.com/lakshkeswani) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2854](https://github.com/grpc-ecosystem/grpc-gateway/pull/2854) #### New Contributors - [@jbaxx](https://github.com/jbaxx) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2826](https://github.com/grpc-ecosystem/grpc-gateway/pull/2826) - [@laurentsimon](https://github.com/laurentsimon) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2847](https://github.com/grpc-ecosystem/grpc-gateway/pull/2847) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.11.2...v2.11.3 ### [`v2.11.2`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.11.2) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.11.1...v2.11.2) 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 - Fix openapiv2 path parameter parsing when colon in verb by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2825](https://github.com/grpc-ecosystem/grpc-gateway/pull/2825) - Update minimum supported Go version to 1.17 by [@renovate](https://github.com/renovate) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2831](https://github.com/grpc-ecosystem/grpc-gateway/pull/2831) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.11.1...v2.11.2 ### [`v2.11.1`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.11.1) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.11.0...v2.11.1) This release fixes a crash in the grpc-gateway handling of requests containing invalid an `Grpc-Timeout` or `Grpc-Metadata-Bin` header ([#2822](https://github.com/grpc-ecosystem/grpc-gateway/issues/2822)). It is strongly recommended that users upgrade both the runtime and generator versions. #### What's Changed - Default allow_repeated_fields_in_body option to true and deprecate option by [@armsnyder](https://github.com/armsnyder) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2813](https://github.com/grpc-ecosystem/grpc-gateway/pull/2813) - Fix timeout panic by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2823](https://github.com/grpc-ecosystem/grpc-gateway/pull/2823) #### New Contributors - [@armsnyder](https://github.com/armsnyder) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2813](https://github.com/grpc-ecosystem/grpc-gateway/pull/2813) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.11.0...v2.11.1 ### [`v2.11.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.11.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.3...v2.11.0) ##### What's Changed - Set fetch depth for renovate actions by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2741](https://github.com/grpc-ecosystem/grpc-gateway/pull/2741) - openapiv2: Field options are properly rendered for repeated fields [#2531](https://github.com/grpc-ecosystem/grpc-gateway/issues/2531) by [@lakshkeswani](https://github.com/lakshkeswani) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2742](https://github.com/grpc-ecosystem/grpc-gateway/pull/2742) - Set version for gorelease by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2749](https://github.com/grpc-ecosystem/grpc-gateway/pull/2749) - Disable renovate on v1 by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2781](https://github.com/grpc-ecosystem/grpc-gateway/pull/2781) - feat: add support for oneof fields in request bodies by [@aesadde](https://github.com/aesadde) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2739](https://github.com/grpc-ecosystem/grpc-gateway/pull/2739) - Bugfix/issue 2681 by [@olegvelikanov](https://github.com/olegvelikanov) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2773](https://github.com/grpc-ecosystem/grpc-gateway/pull/2773) - chore: Included githubactions in the dependabot config by [@naveensrinivasan](https://github.com/naveensrinivasan) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2673](https://github.com/grpc-ecosystem/grpc-gateway/pull/2673) - Change renovate branch trigger by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2791](https://github.com/grpc-ecosystem/grpc-gateway/pull/2791) - fix: extensions in YAML format \[[#2795](https://github.com/grpc-ecosystem/grpc-gateway/issues/2795)] by [@hedhyw](https://github.com/hedhyw) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2797](https://github.com/grpc-ecosystem/grpc-gateway/pull/2797) - fix: yaml indent \[[#2645](https://github.com/grpc-ecosystem/grpc-gateway/issues/2645)] by [@hedhyw](https://github.com/hedhyw) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2801](https://github.com/grpc-ecosystem/grpc-gateway/pull/2801) - Fix buf plugin's library version by [@AlmogBaku](https://github.com/AlmogBaku) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2800](https://github.com/grpc-ecosystem/grpc-gateway/pull/2800) ##### New Contributors - [@lakshkeswani](https://github.com/lakshkeswani) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2742](https://github.com/grpc-ecosystem/grpc-gateway/pull/2742) - [@aesadde](https://github.com/aesadde) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2739](https://github.com/grpc-ecosystem/grpc-gateway/pull/2739) - [@olegvelikanov](https://github.com/olegvelikanov) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2773](https://github.com/grpc-ecosystem/grpc-gateway/pull/2773) - [@AlmogBaku](https://github.com/AlmogBaku) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2800](https://github.com/grpc-ecosystem/grpc-gateway/pull/2800) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.3...v2.11.0 ### [`v2.10.3`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.10.3) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.2...v2.10.3) #### What's Changed - protoc-gen-openapiv2: Fix schema types for `Value` and `Empty` well-known types by [@haines](https://github.com/haines) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2719](https://github.com/grpc-ecosystem/grpc-gateway/pull/2719) - Use custom token secret for pushes by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2725](https://github.com/grpc-ecosystem/grpc-gateway/pull/2725) - chore: renovate bot setting to pin actions to a full length commit SHA by [@naveensrinivasan](https://github.com/naveensrinivasan) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2724](https://github.com/grpc-ecosystem/grpc-gateway/pull/2724) - protoc-gen-openapiv2: Support all HTTP methods supported in OpenAPI v2 by [@mnito](https://github.com/mnito) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2726](https://github.com/grpc-ecosystem/grpc-gateway/pull/2726) - Fix overriding path parameter with custom verbs by [@oyvindwe](https://github.com/oyvindwe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2727](https://github.com/grpc-ecosystem/grpc-gateway/pull/2727) - Update git push to use full username by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2732](https://github.com/grpc-ecosystem/grpc-gateway/pull/2732) - Lets try using the checkout token setting by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2733](https://github.com/grpc-ecosystem/grpc-gateway/pull/2733) - Add old style build tag by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2734](https://github.com/grpc-ecosystem/grpc-gateway/pull/2734) - Update gopkg.in/yaml.v3 by [@sousandrei](https://github.com/sousandrei) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2729](https://github.com/grpc-ecosystem/grpc-gateway/pull/2729) #### New Contributors - [@haines](https://github.com/haines) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2719](https://github.com/grpc-ecosystem/grpc-gateway/pull/2719) - [@sousandrei](https://github.com/sousandrei) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2729](https://github.com/grpc-ecosystem/grpc-gateway/pull/2729) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.2...v2.10.3 ### [`v2.10.2`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.10.2) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.1...v2.10.2) #### What's Changed - Fix node tests by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2704](https://github.com/grpc-ecosystem/grpc-gateway/pull/2704) - Fix panic in parsing null time/duration in query by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2703](https://github.com/grpc-ecosystem/grpc-gateway/pull/2703) - Migrate to Github Actions by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2700](https://github.com/grpc-ecosystem/grpc-gateway/pull/2700) - Add protobuf and grpc runtime versions to buf plugins by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2702](https://github.com/grpc-ecosystem/grpc-gateway/pull/2702) - Fix readme display error by [@lanlyhs](https://github.com/lanlyhs) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2706](https://github.com/grpc-ecosystem/grpc-gateway/pull/2706) - openapiv2: fix comment by [@kurochan](https://github.com/kurochan) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2701](https://github.com/grpc-ecosystem/grpc-gateway/pull/2701) #### New Contributors - [@lanlyhs](https://github.com/lanlyhs) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2706](https://github.com/grpc-ecosystem/grpc-gateway/pull/2706) - [@kurochan](https://github.com/kurochan) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2701](https://github.com/grpc-ecosystem/grpc-gateway/pull/2701) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.1...v2.10.2 ### [`v2.10.1`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.10.1) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.0...v2.10.1) #### What's Changed - protoc-gen-openapiv2: Use the canonical camelCase converter for protobuf by [@oyvindwe](https://github.com/oyvindwe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2599](https://github.com/grpc-ecosystem/grpc-gateway/pull/2599) - Revert gazelle dependency to original repository by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2605](https://github.com/grpc-ecosystem/grpc-gateway/pull/2605) - Use Bytes from convert.go to unmarshal byte value by [@HubertZhang](https://github.com/HubertZhang) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2603](https://github.com/grpc-ecosystem/grpc-gateway/pull/2603) - correct generate field mask for google.protobuf.struct field by [@marsianin](https://github.com/marsianin) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2619](https://github.com/grpc-ecosystem/grpc-gateway/pull/2619) - Update golangci-lint to 1.45 for Go 1.18 support by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2631](https://github.com/grpc-ecosystem/grpc-gateway/pull/2631) - Turn on dependabot updates for documentation by [@achew22](https://github.com/achew22) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2604](https://github.com/grpc-ecosystem/grpc-gateway/pull/2604) - build(deps-dev): bump github-pages from 209 to 225 in /docs by [@dependabot](https://github.com/dependabot) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2633](https://github.com/grpc-ecosystem/grpc-gateway/pull/2633) - support google.protobuf.Value by [@wclssdn](https://github.com/wclssdn) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2628](https://github.com/grpc-ecosystem/grpc-gateway/pull/2628) - fix: Correct typos in error messages from loading OpenAPI Configuration by [@joonas](https://github.com/joonas) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2636](https://github.com/grpc-ecosystem/grpc-gateway/pull/2636) - Set permissions for GitHub actions by [@naveensrinivasan](https://github.com/naveensrinivasan) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2641](https://github.com/grpc-ecosystem/grpc-gateway/pull/2641) - Field and schema extensions by [@james-o-johnstone](https://github.com/james-o-johnstone) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2418](https://github.com/grpc-ecosystem/grpc-gateway/pull/2418) - chore(deps): update dependency com_github_bazelbuild_buildtools to v5.1.0 (master) by [@renovate](https://github.com/renovate) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2645](https://github.com/grpc-ecosystem/grpc-gateway/pull/2645) - fix(deps): update google.golang.org/genproto digest to [`2d67ff6`](https://github.com/grpc-ecosystem/grpc-gateway/commit/2d67ff6) (master) by [@renovate](https://github.com/renovate) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2646](https://github.com/grpc-ecosystem/grpc-gateway/pull/2646) - Format protobuf files with buf by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2650](https://github.com/grpc-ecosystem/grpc-gateway/pull/2650) - build(deps): bump nokogiri from 1.13.3 to 1.13.4 in /docs by [@dependabot](https://github.com/dependabot) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2638](https://github.com/grpc-ecosystem/grpc-gateway/pull/2638) - Add git blame ignore by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2652](https://github.com/grpc-ecosystem/grpc-gateway/pull/2652) - Export `defaultQueryParser` struct for custom query parsers by [@MikeSouza](https://github.com/MikeSouza) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2651](https://github.com/grpc-ecosystem/grpc-gateway/pull/2651) - Fix typo in "uannotated" file links by [@srowles](https://github.com/srowles) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2658](https://github.com/grpc-ecosystem/grpc-gateway/pull/2658) - fix: Content-Type and Grpc-Metadata-Content-Type headers with the health endpoint by [@GreyXor](https://github.com/GreyXor) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2634](https://github.com/grpc-ecosystem/grpc-gateway/pull/2634) - protoc-gen-openapiv2: Remove path parameters from body when body is a snake_case field by [@oyvindwe](https://github.com/oyvindwe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2600](https://github.com/grpc-ecosystem/grpc-gateway/pull/2600) - Fixed \[]byte unmarshaling for non proto structs by [@gknw](https://github.com/gknw) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2693](https://github.com/grpc-ecosystem/grpc-gateway/pull/2693) - protoc-gen-openapiv2: Document and warn about path parameters containing "/" by [@oyvindwe](https://github.com/oyvindwe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2697](https://github.com/grpc-ecosystem/grpc-gateway/pull/2697) #### New Contributors - [@HubertZhang](https://github.com/HubertZhang) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2603](https://github.com/grpc-ecosystem/grpc-gateway/pull/2603) - [@marsianin](https://github.com/marsianin) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2619](https://github.com/grpc-ecosystem/grpc-gateway/pull/2619) - [@wclssdn](https://github.com/wclssdn) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2628](https://github.com/grpc-ecosystem/grpc-gateway/pull/2628) - [@joonas](https://github.com/joonas) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2636](https://github.com/grpc-ecosystem/grpc-gateway/pull/2636) - [@naveensrinivasan](https://github.com/naveensrinivasan) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2641](https://github.com/grpc-ecosystem/grpc-gateway/pull/2641) - [@james-o-johnstone](https://github.com/james-o-johnstone) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2418](https://github.com/grpc-ecosystem/grpc-gateway/pull/2418) - [@MikeSouza](https://github.com/MikeSouza) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2651](https://github.com/grpc-ecosystem/grpc-gateway/pull/2651) - [@srowles](https://github.com/srowles) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2658](https://github.com/grpc-ecosystem/grpc-gateway/pull/2658) - [@GreyXor](https://github.com/GreyXor) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2634](https://github.com/grpc-ecosystem/grpc-gateway/pull/2634) - [@gknw](https://github.com/gknw) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2693](https://github.com/grpc-ecosystem/grpc-gateway/pull/2693) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.10.0...v2.10.1 ### [`v2.10.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.10.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.9.0...v2.10.0) 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](https://buf.build/grpc-ecosystem/grpc-gateway/tree/f85c60ac38544f2d8f346491c9d916e5). This can be accomplished by running `buf mod update` in the folder where you have your `buf.yaml`. #### What's Changed - Add delimiter after response stream error message ([#2591](https://github.com/grpc-ecosystem/grpc-gateway/issues/2591)) by [@stelcodes](https://github.com/stelcodes) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2596](https://github.com/grpc-ecosystem/grpc-gateway/pull/2596) - protoc-gen-openapiv2: support overriding path parameter names by [@oyvindwe](https://github.com/oyvindwe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2562](https://github.com/grpc-ecosystem/grpc-gateway/pull/2562) #### New Contributors - [@stelcodes](https://github.com/stelcodes) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2596](https://github.com/grpc-ecosystem/grpc-gateway/pull/2596) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.9.0...v2.10.0 ### [`v2.9.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.9.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.8.0...v2.9.0) 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 - Annotate incoming and outgoing context by [@rogchap](https://github.com/rogchap) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2574](https://github.com/grpc-ecosystem/grpc-gateway/pull/2574) - protoc-gen-openapiv2: support YAML OpenAPI/Swagger v2 definition generation by [@hedhyw](https://github.com/hedhyw) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2579](https://github.com/grpc-ecosystem/grpc-gateway/pull/2579) - Add support for `google.api.VisibilityRule`s annotations to hide APIs and fields by [@BCook98](https://github.com/BCook98) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2578](https://github.com/grpc-ecosystem/grpc-gateway/pull/2578) - feature/custom HTTP health check endpoint by [@antonioiubatti93](https://github.com/antonioiubatti93) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2587](https://github.com/grpc-ecosystem/grpc-gateway/pull/2587) #### New Contributors - [@rogchap](https://github.com/rogchap) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2574](https://github.com/grpc-ecosystem/grpc-gateway/pull/2574) - [@hedhyw](https://github.com/hedhyw) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2579](https://github.com/grpc-ecosystem/grpc-gateway/pull/2579) - [@BCook98](https://github.com/BCook98) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2578](https://github.com/grpc-ecosystem/grpc-gateway/pull/2578) - [@antonioiubatti93](https://github.com/antonioiubatti93) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2587](https://github.com/grpc-ecosystem/grpc-gateway/pull/2587) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.8.0...v2.9.0 ### [`v2.8.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.8.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.3...v2.8.0) #### 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](https://github.com/grpc-ecosystem/grpc-gateway/issues/1670) and [#1015](https://github.com/grpc-ecosystem/grpc-gateway/issues/1015)). #### What's Changed - Include Package in Service Tags when Option is Enabled by [@dkiswanto](https://github.com/dkiswanto) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2519](https://github.com/grpc-ecosystem/grpc-gateway/pull/2519) - Add `WithHealthzEndpoint` as `ServeMuxOption` to register a `/healthz`endpoint by [@brumhard](https://github.com/brumhard) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2319](https://github.com/grpc-ecosystem/grpc-gateway/pull/2319) - protoc-gen-openapiv2: remove path parameters from body parameters by [@oyvindwe](https://github.com/oyvindwe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2553](https://github.com/grpc-ecosystem/grpc-gateway/pull/2553) #### New Contributors - [@dkiswanto](https://github.com/dkiswanto) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2519](https://github.com/grpc-ecosystem/grpc-gateway/pull/2519) - [@brumhard](https://github.com/brumhard) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2319](https://github.com/grpc-ecosystem/grpc-gateway/pull/2319) - [@oyvindwe](https://github.com/oyvindwe) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2553](https://github.com/grpc-ecosystem/grpc-gateway/pull/2553) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.3...v2.8.0 ### [`v2.7.3`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.7.3) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.2...v2.7.3) ##### What's Changed - Update gorelease base to v2.7.2 by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2467](https://github.com/grpc-ecosystem/grpc-gateway/pull/2467) - Fix README typo about manuall generation by [@baryluk](https://github.com/baryluk) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2471](https://github.com/grpc-ecosystem/grpc-gateway/pull/2471) - Use insecure.NewCredentials instead of grpc.WithInsecure by [@jxlwqq](https://github.com/jxlwqq) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2470](https://github.com/grpc-ecosystem/grpc-gateway/pull/2470) - fix typos by [@haiker2011](https://github.com/haiker2011) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2474](https://github.com/grpc-ecosystem/grpc-gateway/pull/2474) - docs: specify invalid cases for FieldMask by [@hhhapz](https://github.com/hhhapz) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2477](https://github.com/grpc-ecosystem/grpc-gateway/pull/2477) - typo in mux.go by [@gabroo](https://github.com/gabroo) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2479](https://github.com/grpc-ecosystem/grpc-gateway/pull/2479) - Add omit-enum-default-value option to protoc-gen-openapiv2 by [@hiroyoshii](https://github.com/hiroyoshii) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2480](https://github.com/grpc-ecosystem/grpc-gateway/pull/2480) - update plugin option of customizing_openapi_output docs by [@hiroyoshii](https://github.com/hiroyoshii) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2490](https://github.com/grpc-ecosystem/grpc-gateway/pull/2490) - embedding UnimplementedGreeterServer to creating_main.go.md server struct by [@mkusaka](https://github.com/mkusaka) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2502](https://github.com/grpc-ecosystem/grpc-gateway/pull/2502) - Fixes additional paths generated when many methods have the same resource path by [@aethanol](https://github.com/aethanol) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2496](https://github.com/grpc-ecosystem/grpc-gateway/pull/2496) ##### New Contributors - [@baryluk](https://github.com/baryluk) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2471](https://github.com/grpc-ecosystem/grpc-gateway/pull/2471) - [@jxlwqq](https://github.com/jxlwqq) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2470](https://github.com/grpc-ecosystem/grpc-gateway/pull/2470) - [@haiker2011](https://github.com/haiker2011) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2474](https://github.com/grpc-ecosystem/grpc-gateway/pull/2474) - [@hhhapz](https://github.com/hhhapz) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2477](https://github.com/grpc-ecosystem/grpc-gateway/pull/2477) - [@gabroo](https://github.com/gabroo) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2479](https://github.com/grpc-ecosystem/grpc-gateway/pull/2479) - [@hiroyoshii](https://github.com/hiroyoshii) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2480](https://github.com/grpc-ecosystem/grpc-gateway/pull/2480) - [@mkusaka](https://github.com/mkusaka) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2502](https://github.com/grpc-ecosystem/grpc-gateway/pull/2502) - [@aethanol](https://github.com/aethanol) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2496](https://github.com/grpc-ecosystem/grpc-gateway/pull/2496) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.2...v2.7.3 ### [`v2.7.2`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.7.2) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.1...v2.7.2) ##### What's Changed - Log warning if HeaderMatcherFunc passes malformed HTTP headers to grpc server by [@MakDon](https://github.com/MakDon) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2455](https://github.com/grpc-ecosystem/grpc-gateway/pull/2455) - Fixes [#407](https://github.com/grpc-ecosystem/grpc-gateway/issues/407) and [#1700](https://github.com/grpc-ecosystem/grpc-gateway/issues/1700) - google.api.http path parameter constraints and multiple HTTP path/method endpoint support by [@betmix-matt](https://github.com/betmix-matt) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2461](https://github.com/grpc-ecosystem/grpc-gateway/pull/2461) This fixes a long standing issue with OpenAPI spec generation in the face of complex path parameter use ##### New Contributors - [@MakDon](https://github.com/MakDon) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2455](https://github.com/grpc-ecosystem/grpc-gateway/pull/2455) - [@betmix-matt](https://github.com/betmix-matt) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2461](https://github.com/grpc-ecosystem/grpc-gateway/pull/2461) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.1...v2.7.2 ### [`v2.7.1`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.7.1) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.0...v2.7.1) ##### What's Changed - Replace "github.com/ghodss/yaml" with "sigs.k8s.io/yaml" by [@slntopp](https://github.com/slntopp) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2436](https://github.com/grpc-ecosystem/grpc-gateway/pull/2436) - build: upgrade `go` directive in `go.mod` to 1.17 by [@Juneezee](https://github.com/Juneezee) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2443](https://github.com/grpc-ecosystem/grpc-gateway/pull/2443) - Revert "support grpc.ClientConnInterface in RegisterXXXHandler ([#2398](https://github.com/grpc-ecosystem/grpc-gateway/issues/2398))" by [@shane-kerr](https://github.com/shane-kerr) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2444](https://github.com/grpc-ecosystem/grpc-gateway/pull/2444) ##### New Contributors - [@slntopp](https://github.com/slntopp) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2436](https://github.com/grpc-ecosystem/grpc-gateway/pull/2436) - [@Juneezee](https://github.com/Juneezee) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2443](https://github.com/grpc-ecosystem/grpc-gateway/pull/2443) - [@shane-kerr](https://github.com/shane-kerr) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2444](https://github.com/grpc-ecosystem/grpc-gateway/pull/2444) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.7.0...v2.7.1 ### [`v2.7.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.7.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.6.0...v2.7.0) #### What's Changed - Decode path-encoded URL components by [@v3n](https://github.com/v3n) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2332](https://github.com/grpc-ecosystem/grpc-gateway/pull/2332) - Add docs for merging OpenAPI into a single file by [@alee792](https://github.com/alee792) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2354](https://github.com/grpc-ecosystem/grpc-gateway/pull/2354) - Fix timestamp string conversion by [@momom-i](https://github.com/momom-i) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2367](https://github.com/grpc-ecosystem/grpc-gateway/pull/2367) - Upgrade bazel toolchain by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2390](https://github.com/grpc-ecosystem/grpc-gateway/pull/2390) - Log zero property as warning instead of error by [@JungWinter](https://github.com/JungWinter) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2387](https://github.com/grpc-ecosystem/grpc-gateway/pull/2387) - support grpc.ClientConnInterface in RegisterXXXHandler by [@defool](https://github.com/defool) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2398](https://github.com/grpc-ecosystem/grpc-gateway/pull/2398) - Allow OpenAPI query parameters to be generated for all HTTP methods, regardless of body by [@alee792](https://github.com/alee792) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2402](https://github.com/grpc-ecosystem/grpc-gateway/pull/2402) #### New Contributors - [@v3n](https://github.com/v3n) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2332](https://github.com/grpc-ecosystem/grpc-gateway/pull/2332) - [@alee792](https://github.com/alee792) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2354](https://github.com/grpc-ecosystem/grpc-gateway/pull/2354) - [@0rax](https://github.com/0rax) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2386](https://github.com/grpc-ecosystem/grpc-gateway/pull/2386) - [@JungWinter](https://github.com/JungWinter) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2387](https://github.com/grpc-ecosystem/grpc-gateway/pull/2387) - [@defool](https://github.com/defool) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2398](https://github.com/grpc-ecosystem/grpc-gateway/pull/2398) - [@AdamKorcz](https://github.com/AdamKorcz) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2405](https://github.com/grpc-ecosystem/grpc-gateway/pull/2405) - [@jzelinskie](https://github.com/jzelinskie) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2413](https://github.com/grpc-ecosystem/grpc-gateway/pull/2413) - [@aronrichter](https://github.com/aronrichter) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2412](https://github.com/grpc-ecosystem/grpc-gateway/pull/2412) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.6.0...v2.7.0 ### [`v2.6.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.6.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.5.0...v2.6.0) [Changes in this release](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.5.0...v2.6.0) Major features in this release include: - The ability to auto-generate the `x-nullable` field from proto3 optional in openapiv2 contributed by Ken Brownfield ([@irridia](https://github.com/irridia)) in [#2215](https://github.com/grpc-ecosystem/grpc-gateway/issues/2215) - More comprehensive openapiv2 name generation options contributed by [@alperengozeten](https://github.com/alperengozeten) and Malte Isberner ([@misberner](https://github.com/misberner)) in [#2310](https://github.com/grpc-ecosystem/grpc-gateway/issues/2310) As well as various bug fixes, including the auto generation of the `Www-Authenticate` header when returning an 401 Unauthorized error ([#2314](https://github.com/grpc-ecosystem/grpc-gateway/issues/2314)), better `google.protobuf.Any` representation in openapiv2 files ([#2292](https://github.com/grpc-ecosystem/grpc-gateway/issues/2292)) and much more. This is also the first release to automatically publish the Protobuf plugins to the [Buf Schema Registry](https://buf.build/explore). 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: ```yaml 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`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.5.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.4.0...v2.5.0) [Changes in this release](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.4.0...v2.5.0) This release adds support for [extracting the HTTP path for an incoming request through the request context](https://github.com/grpc-ecosystem/grpc-gateway/pull/2195). Thanks to [@0daryo](https://github.com/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`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.4.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.3.0...v2.4.0) This release adds support for [customizing routing error HTTP status codes](https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_your_gateway/#customizing-routing-errors). Thanks to [@electrofelix](https://github.com/electrofelix) for the contribution! #### Other changes - implements a max recursive depth check by [@drewwells](https://github.com/drewwells) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2022](https://github.com/grpc-ecosystem/grpc-gateway/pull/2022) - Fix typo in README.md by [@cxmcc](https://github.com/cxmcc) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2047](https://github.com/grpc-ecosystem/grpc-gateway/pull/2047) - Add doc with info about binary upload a custom route, for [#500](https://github.com/grpc-ecosystem/grpc-gateway/issues/500) by [@jonathanbp](https://github.com/jonathanbp) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2063](https://github.com/grpc-ecosystem/grpc-gateway/pull/2063) - Fix path params being in the body by [@stijndehaes](https://github.com/stijndehaes) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2078](https://github.com/grpc-ecosystem/grpc-gateway/pull/2078) - Update CI to use 1.16 and latest release by [@johanbrandhorst](https://github.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2099](https://github.com/grpc-ecosystem/grpc-gateway/pull/2099) - Patcher for fields of type google.protobuf.Any by [@veith](https://github.com/veith) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2103](https://github.com/grpc-ecosystem/grpc-gateway/pull/2103) #### New Contributors - [@drewwells](https://github.com/drewwells) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2022](https://github.com/grpc-ecosystem/grpc-gateway/pull/2022) - [@cxmcc](https://github.com/cxmcc) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2047](https://github.com/grpc-ecosystem/grpc-gateway/pull/2047) - [@jonathanbp](https://github.com/jonathanbp) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2063](https://github.com/grpc-ecosystem/grpc-gateway/pull/2063) - [@stijndehaes](https://github.com/stijndehaes) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2078](https://github.com/grpc-ecosystem/grpc-gateway/pull/2078) - [@veith](https://github.com/veith) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2103](https://github.com/grpc-ecosystem/grpc-gateway/pull/2103) - [@electrofelix](https://github.com/electrofelix) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/2101](https://github.com/grpc-ecosystem/grpc-gateway/pull/2101) **Full Changelog**: https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.3.0...v2.4.0 ### [`v2.3.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.3.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.2.0...v2.3.0) ##### This release migrates our internal generation strategy to using [buf](https://github.com/bufbuild/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](https://github.com/grpc-ecosystem/grpc-gateway#usage) again to see how to use `buf` to manage your dependencies instead. ##### The [boilerplate repo](https://github.com/johanbrandhorst/grpc-gateway-boilerplate) contains an example. #### [v2.3.0](https://github.com/grpc-ecosystem/grpc-gateway/tree/v2.3.0) (2021-02-25) [Full Changelog](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.2.0...v2.3.0) **Implemented enhancements:** - Support optional annotation in proto3 files in generators [#1278](https://github.com/grpc-ecosystem/grpc-gateway/issues/1278) **Fixed bugs:** - grpc-gateway v2 misreads grpc protobuf field_mask behavior, breaks existing valid behavior [#1766](https://github.com/grpc-ecosystem/grpc-gateway/issues/1766) **Closed issues:** - grpc-gateway service run error [#1996](https://github.com/grpc-ecosystem/grpc-gateway/issues/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](https://github.com/grpc-ecosystem/grpc-gateway/issues/1989) - Grpc healthcheck docs are unclear [#1977](https://github.com/grpc-ecosystem/grpc-gateway/issues/1977) - Gateway protoc does not generate protoreflect.ProtoMessage messages [#1959](https://github.com/grpc-ecosystem/grpc-gateway/issues/1959) - \[bazel] Got "missing strict dependencies" when use protoc-gen-grpc-gateway as bazel-gazelle grpc compiler [#1941](https://github.com/grpc-ecosystem/grpc-gateway/issues/1941) - Non official implementation [#1940](https://github.com/grpc-ecosystem/grpc-gateway/issues/1940) - Empty fields included in response. [#1871](https://github.com/grpc-ecosystem/grpc-gateway/issues/1871) **Merged pull requests:** - fix(deps): update module google.golang.org/grpc to v1.36.0 (master) [#1999](https://github.com/grpc-ecosystem/grpc-gateway/pull/1999) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update google.golang.org/genproto commit hash to [`063164c`](https://github.com/grpc-ecosystem/grpc-gateway/commit/063164c) (master) [#1998](https://github.com/grpc-ecosystem/grpc-gateway/pull/1998) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update dependency com_google_protobuf to v3.15.2 (master) [#1995](https://github.com/grpc-ecosystem/grpc-gateway/pull/1995) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update bufbuild/buf docker tag to v0.37.1 (master) [#1994](https://github.com/grpc-ecosystem/grpc-gateway/pull/1994) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update google.golang.org/genproto commit hash to [`22b48be`](https://github.com/grpc-ecosystem/grpc-gateway/commit/22b48be) (master) [#1993](https://github.com/grpc-ecosystem/grpc-gateway/pull/1993) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update google.golang.org/genproto commit hash to [`3e1e516`](https://github.com/grpc-ecosystem/grpc-gateway/commit/3e1e516) (master) [#1991](https://github.com/grpc-ecosystem/grpc-gateway/pull/1991) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update google.golang.org/genproto commit hash to [`aa3ee6e`](https://github.com/grpc-ecosystem/grpc-gateway/commit/aa3ee6e) (master) [#1990](https://github.com/grpc-ecosystem/grpc-gateway/pull/1990) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update dependency com_google_protobuf to v3.15.1 (master) [#1987](https://github.com/grpc-ecosystem/grpc-gateway/pull/1987) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update golang.org/x/oauth2 commit hash to [`9bb9049`](https://github.com/grpc-ecosystem/grpc-gateway/commit/9bb9049) (master) [#1986](https://github.com/grpc-ecosystem/grpc-gateway/pull/1986) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update google.golang.org/genproto commit hash to [`d891e3c`](https://github.com/grpc-ecosystem/grpc-gateway/commit/d891e3c) (master) [#1985](https://github.com/grpc-ecosystem/grpc-gateway/pull/1985) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update dependency com_google_protobuf to v3.15.0 (master) [#1984](https://github.com/grpc-ecosystem/grpc-gateway/pull/1984) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update golang.org/x/oauth2 commit hash to [`ba52d33`](https://github.com/grpc-ecosystem/grpc-gateway/commit/ba52d33) (master) [#1983](https://github.com/grpc-ecosystem/grpc-gateway/pull/1983) ([renovate\[bot\]](https://github.com/apps/renovate)) - fix(deps): update google.golang.org/genproto commit hash to [`fe80b38`](https://github.com/grpc-ecosystem/grpc-gateway/commit/fe80b38) (master) [#1982](https://github.com/grpc-ecosystem/grpc-gateway/pull/1982) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update google.golang.org/genproto commit hash to [`c185827`](https://github.com/grpc-ecosystem/grpc-gateway/commit/c185827) (master) [#1979](https://github.com/grpc-ecosystem/grpc-gateway/pull/1979) ([renovate\[bot\]](https://github.com/apps/renovate)) - Use base64.URLEncoding for \[]byte parameters in query [#1978](https://github.com/grpc-ecosystem/grpc-gateway/pull/1978) ([tvoll](https://github.com/tvoll)) - chore(deps): update golang docker tag to v1.16.0 (master) [#1976](https://github.com/grpc-ecosystem/grpc-gateway/pull/1976) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update golang.org/x/oauth2 commit hash to [`16ff188`](https://github.com/grpc-ecosystem/grpc-gateway/commit/16ff188) (master) [#1974](https://github.com/grpc-ecosystem/grpc-gateway/pull/1974) ([renovate\[bot\]](https://github.com/apps/renovate)) - adding UnimplementedGreeterServer to server struct [#1973](https://github.com/grpc-ecosystem/grpc-gateway/pull/1973) ([nwandabridges](https://github.com/nwandabridges)) - \[Bazel] Update protobuf, rules_go and gazelle [#1972](https://github.com/grpc-ecosystem/grpc-gateway/pull/1972) ([aaliddell](https://github.com/aaliddell)) - Migrate generation, linting to buf [#1971](https://github.com/grpc-ecosystem/grpc-gateway/pull/1971) ([johanbrandhorst](https://github.com/johanbrandhorst)) - chore(deps): update google.golang.org/genproto commit hash to [`e7f2df4`](https://github.com/grpc-ecosystem/grpc-gateway/commit/e7f2df4) (master) [#1970](https://github.com/grpc-ecosystem/grpc-gateway/pull/1970) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update google.golang.org/genproto commit hash to [`4ccc9a5`](https://github.com/grpc-ecosystem/grpc-gateway/commit/4ccc9a5) (master) [#1969](https://github.com/grpc-ecosystem/grpc-gateway/pull/1969) ([renovate\[bot\]](https://github.com/apps/renovate)) - Bump nokogiri from 1.10.10 to 1.11.1 in /docs [#1967](https://github.com/grpc-ecosystem/grpc-gateway/pull/1967) ([dependabot\[bot\]](https://github.com/apps/dependabot)) - docs/Gemfile.lock: Fix dependabot security warning [#1966](https://github.com/grpc-ecosystem/grpc-gateway/pull/1966) ([ivucica](https://github.com/ivucica)) - chore(deps): update google.golang.org/genproto commit hash to [`3a9a48d`](https://github.com/grpc-ecosystem/grpc-gateway/commit/3a9a48d) (master) [#1965](https://github.com/grpc-ecosystem/grpc-gateway/pull/1965) ([renovate\[bot\]](https://github.com/apps/renovate)) - chore(deps): update golang.org/x/oauth2 commit hash to [`6667018`](https://github.com/grpc-ecosystem/grpc-gateway/commit/6667018) (master) [#1964](https://github.com/grpc-ecosystem/grpc-gateway/pull/1964) ([renovate\[bot\]](https://github.com/apps/renovate)) - Update CONTRIBUTING.md on release description [#1960](https://github.com/grpc-ecosystem/grpc-gateway/pull/1960) ([adambabik](https://github.com/adambabik)) - gen-grpc-gateway, gen-openapiv2: add support for proto3 optional [#1951](https://github.com/grpc-ecosystem/grpc-gateway/pull/1951) ([adambabik](https://github.com/adambabik)) - FAQ Adding related projects to the documentation [#1946](https://github.com/grpc-ecosystem/grpc-gateway/pull/1946) ([rodoufu](https://github.com/rodoufu)) ### [`v2.2.0`](https://github.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.2.0) [Compare Source](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.1.0...v2.2.0) ##### [v2.2.0](https://github.com/grpc-ecosystem/grpc-gateway/tree/v2.2.0) (2021-02-09) [Full Changelog](https://github.com/grpc-ecosystem/grpc-gateway/compare/v2.1.0...v2.2.0) **Fixed bugs:** - \[protoc-gen-openapiv2] \[BUG] Incorrect handling of non-wildcard google.api.http.body when using field_behaviour annotation [#1937](https://github.com/grpc-ecosystem/grpc-gateway/issues/1937) - Duplicate tags seen in Swagger Specification [#1913](https://github.com/grpc-ecosystem/grpc-gateway/issues/1913) - Poor error message when using message in path parameter [#1863](https://github.com/grpc-ecosystem/grpc-gateway/issues/1863) **Closed issues:** - can we add HTTPStatusFromCode to mux? [#1954](https://github.com/grpc-ecosystem/grpc-gateway/issues/1954) - Missing types in generated gw.go file for C++ server [#1942](https://github.com/grpc-ecosystem/grpc-gateway/issues/1942) - What is the recommend way to bind 3rd party APIs (e.g. Health/Check to /healthzf [#1931](https://github.com/grpc-ecosystem/grpc-gateway/issues/1931) - Patch request with field_masks [#1930](https://github.com/grpc-ecosystem/grpc-gateway/issues/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](https://github.com/grpc-ecosystem/grpc-gateway/issues/1924) - Action Required: Fix Renovate Configuration [#1918](https://github.com/grpc-ecosystem/grpc-gateway/issues/1918) - F [#1917](https://github.com/grpc-ecosystem/grpc-gateway/issues/1917) - Is any method to access the raw request body in metadata? [#1908](https://github.com/grpc-ecosystem/grpc-gateway/issues/1908) - Custom incoming header matcher isn't working as expected [#1902](https://github.com/grpc-ecosystem/grpc-gateway/issues/1902) - README.md links to https://pkg.go.dev/github.com/golang/protobuf/jsonpb which does not exist [#1901](https://github.com/grpc-ecosystem/grpc-gateway/issues/1901) - Is it possible to setup CORS? [#1889](https://github.com/grpc-ecosystem/grpc-gateway/issues/1889) **Merged pull requests:** - Add documenation for standalone gateway generation [#1955](https://github.com/grpc-ecosystem/grpc-gateway/pull/1955) ([dgparker](https://github.com/dgparker)) - Update google.golang.org/genproto commit hash to [`bba0dbe`](https://github.com/grpc-ecosystem/grpc-gateway/commit/bba0dbe) (master) [#1953](https://github.com/grpc-ecosystem/grpc-gateway/pull/1953) ([renovate\[bot\]](https://github.com/apps/renovate)) - Make fieldmask parser output deterministic [#1950](https://github.com/grpc-ecosystem/grpc-gateway/pull/1950) ([johanbrandhorst](https://github.com/johanbrandhorst)) - Update golang Docker tag to v1.15.8 (master) [#1949](https://github.com/grpc-ecosystem/grpc-gateway/pull/1949) ([renovate\[bot\]](https://github.com/apps/renovate)) - Fix verb parsing [#1947](https://github.com/grpc-ecosystem/grpc-gateway/pull/1947) ([jefferai](https://github.com/jefferai)) - Update google.golang.org/genproto commit hash to [`deb8283`](https://github.com/grpc-ecosystem/grpc-gateway/commit/deb8283) (master) [#1945](https://github.com/grpc-ecosystem/grpc-gateway/pull/1945) ([renovate\[bot\]](https://github.com/apps/renovate)) - Fix malformed Schema Reference during field_behavior generation [#1944](https://github.com/grpc-ecosystem/grpc-gateway/pull/1944) ([gganley](https://github.com/gganley)) - Update dependency com_github_bazelbuild_buildtools to v4 (master) [#1939](https://github.com/grpc-ecosystem/grpc-gateway/pull/1939) ([renovate\[bot\]](https://github.com/apps/renovate)) - Update google.golang.org/genproto commit hash to [`3206188`](https://github.com/grpc-ecosystem/grpc-gateway/commit/3206188) (master) [#1936](https://github.com/grpc-ecosystem/grpc-gateway/pull/1936) ([renovate\[bot\]](https://github.com/apps/renovate)) - Update google.golang.org/genproto commit hash to [`646a494`](https://github.com/grpc-ecosystem/grpc-gateway/commit/646a494) (master) [#1934](https://github.com/grpc-ecosystem/grpc-gateway/pull/1934) ([renovate\[bot\]](https://github.com/apps/renovate)) - Update golang.org/x/oauth2 commit hash to [`0101308 </details> --- ### 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](https://github.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/google/osv.dev).

google-cla bot added the cla: no label Aug 31, 2021

brumhard changed the title ~~Feature/runtime servemux healthz endpoint~~ Add WithHealthzEndpoint as ServeMuxOption to register a /healthzendpoint Aug 31, 2021

johanbrandhorst requested changes Sep 1, 2021

View reviewed changes

runtime/mux_test.go Outdated Show resolved Hide resolved

stale bot added the wontfix label Nov 16, 2021

stale bot removed the wontfix label Nov 17, 2021

brumhard added 7 commits March 1, 2022 08:37

Add HealthCheck endpoint option to ServeMux

54cf30b

Use outboundMarshaler for HealthCheck reponses

18fe9c7

Rename WithHealthCheckEnabled to WithHealthzEndpoint

b44f757

Add docs for WithHealthzEndpoint

2294414

Cleanup health_check.md and imports

1546d5f

Fix health_check.md header

a8020d7

Fix health_check.md header whitespace

2de8285

brumhard force-pushed the feature/runtime-servemux-healthz-endpoint branch from 445428d to 9464e33 Compare March 1, 2022 07:39

Replace panic with error return in test grpc server

bc9f925

Co-authored-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com>

Update runtime/BUILD.bazel

c02f991

brumhard force-pushed the feature/runtime-servemux-healthz-endpoint branch from 9464e33 to c02f991 Compare March 1, 2022 08:04

google-cla bot added cla: yes and removed cla: no labels Mar 1, 2022

brumhard requested a review from johanbrandhorst March 1, 2022 13:42

johanbrandhorst reviewed Mar 2, 2022

View reviewed changes

brumhard added 2 commits March 2, 2022 08:22

Use HealthClient for WithHealthzEndpoint option

9fead79

Signed-off-by: Tobias Brumhard <tobias.brumhard@mail.schwarz>

Regenerate bazel files

4b624df

Signed-off-by: Tobias Brumhard <tobias.brumhard@mail.schwarz>

johanbrandhorst approved these changes Mar 2, 2022

View reviewed changes

johanbrandhorst merged commit db9c664 into grpc-ecosystem:master Mar 2, 2022

This was referenced Mar 8, 2022

Custom HTTP health check endpoint path #2572

Closed

feature/custom HTTP health check endpoint #2587

Merged

kamilsk mentioned this pull request Mar 27, 2022

boilerplate: define health endpoint octomation/go-service#30

Open

9 tasks

maha-hajja mentioned this pull request Apr 6, 2022

Reduce healthcheck logging ConduitIO/conduit#357

Merged

4 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `WithHealthzEndpoint` as `ServeMuxOption` to register a `/healthz`endpoint #2319

Add `WithHealthzEndpoint` as `ServeMuxOption` to register a `/healthz`endpoint #2319

brumhard commented Aug 31, 2021

google-cla bot commented Aug 31, 2021

google-cla bot commented Aug 31, 2021

google-cla bot commented Aug 31, 2021

google-cla bot commented Aug 31, 2021

johanbrandhorst left a comment

google-cla bot commented Sep 1, 2021

google-cla bot commented Sep 1, 2021

codecov-commenter commented Sep 1, 2021

brumhard commented Sep 1, 2021

johanbrandhorst commented Sep 3, 2021

johanbrandhorst commented Sep 3, 2021

stale bot commented Nov 16, 2021

brumhard commented Nov 17, 2021

johanbrandhorst commented Nov 17, 2021

lovromazgon commented Dec 23, 2021

brumhard commented Dec 23, 2021

brumhard commented Mar 1, 2022

brumhard commented Mar 1, 2022

johanbrandhorst Mar 2, 2022

brumhard Mar 2, 2022

brumhard Mar 2, 2022

johanbrandhorst left a comment

johanbrandhorst commented Mar 2, 2022

johanbrandhorst commented Mar 2, 2022

		func WithHealthzEndpoint(conn grpc.ClientConnInterface) ServeMuxOption {
		healthCheckClient := grpc_health_v1.NewHealthClient(conn)

	func WithHealthzEndpoint(conn grpc.ClientConnInterface) ServeMuxOption {
	healthCheckClient := grpc_health_v1.NewHealthClient(conn)
	func WithHealthzEndpoint(healthCheckClient grpc_health_v1.HealthClient) ServeMuxOption {

Add WithHealthzEndpoint as ServeMuxOption to register a /healthzendpoint #2319

Add WithHealthzEndpoint as ServeMuxOption to register a /healthzendpoint #2319

Conversation

brumhard commented Aug 31, 2021

References to other Issues or PRs

Brief description of what is fixed or changed

google-cla bot commented Aug 31, 2021

What to do if you already signed the CLA

Individual signers

Corporate signers

google-cla bot commented Aug 31, 2021

What to do if you already signed the CLA

Individual signers

Corporate signers

google-cla bot commented Aug 31, 2021

What to do if you already signed the CLA

Individual signers

Corporate signers

google-cla bot commented Aug 31, 2021

What to do if you already signed the CLA

Individual signers

Corporate signers

johanbrandhorst left a comment

Choose a reason for hiding this comment

google-cla bot commented Sep 1, 2021

What to do if you already signed the CLA

Individual signers

Corporate signers

google-cla bot commented Sep 1, 2021

What to do if you already signed the CLA

Individual signers

Corporate signers

codecov-commenter commented Sep 1, 2021

Codecov Report

brumhard commented Sep 1, 2021

johanbrandhorst commented Sep 3, 2021

johanbrandhorst commented Sep 3, 2021

stale bot commented Nov 16, 2021

brumhard commented Nov 17, 2021

johanbrandhorst commented Nov 17, 2021

lovromazgon commented Dec 23, 2021

brumhard commented Dec 23, 2021

brumhard commented Mar 1, 2022

brumhard commented Mar 1, 2022

johanbrandhorst Mar 2, 2022

Choose a reason for hiding this comment

brumhard Mar 2, 2022

Choose a reason for hiding this comment

brumhard Mar 2, 2022

Choose a reason for hiding this comment

johanbrandhorst left a comment

Choose a reason for hiding this comment

johanbrandhorst commented Mar 2, 2022

johanbrandhorst commented Mar 2, 2022

Add `WithHealthzEndpoint` as `ServeMuxOption` to register a `/healthz`endpoint #2319

Add `WithHealthzEndpoint` as `ServeMuxOption` to register a `/healthz`endpoint #2319