Fix hidden schema visible in OpenAPI generated yml #3820
Merged
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
adamw
reviewed
Jun 4, 2024
| @@ -44,6 +45,23 @@ private[openapi] class EndpointToOpenAPIPaths( | |||
| (e.showPathTemplate(showQueryParam = None, includeAuth = false, showNoPathAs = "/", showPathsAs = None), pathItem) | |||
| } | |||
|
|
|||
| private def filterOutHiddenInputs(inputs: Vector[EndpointInput.Basic[_]]) = inputs | |||
| .filter { | |||
There was a problem hiding this comment.
- maybe we can combine it in a .collect?
- are we doing filtering on hidden someplace else in this module as well? I think it used to work for e.g. queries, so maybe it's not needed now?
adamw
reviewed
Jun 5, 2024
| variants.filterNot(_.codec.schema.hidden), | ||
| mapping | ||
| ) | ||
| case a: EndpointInput.Atom[_] if !a.codec.schema.hidden => a |
There was a problem hiding this comment.
Maybe add a comment, that a Basic input is either a OneOfBody, or an Atom, so we're not filtering out anything more?
There was a problem hiding this comment.
Collect uses PartialFunction, which is prone to overlooking cases. Maybe filter with a total function is safer so that we explicitly see which cases are rejected, guarded by the compiler?
adamw
approved these changes
Jun 5, 2024
kciesielski
approved these changes
Jun 5, 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.
closes #3617