Update documents wrt #101

related to FasterXML/jackson-module-kotlin#668
ProjectMapK · May 6, 2023 · bf75281 · bf75281
1 parent d418750
commit bf75281
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/FixedIssues.md b/docs/FixedIssues.md
@@ -12,6 +12,7 @@ A list of issues that have not been resolved in `jackson-module-kotlin`, but hav
 - [About the problem that property names in \`Jackson\` and definitions in \`Kotlin\` are sometimes different\. · Issue \#630](https://github.com/FasterXML/jackson-module-kotlin/issues/630)
 - [Annotation given to constructor parameters containing \`value class\` as argument does not work · Issue \#651](https://github.com/FasterXML/jackson-module-kotlin/issues/651)
 - [How to deserialize a kotlin\.ranges\.ClosedRange<T> with Jackson · Issue \#663](https://github.com/FasterXML/jackson-module-kotlin/issues/663)
+- [There are cases where \`isRequired\` specifications are not properly merged\. · Issue \#668](https://github.com/FasterXML/jackson-module-kotlin/issues/668)
 
 ## Maybe fixed(verification required)
 - [@JsonProperty is ignored on data class properties with names starting with "is" · Issue \#237](https://github.com/FasterXML/jackson-module-kotlin/issues/237)

diff --git a/docs/KogeraSpecificImplementations.md b/docs/KogeraSpecificImplementations.md
@@ -7,7 +7,7 @@ In `jackson-module-kotlin`, functions with getterLike or setterLike names are ha
 On the other hand, this implementation causes discrepancies between the `Kotlin` description and the processing results by `Jackson`.
 
 Therefore, `kogera` processes only `Kotlin Property` and excludes other functions from processing.  
-In addition, `Kogera` uses the content defined in `Kotlin` as its name.
+In addition, `kogera` uses the content defined in `Kotlin` as its name.
 
 These changes make it impossible to manipulate the results using `JvmName`.
 
@@ -17,6 +17,7 @@ In `kogera`, the specification has been revised as follows.
 
 - If `required = true` is specified in the `JsonProperty` annotation, the result is preferred.
     - This should not be overridden, as it will not be `true` unless explicitly specified by the user.
+    - This implementation follows the [basic policy of `Jackson`](https://github.com/ProjectMapK/jackson-module-kogera/pull/101#issuecomment-1527739305).
 - Processing on `field` that has accessors are skipped.
 - The `FAIL_ON_NULL_FOR_PRIMITIVES` option does not affect the results.
     - In `kogera`, the deserialization behavior is not affected by whether the argument is of type `primitive` or not.