Skip to content

Make the generated schema be more consistent with the serializer behaviour#21

Merged
panesofglass merged 28 commits intofsprojects:masterfrom
moinessim:master
Mar 16, 2025
Merged

Make the generated schema be more consistent with the serializer behaviour#21
panesofglass merged 28 commits intofsprojects:masterfrom
moinessim:master

Conversation

@moinessim
Copy link
Collaborator

@moinessim moinessim commented Jul 12, 2023

  • Make (Non optional/nullable/skippable) record fields be required.
    Fixes Question: How does one generate the JsonSchema "required" field #9
  • Do not unwrap single case unions: This allows them to roundtrip serialization and validation.
  • Use NJsonSchema setting to generate documentation fields for the schema, based on F# comments (generated xml docs).
    Got it to work for records, but not for unions, yet.
  • Use context.ContextualType.Type instead of context.Type, since it is deprecated.

Moises Nessim and others added 28 commits May 30, 2023 20:36
Update version of FSharp.SystemTextJson to 1.1.23
7dfc0a2 
Use net6.0 since net5.0 is not supported

Use fluid version of JsonConverterOptions

Allow SkippableOptionFields, since the lack of it was causing tests to fail
Serializer: UnwrapFieldlessTags
56cdb7c
Windows: run tests in net6.0
c06727d
@moinessim
Merge pull request #1 from moinessim/update-fsharp.systemtextjson
3971a89 
Update fsharp.systemtextjson
JsonSchema: Use VerifyTests
5398d0f 
[B1PC-4]
Make all non-optional fields required in the schema
7492fe5 
Refactor the serializer options to be more DRY

Modify and fix tests

[B1PC-4]
Schema Generator: Do not require record properties that have OneOf Null
7c521c1 
[B1PC-4]
Do not unwrap single case unions
ab1229e 
so that they can be validated and roundtripped correctly.

[B1PC-4]
Use F# XmlDocumentation to generate documentation for the schema
a1fa6f8 
[B1PC-4]
Use context.ContextualType.Type intead of context.Type, since it is d…
0ddc208 
…eprecated

[B1PC-4]
Test that data annotations are generated properly for records
18d7638 
[B1PC-4]
Add test for interdepenedent recursive types
ade2dc8 
[B1PC-4]
Support mutually recursive MultiCaseDUs by passing the current contex…
c219949 
…t resolver

to the Generator.Generate method

Do not process reference schemas, to avoid infinite recursion

Avoid double dictionary lookups by returning a tuple

[B1PC-4]
Pass the current context.Resolver to the generator in the OptionSchem…
6ecc898 
…aProcessor

[B1PC-4]
MultiCaseDU: Do not cache field schemas locally
c7b208f 
The generator will use the existent cache in the passed resolver

[B1PC-4]
MultiCaseDU: Add generated schema to resolver if it has not been adde…
bd0b6e1 
…d yet.

[B1PC-4]
MultiCaseDU: Make sure that all generated schemas are added to the re…
5910089 
…solver

[B1PC-4]
Target net8.0
f64b9f9
Conditionally change PackageId so I can test nuget package deployment
a284174
Run CI on pre-release veriosn tags
62be598
Fix fsproj packageid condition
f2c8776 
Set Version before build

Use net8.0 in build.sh
Fix Version
8b9fb1d
Push nupkg with optional prefix
de9ea79
Fix --no-symbols param by removing 'true'
24b2c85
Support parent DU case with same name
9cd155f
Support ValueOption
cd386ed
Use actions/upload-artifact@v4
a0d8632
@moinessim
Merge pull request #3 from moinessim/support-value-option
5a3b962 
Support value option
@panesofglass panesofglass merged commit a6bd999 into fsprojects:master Mar 16, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@panesofglass panesofglass panesofglass approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Question: How does one generate the JsonSchema "required" field

2 participants

@moinessim @panesofglass