feat: add expand_slashed_path_patterns flag #4813
Conversation
There was a problem hiding this comment.
This is a great start. Could you please make sure to also:
- Add this new flag to the bazel rules for the openapiv2 generator. Just follow the pattern for the other flags.
- Add a small section to our docs about this new flag with some example use cases? The file you want is https://github.com/grpc-ecosystem/grpc-gateway/blob/main/docs/docs/mapping/customizing_openapi_output.md.
Thanks!
|
I created a single clean function that patches the path parts & params only when the flag is turned on. It consumes the parts from the If you pass into the where the path pattern contains snake-kase so the path pattern is camelcased. I believe this is wrong, since only the path parameter names should be camelcased, not other parts of the URI - am I right? |
| @@ -163,6 +163,18 @@ type Registry struct { | |||
|
|
|||
| // enableRpcDeprecation whether to process grpc method's deprecated option | |||
| enableRpcDeprecation bool | |||
|
|
|||
| // expandSlashedPathPatterns, if true, for a path parameter carying a sub-path, described via parameter pattern (i.e. | |||
There was a problem hiding this comment.
| // expandSlashedPathPatterns, if true, for a path parameter carying a sub-path, described via parameter pattern (i.e. | |
| // expandSlashedPathPatterns, if true, for a path parameter carrying a sub-path, described via parameter pattern (i.e. |
| @@ -1145,6 +1156,78 @@ func renderServiceTags(services []*descriptor.Service, reg *descriptor.Registry) | |||
| return tags | |||
| } | |||
|
|
|||
| // expandPathPatterns search the URI parts for path parameters with pattern and when the pattern contains a sub-path, | |||
There was a problem hiding this comment.
| // expandPathPatterns search the URI parts for path parameters with pattern and when the pattern contains a sub-path, | |
| // expandPathPatterns searches the URI parts for path parameters with pattern and when the pattern contains a sub-path, |
| // Parameters: | ||
| // - pathParts: the URI parts parsed from the path template with `templateToParts` function | ||
| // - pathParams: the path parameters of the service binding, this slice will be mutated when the path pattern contains | ||
| // a sub-path with wildcard. |
There was a problem hiding this comment.
| // a sub-path with wildcard. | |
| // a sub-path with a wildcard. |
| // The modified pathParts. Also mutates the pathParams slice. | ||
| func expandPathPatterns(pathParts []string, pathParams *[]descriptor.Parameter) []string { |
There was a problem hiding this comment.
Since this mutates an input, what do you think about returning a parameter of the same type instead? It's a bit gross IMO to mutate the input slice and returning it will make it more explicit.
| // The modified pathParts. Also mutates the pathParams slice. | |
| func expandPathPatterns(pathParts []string, pathParams *[]descriptor.Parameter) []string { | |
| // The modified pathParts and pathParams slice. | |
| func expandPathPatterns(pathParts []string, pathParams []descriptor.Parameter) ([]string, []descriptor.Parameter) { |
| // The modified pathParts. Also mutates the pathParams slice. | ||
| func expandPathPatterns(pathParts []string, pathParams *[]descriptor.Parameter) []string { |
There was a problem hiding this comment.
I just realized that we have a package for parsing these paths already: https://github.com/grpc-ecosystem/grpc-gateway/blob/main/internal/httprule. What do you think about reusing this?
References to other Issues or PRs
Closes #4784 - a feature request
Have you read the Contributing Guidelines?
Yes 👍
Brief description of what is fixed or changed
This adds an experimental flag into the OpenAPI generator, that expands path patterns containing URI sub-paths into the URI with new path parameters. This improves the readability and OpenAPI compatibility of protobuf APIs based on Google AIP. For more context read the linked issue.