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

feat(#3238):Support map in query parameters #3323

Merged
merged 1 commit into from
May 31, 2023
Merged

feat(#3238):Support map in query parameters #3323

merged 1 commit into from
May 31, 2023

Conversation

li31727
Copy link
Contributor

@li31727 li31727 commented May 25, 2023

References to other Issues or PRs

Fixes #3238

Have you read the Contributing Guidelines?

Yes

Brief description of what is fixed or changed

Generate the swagger api for Get requests that pass map type parameters

Other comments

johanbrandhorst
johanbrandhorst requested changes May 29, 2023
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.

Thanks a lot for this!

protoc-gen-openapiv2/internal/genopenapi/template.go Outdated Show resolved Hide resolved
protoc-gen-openapiv2/internal/genopenapi/template.go Outdated Show resolved Hide resolved
protoc-gen-openapiv2/internal/genopenapi/template.go Show resolved Hide resolved
protoc-gen-openapiv2/internal/genopenapi/template.go Outdated Show resolved Hide resolved
protoc-gen-openapiv2/internal/genopenapi/template.go Outdated Show resolved Hide resolved
protoc-gen-openapiv2/internal/genopenapi/template.go Outdated Show resolved Hide resolved
@li31727
Copy link
Contributor Author

li31727 commented May 31, 2023 •
edited
Loading

CI/golangci It's strange that I can run success on my repository but not here，Please try golangci again

johanbrandhorst
johanbrandhorst requested changes May 31, 2023
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.

Thanks for the updates, I missed one case of an extra newline, but I also wanted to ask if you could try using one of these object parameters in one of our Go integration tests: https://github.com/grpc-ecosystem/grpc-gateway/blob/main/examples/internal/integration/integration_test.go. Maybe have a look and see if it makes sense anywhere, if not, that's okay.

protoc-gen-openapiv2/internal/genopenapi/template_test.go Outdated Show resolved Hide resolved
@li31727 li31727 closed this May 31, 2023
@li31727 li31727 reopened this May 31, 2023
@li31727
Copy link
Contributor Author

li31727 commented May 31, 2023 •
edited
Loading

https://github.com/grpc-ecosystem/grpc-gateway/blob/main/examples/internal/integration/integration_test.go

I in https://github.com/grpc-ecosystem/grpc-gateway/blob/main/examples/internal/integration/integration_test.go has added a map types of GET request parameter, I don't know whether there is a problem in my test code, I found that grpc-gateway does not seem to support GET requests with a map type and value of type message

@johanbrandhorst
Copy link
Collaborator

Seems like the tests are passing, so I think that test is great, thank you!

@johanbrandhorst johanbrandhorst merged commit 6fd6a1f into grpc-ecosystem:main May 31, 2023
@johanbrandhorst
Copy link
Collaborator

Thank you for your contribution!

another-rex referenced this pull request in google/osv.dev Jun 26, 2023
@renovate-bot
Update docs (#1385)
136d356 
[![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
[@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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 [@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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
[@&#8203;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([#&#8203;3238](https://togithub.com/grpc-ecosystem/grpc-gateway/issues/3238)):Support
map in query parameters by
[@&#8203;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
[@&#8203;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

- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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)
- [@&#8203;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#&#8203;0170--2022-10-14)

[Compare
Source](https://togithub.com/jekyll/jekyll-feed/compare/v0.16.0...v0.17.0)

##### Documentation

- Update CI status badge
([#&#8203;363](https://togithub.com/jekyll/jekyll-feed/issues/363))

##### Development Fixes

- Add Ruby 3.1 to the CI matrix
([#&#8203;365](https://togithub.com/jekyll/jekyll-feed/issues/365))

##### Minor Enhancements

- Allow disabling of jekyll-feed while in development
([#&#8203;370](https://togithub.com/jekyll/jekyll-feed/issues/370))

###
[`v0.16.0`](https://togithub.com/jekyll/jekyll-feed/blob/HEAD/History.markdown#&#8203;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>`
([#&#8203;297](https://togithub.com/jekyll/jekyll-feed/issues/297))

##### Bug Fixes

- Fold private methods into the `:render` method as local variables
([#&#8203;327](https://togithub.com/jekyll/jekyll-feed/issues/327))
- Check `post.categories` instead of `post.category`
([#&#8203;357](https://togithub.com/jekyll/jekyll-feed/issues/357))
- Switched xml_escape for `<![CDATA[]]>` for post content
([#&#8203;332](https://togithub.com/jekyll/jekyll-feed/issues/332))

##### Development Fixes

- Add Ruby 3.0 to CI
([#&#8203;337](https://togithub.com/jekyll/jekyll-feed/issues/337))
- Lock RuboCop to v1.18.x
([#&#8203;348](https://togithub.com/jekyll/jekyll-feed/issues/348))
- Add workflow to release gem via GH Action
([#&#8203;355](https://togithub.com/jekyll/jekyll-feed/issues/355))

##### Documentation

- Use `.atom` extension in documented examples since we write an Atom
feed ([#&#8203;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=-->
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.

protoc-gen-openapiv2: Support map in query parameters
2 participants
@li31727 @johanbrandhorst