-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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.
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
use_allof_for_refs: extend to example field #3240
Conversation
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This seems reasonable, but I think we should add at least one test. Either add a new test case in template_test.go
(there's hopefully already one for the allOf option) or add a new protobuf file and generate from it with this option enabled please.
@johanbrandhorst I have extended the existing relevant test to verify the example property being included, as well as others from the include condition (title, description) https://github.com/grpc-ecosystem/grpc-gateway/pull/3240/files#diff-0330d83e3109c5c0a8cb78a2a980db731e973c738da7851d34a88e00244a4b5eR5375 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Thanks for your contribution! |
@johanbrandhorst Sure, thanks for driving this project |
[![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://togithub.com/grpc-ecosystem/grpc-gateway) | require | minor | `v2.15.2` -> `v2.16.0` | | [jekyll-feed](https://togithub.com/jekyll/jekyll-feed) | | minor | `0.15.1` -> `0.17.0` | --- ### Release Notes <details> <summary>grpc-ecosystem/grpc-gateway</summary> ### [`v2.16.0`](https://togithub.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.16.0) [Compare Source](https://togithub.com/grpc-ecosystem/grpc-gateway/compare/v2.15.2...v2.16.0) #### What's Changed - Upgrade some deps by [@​johanbrandhorst](https://togithub.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3214](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3214) - add note about incompatibility of remote plugins and external configu… by [@​DGuhr](https://togithub.com/DGuhr) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3220](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3220) - Fix tests by [@​johanbrandhorst](https://togithub.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3234](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3234) - use_allof_for_refs: extend to example field by [@​igor-tsiglyar](https://togithub.com/igor-tsiglyar) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3240](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3240) - New `ignore_comments` option for excluding proto comments from OpenAPI output by [@​keyz](https://togithub.com/keyz) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3252](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3252) - Only allow POST -> GET path length fallback by [@​nacx](https://togithub.com/nacx) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3272](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3272) - Remove GHA workflow that pushes to BSR by [@​unmultimedio](https://togithub.com/unmultimedio) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3279](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3279) - fix: enum should be int when enums_as_int = true by [@​hnlq715](https://togithub.com/hnlq715) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3167](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3167) - doc: Add OpenTelemetry go tracing example by [@​iamrajiv](https://togithub.com/iamrajiv) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3309](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3309) - Switch from aliased field_mask package to canonical package by [@​liggitt](https://togithub.com/liggitt) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3317](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3317) - Replace deprecated command with environment file by [@​jongwooo](https://togithub.com/jongwooo) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3319](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3319) - changed block from code to paragraph by [@​shashaneRanasinghe](https://togithub.com/shashaneRanasinghe) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3330](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3330) - feat([#​3238](https://togithub.com/grpc-ecosystem/grpc-gateway/issues/3238)):Support map in query parameters by [@​li31727](https://togithub.com/li31727) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3323](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3323) - A few fixes for streaming responses by [@​johanbrandhorst](https://togithub.com/johanbrandhorst) in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3335](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3335) #### New Contributors - [@​DGuhr](https://togithub.com/DGuhr) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3220](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3220) - [@​xieyuschen](https://togithub.com/xieyuschen) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3231](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3231) - [@​igor-tsiglyar](https://togithub.com/igor-tsiglyar) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3240](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3240) - [@​KiK0S](https://togithub.com/KiK0S) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3247](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3247) - [@​keyz](https://togithub.com/keyz) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3252](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3252) - [@​nacx](https://togithub.com/nacx) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3272](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3272) - [@​unmultimedio](https://togithub.com/unmultimedio) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3279](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3279) - [@​hnlq715](https://togithub.com/hnlq715) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3167](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3167) - [@​liggitt](https://togithub.com/liggitt) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3317](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3317) - [@​jongwooo](https://togithub.com/jongwooo) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3319](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3319) - [@​shashaneRanasinghe](https://togithub.com/shashaneRanasinghe) made their first contribution in [https://github.com/grpc-ecosystem/grpc-gateway/pull/3330](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3330) **Full Changelog**: grpc-ecosystem/grpc-gateway@v2.15.2...v2.15.3 </details> <details> <summary>jekyll/jekyll-feed</summary> ### [`v0.17.0`](https://togithub.com/jekyll/jekyll-feed/blob/HEAD/History.markdown#​0170--2022-10-14) [Compare Source](https://togithub.com/jekyll/jekyll-feed/compare/v0.16.0...v0.17.0) ##### Documentation - Update CI status badge ([#​363](https://togithub.com/jekyll/jekyll-feed/issues/363)) ##### Development Fixes - Add Ruby 3.1 to the CI matrix ([#​365](https://togithub.com/jekyll/jekyll-feed/issues/365)) ##### Minor Enhancements - Allow disabling of jekyll-feed while in development ([#​370](https://togithub.com/jekyll/jekyll-feed/issues/370)) ### [`v0.16.0`](https://togithub.com/jekyll/jekyll-feed/blob/HEAD/History.markdown#​0160--2022-01-03) [Compare Source](https://togithub.com/jekyll/jekyll-feed/compare/v0.15.1...v0.16.0) ##### Minor Enhancements - Add support for `page.description` in front matter to become entry `<summary>` ([#​297](https://togithub.com/jekyll/jekyll-feed/issues/297)) ##### Bug Fixes - Fold private methods into the `:render` method as local variables ([#​327](https://togithub.com/jekyll/jekyll-feed/issues/327)) - Check `post.categories` instead of `post.category` ([#​357](https://togithub.com/jekyll/jekyll-feed/issues/357)) - Switched xml_escape for `<![CDATA[]]>` for post content ([#​332](https://togithub.com/jekyll/jekyll-feed/issues/332)) ##### Development Fixes - Add Ruby 3.0 to CI ([#​337](https://togithub.com/jekyll/jekyll-feed/issues/337)) - Lock RuboCop to v1.18.x ([#​348](https://togithub.com/jekyll/jekyll-feed/issues/348)) - Add workflow to release gem via GH Action ([#​355](https://togithub.com/jekyll/jekyll-feed/issues/355)) ##### Documentation - Use `.atom` extension in documented examples since we write an Atom feed ([#​359](https://togithub.com/jekyll/jekyll-feed/issues/359)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on wednesday" in timezone Australia/Sydney, 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://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/google/osv.dev). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xMTUuMiIsInVwZGF0ZWRJblZlciI6IjM1LjEzMS4wIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->
References to other Issues or PRs
Related to #3232, #2671
Have you read the Contributing Guidelines?
Yes
Brief description of what is fixed or changed
Extending #3082, we can enable setting enum field example in
openapiv2_field
annotation, e.g.produces
instead of
example
field being ignored, which is currently the case.