Feat: Add freezed serialization to dart-dio generator #13047

bahag-chandrana · 2022-07-31T13:19:25Z

This PR is aimed at adding the freezed serialization to the dart-dio generator. The changes were actually copied from changes made on old branch which was tested extensively in personal projects. Since the branches diverged I have migrated the changes to the freshly cloned branch.

The new changes could be tested by simply changing the serialization library to freezed.

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/utils/export_docs_generators.sh
```
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*.
For Windows users, please run the script in Git BASH.
File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.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.
@jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12) @ahmednfwela (2021/08)

TODO's:

Add support of oneOf/anyOf/allOf
Union based ResponseType
Required tests to validate changes

ahmednfwela · 2022-08-01T04:56:16Z

can you base your PR on #12295 ? It will help with oneOf/anyOf integration

bahag-chandrana · 2022-08-01T06:56:39Z

can you base your PR on #12295 ? It will help with oneOf/anyOf integration

I thought it is BuiltValue specific changes..! Also haven't quite understood yet what is happening in the adaptToDartInheritance method. If it's a general change, I will look into little more in detail and see if I can use it as well.

ahmednfwela · 2022-08-01T07:00:03Z

my PR affects only built_value , but since you are modifying java files, it's best to rebase it on mine

bahag-chandrana · 2022-08-01T08:59:22Z

my PR affects only built_value , but since you are modifying java files, it's best to rebase it on mine

Wouldn't it make sense for me to rebase it from main once your PR is merged to main. I was thinking more in that line.

ahmednfwela · 2022-08-01T09:05:32Z

if you are willing to wait until mine is merged, then yeah sure
I just wanted to help add oneOf support

kuhnroyal · 2022-09-06T22:17:40Z

I think we could rebase this now and get freezed finally going.

bahag-chandrana · 2022-09-12T15:55:16Z

I will work on it this week to rebase and see if could also include oneOf/anyOf support in freezed.

…freezed # Conflicts: # modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/DartDioClientCodegen.java # modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/api/imports.mustache # modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/class.mustache # modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/enum.mustache

ahmednfwela · 2022-09-23T16:45:41Z

...generator/src/main/resources/dart/libraries/dio/serialization/freezed/variable_type.mustache

+}}
+
+{{#required}}
+    {{#required}}required {{/required}}{{#isContainer}}{{baseType}}<{{#isMap}}String, {{/isMap}}{{#items}}{{>serialization/built_value/variable_type}}{{/items}}>{{/isContainer}}{{^isContainer}}{{{datatypeWithEnum}}}{{/isContainer}}{{#isNullable}}?{{/isNullable}}


if this is going to depend on serialization/built_value/variable_type, shouldn't we move it outside the built_value directory ?

Already changed it locally.. 😄 will be up in the next merge.. 👍

oravecz · 2022-11-14T21:45:02Z

Looks like this approval failed because of a test failure? When looking at the logs, it seems to be a temporary Maven failure. Can someone re-run the test again?

bahag-chandrana · 2022-11-26T10:10:19Z

@ahmednfwela Could you explain me how the new vendor extensions are to be used for the oneOf and anyOf types. I assume allOf all ready works as it should. In this freezed version I deserialize the models based on the descriminator property. This should be sufficient for both anyOf and oneOf as I understood.

bahag-chandrana · 2022-11-26T10:34:43Z

Also anybody know how to map response code to response models. Which mustache template variables can I use to create a union typed response for api endpoints. Meaning if response code is 200 map to model A and response code is 400 map to error model B.

ahmednfwela · 2022-11-26T10:50:50Z

@bahag-chandrana the vendor extensions only describe parent/child relations, and they are:

"x-is-parent": false,
"x-has-self-and-ancestor-only-props": false,
"x-is-child": false,
"x-is-pure": false,
"x-self-only-props": [],
"x-has-ancestor-only-props": false,
"x-has-self-only-props": false,
"x-self-and-ancestor-only-props": [],
"x-ancestor-only-props": []

a pure model is a model with no allOf, oneOf nor anyOf

oneOf and anyOf describe a different problem however.

How do you represent a property that can be either String or num ?

This is why I made the one_of package, so you can do OneOf2<String, num>, and worry about serialization/deserialization later (e.g. in one_of_serializer)

but since Freezed supports unions, you can just do

@freezed
class MyModelUnion with _$MyModelUnion {
  const factory MyModelUnion.asNum(num value) = AsNum;
  const factory MyModelUnion.asString(String value) = AsString;
}

ahmednfwela · 2022-11-26T11:01:29Z

Also anybody know how to map response code to response models.

they exist in the responses object for each operation
e.g.

Details

"responses": [
  {
    "headers": [],
    "responseHeaders": [],
    "code": "200",
    "is1xx": false,
    "is2xx": true,
    "is3xx": false,
    "is4xx": false,
    "is5xx": false,
    "message": "Bar created",
    "dataType": "Bar",
    "baseType": "Bar",
    "hasHeaders": false,
    "isString": false,
    "isNumeric": false,
    "isInteger": false,
    "isShort": false,
    "isLong": false,
    "isUnboundedInteger": false,
    "isNumber": false,
    "isFloat": false,
    "isDouble": false,
    "isDecimal": false,
    "isByteArray": false,
    "isBoolean": false,
    "isDate": false,
    "isDateTime": false,
    "isUuid": false,
    "isEmail": false,
    "isModel": true,
    "isFreeFormObject": false,
    "isAnyType": false,
    "isDefault": false,
    "simpleType": false,
    "primitiveType": false,
    "isMap": false,
    "isArray": false,
    "isBinary": false,
    "isFile": false,
    "isNull": false,
    "schema": {
      "$ref": "#/components/schemas/Bar"
    },
    "jsonSchema": "{\n  \"description\" : \"Bar created\",\n  \"content\" : {\n    \"application/json\" : {\n      \"schema\" : {\n        \"$ref\" : \"#/components/schemas/Bar\"\n      }\n    }\n  }\n}",
    "vendorExtensions": {},
    "uniqueItems": false,
    "exclusiveMinimum": false,
    "exclusiveMaximum": false,
    "vars": [],
    "requiredVars": [],
    "hasValidation": false,
    "additionalPropertiesIsAnyType": false,
    "hasVars": false,
    "hasRequired": false,
    "hasDiscriminatorWithNonEmptyMapping": false,
    "hasMultipleTypes": false,
    "content": {
      "application/json": {
        "schema": {
          "openApiType": "Bar",
          "baseName": "SchemaFor200ResponseBodyApplicationJson",
          "complexType": "Bar",
          "getter": "getSchemaFor200ResponseBodyApplicationJson",
          "setter": "setSchemaFor200ResponseBodyApplicationJson",
          "dataType": "Bar",
          "datatypeWithEnum": "Bar",
          "name": "schemaFor200ResponseBodyApplicationJson",
          "defaultValueWithParam": " = data.SchemaFor200ResponseBodyApplicationJson;",
          "baseType": "Bar",
          "example": "null",
          "jsonSchema": "{\n  \"$ref\" : \"#/components/schemas/Bar\"\n}",
          "exclusiveMinimum": false,
          "exclusiveMaximum": false,
          "required": false,
          "deprecated": false,
          "hasMoreNonReadOnly": false,
          "isPrimitiveType": false,
          "isModel": true,
          "isContainer": false,
          "isString": false,
          "isNumeric": false,
          "isInteger": false,
          "isShort": false,
          "isLong": false,
          "isUnboundedInteger": false,
          "isNumber": false,
          "isFloat": false,
          "isDouble": false,
          "isDecimal": false,
          "isByteArray": false,
          "isBinary": false,
          "isFile": false,
          "isBoolean": false,
          "isDate": false,
          "isDateTime": false,
          "isUuid": false,
          "isUri": false,
          "isEmail": false,
          "isNull": false,
          "isFreeFormObject": false,
          "isAnyType": false,
          "isArray": false,
          "isMap": false,
          "isEnum": false,
          "isInnerEnum": false,
          "isReadOnly": false,
          "isWriteOnly": false,
          "isNullable": false,
          "isSelfReference": false,
          "isCircularReference": false,
          "isDiscriminator": false,
          "vars": [],
          "requiredVars": [],
          "vendorExtensions": {},
          "hasValidation": false,
          "isInherited": false,
          "nameInCamelCase": "SchemaFor200ResponseBodyApplicationJson",
          "nameInSnakeCase": "SCHEMA_FOR200_RESPONSE_BODY_APPLICATION_JSON",
          "uniqueItems": false,
          "isXmlAttribute": false,
          "isXmlWrapped": false,
          "additionalPropertiesIsAnyType": false,
          "hasVars": false,
          "hasRequired": false,
          "hasDiscriminatorWithNonEmptyMapping": false,
          "hasMultipleTypes": false,
          "ref": "#/components/schemas/Bar",
          "schemaIsFromAdditionalProperties": false,
          "datatype": "Bar",
          "iexclusiveMaximum": false,
          "hasItems": false
        },
        "testCases": {}
      }
    },
    "schemaIsFromAdditionalProperties": false,
    "range": false,
    "isPrimitiveType": false,
    "wildcard": false,
    "complexType": "Bar"
  }
]

bahag-chandrana · 2022-11-26T11:08:53Z

I kinda avoided the usual approach in order to utilize the existing models. In freezed we can't use existing data models to build a union. So as an alternative I map oneOf/anyOf as following.

@freezed
class MyModelUnion with _$MyModelUnion {
  const factory MyModelUnion.asObj1({
    required Obj1 obj1;
  }) = AsObj1;
  const factory MyModelUnion.asObj2({
    required Obj2 obj2;
  }) = AsObj2;
}

Then in the fromJson i use the discriminator to map it to the correct model. We use this approach in our project a lot and it works pretty good.

tsinis · 2024-06-07T06:26:40Z

Hey, folks, it will be 2 years since this one is open next month, so I'm curious what this PR's state is. Thanks!

wing328 · 2024-06-16T04:37:44Z

please resolve the merge conflicts (by updating this PR or filing a new one based on this one)

once that's done. please PM me via Slack and we will discuss how to move it forward

https://join.slack.com/t/openapi-generator/shared_invite/zt-12jxxd7p2-XUeQM~4pzsU9x~eGLQqX2g

…criminator and with discriminator mapping.

wing328 · 2024-09-04T08:13:00Z

for tests, i think you will need to add a new config file similar to bin/configs/dart-dio-petstore-client-lib-fake-json_serializable.yaml

and generate the samples (e.g. run ./bin/generate-samples.sh ./bin/configs/dart-dio-*), commit the new files

and add the new sample folder to a new dart-dio workflow file similar to https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-dart.yaml

wing328 · 2024-09-04T08:13:47Z

some mustache files contain tabs which should be replaced with spaces instead

Run /bin/bash ./bin/utils/detect_tab_in_templates.sh


modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/variable_type.mustache:true	   true	     required Type?
modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/variable_type.mustache:true	   false	 required Type
modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/variable_type.mustache:false	   true	     Type?
modules/openapi-generator/src/main/resources/dart/libraries/dio/serialization/freezed/variable_type.mustache:false	   false	 Type?
Template files contain tab '\t'. Please remove it or replace it with [4](https://github.com/OpenAPITools/openapi-generator/actions/runs/10572458452/job/29655285742?pr=13047#step:4:5)-space.

https://github.com/OpenAPITools/openapi-generator/actions/runs/10572458452/job/29655285742?pr=13047

…ing an if else block.

…ld samples of freezed.

bahag-chandrana · 2024-09-07T06:49:22Z

@wing328 Thanks a lot for the feedback.

I have added the samples generated files and the created the workflow yaml as requested. Also fixed the tab issues.

bahag-chandrana · 2024-09-13T10:20:31Z

I am thinking of a better solution for implementing unions using freezed for the oneOf, anyOf cases. So I need some more time to work on this PR.

ArunChapagain · 2025-09-03T16:07:50Z

@bahag-chandrana Are you working on this?

bahag-chandrana · 2025-09-30T09:22:44Z

@ArunChapagain No not yet. I was busy work and personal stuffs. I will try spend some time in the upcoming weeks. I was hoping I could use Macros but now the plan is dropped. So I will refactor the templates to use Sealed Classes + Freezed for better DX. I will keep you all posted here.

# Conflicts: # docs/generators/dart-dio.md # modules/openapi-generator/src/main/resources/dart/libraries/dio/pubspec.mustache

… for anyOF models and models whose descriminators are defined in the parent class.

ArunChapagain · 2025-10-08T12:20:15Z

@wing328 can you please review the changes?

bahag-chandrana · 2025-10-11T06:28:37Z

Now I have done some refactoring and its good to go for a review again.

ArunChapagain · 2025-10-25T16:51:56Z

@wing328 can you review this repo please?

Feat: Initial working changes.

ddf6b5f

bahag-chandrana and others added 9 commits September 22, 2022 17:07

Feat: Initial working changes.

ab69278

fix: small typo.

63c39d6

feat: initial setup for oneOf.

85f3db5

feat: seemingly working oneOf model generation.

e965c65

feat: seemingly working oneOf model generation.

35f0b97

Merge branch 'OpenAPITools:master' into dart-dio-freezed

c19616e

fix: case factory case and add missing sdk dependencies.

899af82

fix: merge issues + use camelCase for unions.

15c756c

ahmednfwela reviewed Sep 23, 2022

View reviewed changes

bahag-chandrana added 4 commits September 24, 2022 17:02

fix: correct use of lambda for cases of classNames

3cfbf98

fix: correct reference to variable_type.mustache

478ac25

fix: non simpleType but primitive response types.

d943167

fix: add correct files for analysis ignore

c1bfa0d

merge master

2723151

bahag-chandrana marked this pull request as ready for review November 26, 2022 10:26

vasilich6107 mentioned this pull request Jun 15, 2024

[REQ] [dart] Generate a copyWith help method on models #3858

Closed

bahag-chandrana added 2 commits August 23, 2024 11:57

merge: master to dart-dio-freezed branch

cbf4262

fix: parsing of oneOF and AnyOf types with no discriminator, with dis…

6bb3aa2

…criminator and with discriminator mapping.

bahag-chandrana added 9 commits September 6, 2024 21:55

fix: parsing of oneOF and AnyOf types with no discriminator simply us…

265dd6e

…ing an if else block.

chore: remove tabs in mustache files.

a5c2f62

test: add samples config yaml for freezed

8ba8b78

test: generate samples for freezed

f969641

fix: small spacing issue

502c9c6

chore: regenerate samples for freezed.

5cd17d5

chore: configure to generate samples in a freezed folder and remove o…

86bf120

…ld samples of freezed.

chore: regenerate samples

6014915

chore: add github workflow file for samples.

d000309

tsinis mentioned this pull request Nov 13, 2024

Upgrade to latest API schemas xvrh/atlassian_apis#43

Open

bahag-chandrana added 3 commits October 5, 2025 10:38

Merge branch 'master' into dart-dio-freezed

61bc2d3

# Conflicts: # docs/generators/dart-dio.md # modules/openapi-generator/src/main/resources/dart/libraries/dio/pubspec.mustache

Fixes the missing discriminator mapping logic. Also handled the cases…

8367bf2

… for anyOF models and models whose descriminators are defined in the parent class.

removes old comments and adds missing mustach reference back.

2253da2

bahag-chandrana added 3 commits October 8, 2025 17:54

Set all freezed unions to be Sealed classes.

e69686b

Set all freezed unions to be Sealed classes.

7f80b9c

Commit files after test running generate-samples.sh

9873202

Uh oh!

Feat: Add freezed serialization to dart-dio generator #13047

Are you sure you want to change the base?

Feat: Add freezed serialization to dart-dio generator #13047

Conversation

bahag-chandrana commented Jul 31, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR checklist

Uh oh!

ahmednfwela commented Aug 1, 2022

Uh oh!

bahag-chandrana commented Aug 1, 2022

Uh oh!

ahmednfwela commented Aug 1, 2022

Uh oh!

bahag-chandrana commented Aug 1, 2022

Uh oh!

ahmednfwela commented Aug 1, 2022

Uh oh!

kuhnroyal commented Sep 6, 2022

Uh oh!

bahag-chandrana commented Sep 12, 2022

Uh oh!

ahmednfwela Sep 23, 2022

Choose a reason for hiding this comment

Uh oh!

bahag-chandrana Sep 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oravecz commented Nov 14, 2022

Uh oh!

bahag-chandrana commented Nov 26, 2022

Uh oh!

bahag-chandrana commented Nov 26, 2022

Uh oh!

ahmednfwela commented Nov 26, 2022

Uh oh!

ahmednfwela commented Nov 26, 2022

Uh oh!

bahag-chandrana commented Nov 26, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

tsinis commented Jun 7, 2024

Uh oh!

wing328 commented Jun 16, 2024

Uh oh!

wing328 commented Sep 4, 2024

Uh oh!

wing328 commented Sep 4, 2024

Uh oh!

bahag-chandrana commented Sep 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

bahag-chandrana commented Sep 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ArunChapagain commented Sep 3, 2025

Uh oh!

bahag-chandrana commented Sep 30, 2025

Uh oh!

ArunChapagain commented Oct 8, 2025

Uh oh!

bahag-chandrana commented Oct 11, 2025

Uh oh!

ArunChapagain commented Oct 25, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

bahag-chandrana commented Jul 31, 2022 •

edited

Loading

bahag-chandrana Sep 24, 2022 •

edited

Loading

bahag-chandrana commented Nov 26, 2022 •

edited

Loading

bahag-chandrana commented Sep 7, 2024 •

edited

Loading

bahag-chandrana commented Sep 13, 2024 •

edited

Loading