Count types referenced from resources and warn about excessive ones #68
Conversation
This file contains hidden or 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
t0yv0
approved these changes
Apr 18, 2024
danielrbradley
approved these changes
Apr 19, 2024
iwahbe
reviewed
Apr 19, 2024
Comment on lines
+52
to
+56
| if len(ts.OneOf) > 0 { | ||
| for _, t := range ts.OneOf { | ||
| countType(schema, &t, visitedTypes) | ||
| } | ||
| } |
There was a problem hiding this comment.
This is a pointless check, since it is safe to range over []T{} and []T(nil).
Suggested change
| if len(ts.OneOf) > 0 { | |
| for _, t := range ts.OneOf { | |
| countType(schema, &t, visitedTypes) | |
| } | |
| } | |
| for _, t := range ts.OneOf { | |
| countType(schema, &t, visitedTypes) | |
| } |
Comment on lines
+57
to
+58
| if strings.HasPrefix(ts.Ref, "#/types/") { | ||
| typeName := strings.TrimPrefix(ts.Ref, "#/types/") |
There was a problem hiding this comment.
The standard library has a function for exactly this purpose.
Suggested change
| if strings.HasPrefix(ts.Ref, "#/types/") { | |
| typeName := strings.TrimPrefix(ts.Ref, "#/types/") | |
| if typeName, ok := strings.CutPrefix(ts.Ref, "#/types/") { |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Our docs currently have a limitation of displaying max 200 types on a resource API page.
This PR introduces a new types of check for the situation when a given resource
We can look at those warnings and see if we can maybe optimize the type structure before it's shipped to end users.