Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[dart-dio] Allow dynamic headers and add additional dio parameters #8191

Merged
merged 1 commit into from
Dec 16, 2020

Conversation

kuhnroyal
Copy link
Contributor

  • fixes some compile errors due to header params not being of type String
  • add optional extra and validateStatus parameters from dio to API calls

Contains the same changes as #6915 and fixes compile issues for dart-dio mentioned in #8179.

Regarding the concerns in #6915 about missing changes to the dart generator:

  • dart generator does not expose the header map
  • the http.Client only handles String headers where as dio can handle dynamic headers and does its own serialization of headers

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.

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

ProgressCallback onSendProgress,
ProgressCallback onReceiveProgress,
}) async {
final String _path = '{{{path}}}'{{#pathParams}}.replaceAll('{' r'{{baseName}}' '}', {{{paramName}}}.toString()){{/pathParams}};

final Map<String, dynamic> queryParams = {};
final Map<String, String> headerParams = Map.from(headers ?? {});
final Map<String, dynamic> headerParams = {
if (headers != null) ...headers,
Copy link
Contributor

Choose a reason for hiding this comment

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

never seen this syntax before. basically headerParams gets content of headers if headers is initialised?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ya basically like the ecma spread operator. Works for all collections.

@wing328
Copy link
Member

wing328 commented Dec 16, 2020

@kuhnroyal I just rebased and merged #6915. Can you please rebase this one to resolve the merge conflicts when you've time?

@kuhnroyal
Copy link
Contributor Author

@wing328 On it.

* fixes some compile errors due to header params not being of type `String`
* add optional `extra` and `validateStatus` parameters from dio
@kuhnroyal
Copy link
Contributor Author

@wing328 rebased

@wing328
Copy link
Member

wing328 commented Dec 16, 2020

CircleCI failure not related to this change.

@wing328 wing328 merged commit 96e6bc4 into OpenAPITools:master Dec 16, 2020
@kuhnroyal kuhnroyal deleted the dart-dio/api-parameters branch December 16, 2020 15:33
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.

4 participants