fix: nullable schemas for arrays/slices #527
Conversation
WalkthroughThe recent changes enhance the schema generation logic by allowing array types to contain nullable items. This modification impacts how schemas handle data validation and serialization, ensuring that array elements can explicitly be null. Alongside this, the test cases have been updated to reflect the new schema expectations, improving the robustness and flexibility of data structure definitions. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #527 +/- ##
=======================================
Coverage 92.68% 92.68%
=======================================
Files 22 22
Lines 3843 3844 +1
=======================================
+ Hits 3562 3563 +1
Misses 236 236
Partials 45 45 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- schema.go (1 hunks)
- schema_test.go (10 hunks)
Additional comments not posted (9)
schema.go (1)
749-749: LGTM! But verify the function usage in the codebase.The code changes are approved.
However, ensure that all function calls to
schemaFromTypecorrectly handle the newNullableproperty for arrays.schema_test.go (8)
207-207: LGTM!The code changes are approved.
212-212: LGTM!The code changes are approved.
288-288: LGTM!The code changes are approved.
346-346: LGTM!The code changes are approved.
436-436: LGTM!The code changes are approved.
456-456: LGTM!The code changes are approved.
747-747: LGTM!The code changes are approved.
765-765: LGTM!The code changes are approved.
There was a problem hiding this comment.
LGTM, thanks!
Also worth mentioning: golang/go#37711 and the json/v2 effort linked there which would address some of this. For now at least the schema will match the behavior.
|
Doesn't it depend on the way the slices are initialized ? |
|
Actually I recently ran into the same issue, also using a client generator. I agree that making this feature optional would be better. |
Hi, this is a small fix regarding the schema generation for array/slices.
Since
json.Marshalyieldsnullvalues for empty slices (see #457), this outcome should be explicit in the schema 🙂Summary by CodeRabbit
New Features
Bug Fixes