[dart-dio] fix the issue of multi layer issues with dart-dio code generation
This fixes the issues with multi layer class using oneOf in dart-dio
fixes #15467
The PR includes test for dart-dio, which are using the example from the ticket
@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08)
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:
(For Windows users, please run the script in WSL)./mvnw clean package || exit ./bin/generate-samples.sh ./bin/configs/*.yaml || exit ./bin/utils/export_docs_generators.sh || exit
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(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks) - If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having
"fixes #123"present in the PR description) - If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
Summary by cubic
Fixes multi-level oneOf/anyOf discriminator dispatch and unifies path/query/form encoding in dart-dio, preventing wrong model selection and unsafe/incorrect serialization (enums, nulls, collections, and reserved path characters). Old behavior: parent-first discriminator checks and ad-hoc encoders that emitted Dart enum identifiers, kept nulls, mishandled containers, and left path values unencoded. New behavior: inheritance-aware discriminator mapping and dedicated encoders that produce wire values, drop nulls safely, handle collections/iterables, and URI-encode path segments.
- Discriminators: honor only schema-declared mappings for local discriminators; for inherited discriminators include true allOf descendants plus the schema's oneOf/anyOf; order checks by inheritance depth (fixes #15467, #23717).
- Path params: use
encodePathParameter(...)throughout; URI-encodes reserved chars and emits enum wire values (via serializers) instead of Dart identifiers;built_valueuses serializers for enum wire names and supports lists/maps/iterables withListFormat. - Query/form params: unify to
encodeParameter(...); drop optional null form parameters without sending empty strings; keep required nullable form entries; handle nullable query collection items; shipapi_util.dartfor bothbuilt_valueandjson_serializable. - Serializers: generate
ListBuilder<T?>/SetBuilder<T?>when item types are nullable to align withFullType.nullable(...). - Tests/samples: add coverage for local vs inherited discriminators, enum wire-value encoding in path params and collections, iterable path serialization, required-nullable form signatures, and nullable collection item serialization; regenerate
dart-diosamples accordingly.