Ignore specific markers in openapi generation from protos #576
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Issues linked to changelog: |
shashankram
approved these changes
Aug 8, 2024
Comment on lines
+111
to
+115
| baseArgument := "--openapi_out=yaml=true,single_file=false,include_description=true,multiline_description=true,proto_oneof=true,int_native=true" | ||
| baseArgument = fmt.Sprintf("%s,enum_as_int_or_string=%v", baseArgument, o.EnumAsIntOrString) | ||
| baseArgument = fmt.Sprintf("%s,additional_empty_schema=%v", baseArgument, strings.Join(o.MessagesWithEmptySchema, "+")) | ||
| baseArgument = fmt.Sprintf("%s,disable_kube_markers=%v", baseArgument, o.DisableKubeMarkers) | ||
| baseArgument = fmt.Sprintf("%s,ignored_kube_marker_substrings=%v", baseArgument, strings.Join(o.IgnoredKubeMarkerSubstrings, "+")) |
There was a problem hiding this comment.
If you want to make this more readable, I'd group these options into a slice and use strings.Join().
There was a problem hiding this comment.
Yeah honestly I should have done that. I think this is better than what we have, so if we revisit this and add another argument we could improve this again.
k8so
approved these changes
Aug 8, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This allows for the user to define a list of kube markers to be ignored. Useful when referencing a .proto dependency which contains kube markers that aren't supported, and will never be supported.
Use case: I'm defining a proto that relies on some upstream dependency that also contains their own kube markers. These kube markers exist only for documentation, and do not affect the open api schema. Rather than implement noop markers to add to a marker registry, I would like to simply ignore them.
This adds:
This changes:
Related Issue: solo-io/protoc-gen-openapi#27
Testing Done
See parent PR