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

fix: set consumes definition per operation #2995

Merged
merged 3 commits into from
Nov 8, 2022
Merged

fix: set consumes definition per operation #2995

merged 3 commits into from
Nov 8, 2022

Conversation

stomy13
Copy link
Contributor

@stomy13 stomy13 commented Nov 6, 2022

References to other Issues or PRs

Fixes #726

Have you read the Contributing Guidelines?

Yes

Brief description of what is fixed or changed

Cannot set consumes definition per operation.

Changed below:

  • Added Consumes field to openapiOperationObject.
  • Copy consumes if consumes definition per operation existed
  • There is a similar test, so I added fields into the test to verify.

Other comments

This PR is my first contributing in all my life.

@google-cla
Copy link

google-cla bot commented Nov 6, 2022

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.

johanbrandhorst
johanbrandhorst requested changes Nov 7, 2022
View reviewed changes
Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @stomy13, thank you so much for choosing to contribute to our little project! This looks great, I'm just wondering if we could also add an example of multiple consumes definitions to one of our example protos, maybe somewhere in here: https://github.com/grpc-ecosystem/grpc-gateway/blob/1b7515f8ec8fb382cc26ba24abf078578ab8c427/examples/internal/proto/examplepb/a_bit_of_everything.proto? That way, we have a practical example of how to use this feature too.

@stomy13
Copy link
Contributor Author

stomy13 commented Nov 7, 2022

Hi @johanbrandhorst, I added an example, and generated files. Please check.

johanbrandhorst
johanbrandhorst approved these changes Nov 8, 2022
View reviewed changes
Copy link
Collaborator

@johanbrandhorst johanbrandhorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@johanbrandhorst johanbrandhorst merged commit 765c9b7 into grpc-ecosystem:master Nov 8, 2022
@johanbrandhorst
Copy link
Collaborator

Thanks for your contribution!

@stomy13 stomy13 deleted the bugfix_726 branch November 8, 2022 05:41
andrewpollock referenced this pull request in google/osv.dev Nov 28, 2022
@renovate-bot
Update module github.com/grpc-ecosystem/grpc-gateway/v2 to v2.14.0 (#859
e9f46a8 
)

[![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.13.0` -> `v2.14.0` |

---

### Release Notes

<details>
<summary>grpc-ecosystem/grpc-gateway</summary>

###
[`v2.14.0`](https://togithub.com/grpc-ecosystem/grpc-gateway/releases/tag/v2.14.0)

[Compare
Source](https://togithub.com/grpc-ecosystem/grpc-gateway/compare/v2.13.0...v2.14.0)

#### New features

This release contains two significant new OpenAPIv2 generator features,
contributed by [@&#8203;krak3n](https://togithub.com/krak3n):

1. A new option to [disable rendering of 200 OK
responses](https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#disable-default-responses).
This is useful if you define custom responses for your endpoints and you
modify the return code a forward response writer. Note that this does
not change the behavior of the gateway itself.
2. A new annotation for [defining header
parameters](https://grpc-ecosystem.github.io/grpc-gateway/docs/mapping/customizing_openapi_output/#custom-http-header-request-parameters).
This lets to define header parameters you want to be rendered in the
swagger.json output in addition to those defined in your API messages.
Note that this does not change the behavior of the gateway itself and
must be coupled with custom header parsing in your application.

#### What's Changed

- release: Update release.yml with option to workaround SLSA generator
failure by [@&#8203;asraa](https://togithub.com/asraa) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2987](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2987)
- release: add a workflow_dispatch trigger for testing by
[@&#8203;asraa](https://togithub.com/asraa) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2989](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2989)
- Use io/os instread of ioutil and use suitable verb by
[@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2991](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2991)
- runtime pkg cleanup by
[@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2993](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2993)
- mux: fix path components mutation by
[@&#8203;jonathaningram](https://togithub.com/jonathaningram) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3001](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3001)
- fix: set consumes definition per operation by
[@&#8203;stomy13](https://togithub.com/stomy13) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2995](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2995)
- protoc gen oas v2 cleanup by
[@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2996](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2996)
- Use ReplaceAll instead of Replace with -1 pos by
[@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3003](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3003)
- Errors cleanup by
[@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3004](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3004)
- Cleanup by
[@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3012](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3012)
- Support disabling default response rendering by
[@&#8203;krak3n](https://togithub.com/krak3n) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3006](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3006)
- Support request header parameters by
[@&#8203;krak3n](https://togithub.com/krak3n) in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3010](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3010)

#### New Contributors

- [@&#8203;asraa](https://togithub.com/asraa) made their first
contribution in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2987](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2987)
- [@&#8203;sashamelentyev](https://togithub.com/sashamelentyev) made
their first contribution in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2991](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2991)
- [@&#8203;stomy13](https://togithub.com/stomy13) made their first
contribution in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/2995](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/2995)
- [@&#8203;krak3n](https://togithub.com/krak3n) made their first
contribution in
[https://github.com/grpc-ecosystem/grpc-gateway/pull/3006](https://togithub.com/grpc-ecosystem/grpc-gateway/pull/3006)

**Full Changelog**:
grpc-ecosystem/grpc-gateway@v2.13.0...v2.14.0

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6am on monday" 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.

🔕 **Ignore**: Close this PR and you won't be reminded about this update
again.

---

- [ ] <!-- 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://app.renovatebot.com/dashboard#github/google/osv.dev).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4zNy4wIiwidXBkYXRlZEluVmVyIjoiMzQuMzcuMCJ9-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@johanbrandhorst johanbrandhorst johanbrandhorst 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.

Cannot set consumes definition per operation
2 participants
@stomy13 @johanbrandhorst