Skip to content

[dart][dart-dio] API class/template refactoring#8825

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
kuhnroyal:dart-dio/api-refactoring
Feb 25, 2021
Merged

[dart][dart-dio] API class/template refactoring#8825
wing328 merged 2 commits intoOpenAPITools:masterfrom
kuhnroyal:dart-dio/api-refactoring

Conversation

@kuhnroyal
Copy link
Copy Markdown
Contributor

  • first construct a RequestOptions instance with all parameters etc. inline
  • then construct and serialize the body data
  • then send the request and await the response
  • then deserialize the response
  • always use the specifiedType for built_value (de)serialization instead of a mix of ways (this does the same as finding the serializer directly)
  • use indent of 2 spaces (as per Dart convention)
  • prefix all local variables to prevent name clashes with parameters
  • add 2 tests that (de)serialize collections and add API key header

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, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

CC @swipesight (2018/09) @jaumard (2018/09) @josh-burton (2019/12) @amondnet (2019/12) @sbu-WBT (2020/12) @kuhnroyal (2020/12) @agilob (2020/12)

* first construct a `RequestOptions` instance with all parameters etc. inline
* then construct and serialize the body data
* then send the request and await the response
* then deserialize the response
* always use the `specifiedType` for built_value (de)serialization instead of a mix of ways (this does the same as finding the serializer directly)
* use indent of 2 spaces (as per Dart convention)
* prefix all local variables to prevent name clashes with parameters
@auto-labeler
Copy link
Copy Markdown

auto-labeler Bot commented Feb 24, 2021

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

@kuhnroyal
Copy link
Copy Markdown
Contributor Author

Hiding whitespace changes when reviewing, makes it easier.

}..removeWhere((_, dynamic value) => value == null),
queryParameters: <String, dynamic>{
r'status': status,
}..removeWhere((_, dynamic value) => value == null),
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.

that looks a lot better

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.

I think I will remove this soon and add nullable handling to the parameters

@wing328 wing328 added the Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. label Feb 25, 2021
@wing328 wing328 added this to the 5.1.0 milestone Feb 25, 2021
@wing328 wing328 merged commit fbe2bb7 into OpenAPITools:master Feb 25, 2021
@kuhnroyal kuhnroyal deleted the dart-dio/api-refactoring branch February 25, 2021 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Client: Dart Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants