Skip to content

[dart-dio] fix endpoints returning null#15433

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
Bdaya-Dev:handle_null_returns
May 8, 2023
Merged

[dart-dio] fix endpoints returning null#15433
wing328 merged 2 commits intoOpenAPITools:masterfrom
Bdaya-Dev:handle_null_returns

Conversation

@ahmednfwela
Copy link
Copy Markdown
Contributor

@ahmednfwela ahmednfwela commented May 5, 2023

Modify mustache files to handle cases where the response data is null (e.g. status code 204) instead of throwing an exception
fixes #15426

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.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.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)

@ahmednfwela
Copy link
Copy Markdown
Contributor Author

@wing328

{{#returnType}}

{{{returnType}}} _responseData;
{{{.}}}? _responseData;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't we know if the response may be null? Maybe we can also change the operation generic return type?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it won't matter since the final response.data is nullable anyway

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

True, that's a dio probelm.

@wing328 wing328 added this to the 6.6.0 milestone May 8, 2023
@wing328 wing328 merged commit 3d722c1 into OpenAPITools:master May 8, 2023
@ahmednfwela ahmednfwela deleted the handle_null_returns branch May 8, 2023 17:27
@AyushBherwani1998
Copy link
Copy Markdown

AyushBherwani1998 commented Dec 15, 2023

@wing328 @ahmednfwela we should allow developers to define whether they want the response to be nullable or not, data being nullable adds lots of check for the null value. For some usecases, if the data is null, we may want to throw an exception. It should be customisable IMO. Your thoughts?

@ahmednfwela
Copy link
Copy Markdown
Contributor Author

having the response nullable suits all cases, and then devs can throw exceptions them selves if the response is null

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] [dart-dio] Handle nullable responses correctly

5 participants