Skip to content

Commit 4539be2

Browse files
authored
Merge pull request #383 from DiscoPYF/readmeSerializationOptions
Mention default values of serialization options in readme.
2 parents a490d81 + be4d337 commit 4539be2

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

readme.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,9 @@ All API methods that support passing objects of user-specified data types have a
179179

180180
The options are passed as an instance of the `ApiClientSerializationOptions` class, which contains options for:
181181

182-
- `boolean UseCamelCasePropertyNames`
183-
- `boolean IgnoreNullValues`
182+
- `UseCamelCasePropertyNames` (boolean, default is `false`)
183+
- `IgnoreNullValues` (boolean, default is `true`)
184+
- `UseStringEnumConversion` (boolean, default is `false`)
184185

185186
In addition, the default options can be updated, which will affect all subsequent operations that use these options. To set default options, set them on the serializer implementation itself. For example, if using the supplied `JsonNetApiClientSerialization`:
186187

@@ -189,6 +190,8 @@ var serializer = new JsonNetApiClientSerialization();
189190
serializer.DefaultOptions.IgnoreNullValues = false;
190191
```
191192

193+
Note: the default values were chosen in line with Json.NET default values as it is the default serializer.
194+
192195
### HTTP Request Headers
193196

194197
APIs that support specifying HTTP request headers have an optional method argument to pass in header values.

0 commit comments

Comments
 (0)