ENG-11977 Fix logic in getModel to recognize typeless object schemas - #1
Open
robcmills wants to merge 1 commit into
Open
ENG-11977 Fix logic in getModel to recognize typeless object schemas#1robcmills wants to merge 1 commit into
robcmills wants to merge 1 commit into
Conversation
Copy link
Copy Markdown
Collaborator
Sorry, something went wrong.
mracette
approved these changes
Jan 4, 2023
mracette
left a comment
Copy link
Copy Markdown
There was a problem hiding this comment.
Looks great! As mentioned in Slack, I think that we should look into submitting this change as a PR into the upstream library. It would potentially benefit others who are using this library and could reduce the long term maintenance costs that we are taking on by forking it.
Sorry, something went wrong.
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
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
The api client generated from our openapi.json spec file (generated by the backend) had incomplete return types for some methods.
This was due to a bug in the getModel method, whereby if a schema definition passed in had no type property, but was in fact an object (had properties which implies an object), then it would "fall through" all the conditions and return an "empty" model. There was no condition to capture this edge case.
As far as I can tell, the type property is optional, according to the OpenAPI spec, and the properties attribute is used to describe only objects, so its presence allows you to safely assume an object type. This logic was added to the existing object predicate, and a unit test was added to assert it.
Test Plan