Skip to content

[Kotlin][Client] Encode default values with kotlinx serialization#19253

Merged
4brunu merged 2 commits intoOpenAPITools:masterfrom
4brunu:feature/kotlin-serializer
Jul 29, 2024
Merged

[Kotlin][Client] Encode default values with kotlinx serialization#19253
4brunu merged 2 commits intoOpenAPITools:masterfrom
4brunu:feature/kotlin-serializer

Conversation

@4brunu
Copy link
Contributor

@4brunu 4brunu commented Jul 26, 2024

Currently kotlinx serialization doesn't encode properties that have the default value, which is a bit strange and can lead to errors.

Here you can find more information about it.

https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/basic-serialization.md#defaults-are-not-encoded-by-default

@Serializable
data class Project(val name: String, val language: String = "Kotlin")

fun main() {
    val data = Project("kotlinx.serialization")
    println(Json.encodeToString(data))
}

This code will have the following output

{"name":"kotlinx.serialization"}

Which will lead to errors if the server is not expecting this behaviour.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@jimschubert (2017/09) ❤️, @dr4ke616 (2018/08) @karismann (2019/03) @Zomzog (2019/04) @andrewemery (2019/10) @4brunu (2019/11) @yutaka0m (2020/03) @stefankoppier (2022/06)

@4brunu 4brunu merged commit 42e8f76 into OpenAPITools:master Jul 29, 2024
@4brunu 4brunu deleted the feature/kotlin-serializer branch July 29, 2024 07:43
@wing328 wing328 added this to the 7.8.0 milestone Aug 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants