feat(csharp): support skipResponseValidation config in c# #5994
Conversation
fern-support
temporarily deployed
to
Fern Dev
GitHub Actions
Inactive
| JsonSerializerOptionsWithFallback = new JsonSerializerOptions(options) | ||
| { | ||
| TypeInfoResolver = new DefaultJsonTypeInfoResolver | ||
| { | ||
| Modifiers = | ||
| { | ||
| static typeInfo => | ||
| { | ||
| foreach (var propertyInfo in typeInfo.Properties) | ||
| { | ||
| // Strip IsRequired constraint from every property. | ||
| propertyInfo.IsRequired = false; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }; |
There was a problem hiding this comment.
The ConfigureJsonSerializerOptions method is an extension point for SDK maintainers so they can customize some of the options.
I think that this would prevent them from modifying the type info resolvers and modifiers like we are doing.
There was a problem hiding this comment.
yeah thats fair, i'm not sure how valuable it is to keep that extension method
|
I'd rather see a single Serialize/Deserialize method. Is there a reason we would surface a validating and non-validating variant at the same time? |
Yes -- we would surface it so that SDK users can decide how they want validation to work. For example, internal consumers of the SDK would turn validation on and external ones would keep it off. |
| @@ -39,4 +58,9 @@ public static T Deserialize<T>(string json) | |||
| { | |||
| return JsonSerializer.Deserialize<T>(json, JsonOptions.JsonSerializerOptions)!; | |||
| } | |||
|
|
|||
| public static T DeserializeWithFallback<T>(string json) | |||
There was a problem hiding this comment.
swap out public -> internal
| @@ -6,6 +6,7 @@ namespace <%= namespace%>; | |||
| internal static partial class JsonOptions | |||
| { | |||
| public static readonly JsonSerializerOptions JsonSerializerOptions; | |||
| public static readonly JsonSerializerOptions JsonSerializerOptionsWithFallback; | |||
Description
Add new configuration
skipResponseValidationto skip response validation. When set to true, the generated client will fail fast if the response schema does not match the generated code. This is particularly useful if you are concerned about your API Definition (e.g. OpenAPI, AsyncAPI) not being entirely correct.Changes Made
JsonUtils.Template.csSDKGeneratorContextthat returnsDeserializeorDeserializeWithFallbacksdepending on the feature flagTesting