Skip to content
GitLab

[dart][dart-dio] Nullable support/improvements

Closed Peter Leibiger requested to merge github/fork/kuhnroyal/dart-dio/nullable-improvements into 5.1.x

dart-dio/built_value

  • Disable all fields nullable by default: This is not in line with OAS and will prevent future Dart nullabilty features (NNBD) from being useful as all types would be optional.

  • Properties are @nullable when not required AND not nullable

  • Support nullable/required fields in JSON

    • properties in built_value need to be @nullable when they are nullable in OAS or when they are not required in OAS
    • built_value does not support serializing null values by default as it is based on a serialization format based on iterables/lists and not maps
    • dart-dio uses the built_value json plugin to convert the built_value format to regular json
    • by generating a custom serializer for each class we can add support for serializing null values if the property is required AND nullable in OAS
    • this is a breaking change as not all properties in the models are nullable by default anymore

Dart

  • basically just serialize null when the field is required and nullable

This is based on https://github.com/OpenAPITools/openapi-generator/pull/8220 which needs to be merged first.

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.