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

[Swift4] accept empty content with default client #7921

Merged
merged 3 commits into from
Apr 6, 2018

Conversation

d-date
Copy link
Contributor

@d-date d-date commented Mar 27, 2018

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: 3.0.0 branch for changes related to OpenAPI spec 3.0. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

To fix #7850, we accept Void response as empty body. This behavior is same as PromiseKit and RxSwift response

Breaking Change

By merging this PR, for using default client users, they need to change response as follow warnings by compiler.

Before:

FakeAPI.deletePet(id: "1000") { (error) in
  if error == nil { // error will be tuple contain (response, error), so compiler will show `error == nil always true`
    // success
  }
}

After:

FakeAPI.deletePet(id: "1000") { (response, error) in
  if error == nil { 
    // still means success
  }

  if let _ = response {
   // this also means success
  }
}

or you can ignore response as below.

FakeAPI.deletePet(id: "1000") { (_, error) in
  if error == nil { 
    // still means success
  }
}

@wing328
Copy link
Contributor

wing328 commented Mar 30, 2018

Thanks for the PR.

cc @jgavris @ehyche @Edubits @jaz-ah for review

@jgavris
Copy link
Contributor

jgavris commented Mar 31, 2018

+1 We've actually been doing this, but didn't want to do a breaking change! What do the others think?

@jaz-ah
Copy link
Contributor

jaz-ah commented Apr 4, 2018

@jgavris I think it's ok to add this as a breaking change to 3.0.0 which already has a lot of other breaking changes...

@wing328 wing328 added this to the v2.4.0 milestone Apr 6, 2018
@wing328 wing328 merged commit 40d5d09 into swagger-api:master Apr 6, 2018
@d-date d-date deleted the swift-accept-empty-content branch April 6, 2018 07:08
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.

[Swift4] 204 No Content returns error
4 participants