[HttpClient] doc how to cancel a request + upload files #11668
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nicolas-grekas
referenced
this pull request
Jun 5, 2019
|
When merging this into 4.4, don't miss removing the changes done in #11663 |
fabpot
added a commit
to symfony/symfony
that referenced
this pull request
Jun 5, 2019
This PR was merged into the 4.3 branch. Discussion ---------- [HttpClient] add $response->cancel() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#11668 An alternative to #31845 and #31842. Same as #31831 but considered as a bug fix (at the Contracts level), thus for 4.3. I think we're early enough since 4.3/1.1 to do it. That will save us some headaches in the short term. Commits ------- c402418 [HttpClient] add $response->cancel()
symfony-splitter
pushed a commit
to symfony/http-client
that referenced
this pull request
Jun 5, 2019
This PR was merged into the 4.3 branch. Discussion ---------- [HttpClient] add $response->cancel() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#11668 An alternative to #31845 and #31842. Same as #31831 but considered as a bug fix (at the Contracts level), thus for 4.3. I think we're early enough since 4.3/1.1 to do it. That will save us some headaches in the short term. Commits ------- c402418723 [HttpClient] add $response->cancel()
symfony-splitter
pushed a commit
to symfony/contracts
that referenced
this pull request
Jun 5, 2019
This PR was merged into the 4.3 branch. Discussion ---------- [HttpClient] add $response->cancel() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#11668 An alternative to #31845 and #31842. Same as #31831 but considered as a bug fix (at the Contracts level), thus for 4.3. I think we're early enough since 4.3/1.1 to do it. That will save us some headaches in the short term. Commits ------- c402418723 [HttpClient] add $response->cancel()
symfony-splitter
pushed a commit
to symfony/http-client-contracts
that referenced
this pull request
Jun 5, 2019
This PR was merged into the 4.3 branch. Discussion ---------- [HttpClient] add $response->cancel() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#11668 An alternative to #31845 and #31842. Same as #31831 but considered as a bug fix (at the Contracts level), thus for 4.3. I think we're early enough since 4.3/1.1 to do it. That will save us some headaches in the short term. Commits ------- c402418723 [HttpClient] add $response->cancel()
|
This can merged now :) |
OskarStark
reviewed
Jun 7, 2019
d7c3a94 to
d29eb7e
Compare
OskarStark
reviewed
Jun 7, 2019
components/http_client.rst
Outdated
| }, | ||
| ]); | ||
|
|
||
| The exception will be wrapped in an instance of ``TransportExceptionInterface`` |
There was a problem hiding this comment.
Unfortunately the symfony cloud endpoint for this PR is not bootstrapped yet :(
This belongs to the * throw an exception from a progress callback::-Part, but I am not sure if it will be rendered correct with this indention
There was a problem hiding this comment.
Yes, while merging we can reword this to remove the <ul> list and turn it into paragraphs:
To abort a request (e.g. because it didn't complete in due time, or you want to
fetch only the first bytes of the response, etc.), you can either use the ``cancel()``
method of ``ResponseInterface``:
...
Or throw an exception from a progress callback::
...
The exception will be wrapped in an instance of ``TransportExceptionInterface``
and will abort the request.
javiereguiluz
approved these changes
Jun 7, 2019
components/http_client.rst
Outdated
| This means there is usually nothing to configure to have the client work with | ||
| proxies, provided these env vars are properly configured. | ||
|
|
||
| You can still set or override these settings using the `proxy`` and ``no_proxy`` |
There was a problem hiding this comment.
There's a missing opening backtick in proxy:
`proxy`` -> ``proxy``
components/http_client.rst
Outdated
| }, | ||
| ]); | ||
|
|
||
| The exception will be wrapped in an instance of ``TransportExceptionInterface`` |
There was a problem hiding this comment.
Yes, while merging we can reword this to remove the <ul> list and turn it into paragraphs:
To abort a request (e.g. because it didn't complete in due time, or you want to
fetch only the first bytes of the response, etc.), you can either use the ``cancel()``
method of ``ResponseInterface``:
...
Or throw an exception from a progress callback::
...
The exception will be wrapped in an instance of ``TransportExceptionInterface``
and will abort the request.
andreia
suggested changes
Jun 9, 2019
|
Comments addressed, thank you all! |
OskarStark
approved these changes
Jun 10, 2019
|
Thank you Nicolas. |
javiereguiluz
added a commit
that referenced
this pull request
Jun 11, 2019
…(nicolas-grekas) This PR was merged into the 4.3 branch. Discussion ---------- [HttpClient] doc how to cancel a request + upload files Fixes #11658. Needs symfony/symfony#31850 Commits ------- b096999 [HttpClient] doc how to cancel a request + upload files
sadafrangian3
pushed a commit
to sadafrangian3/Dependency-Injection-http-client
that referenced
this pull request
Nov 2, 2022
This PR was merged into the 4.3 branch. Discussion ---------- [HttpClient] add $response->cancel() | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | symfony/symfony-docs#11668 An alternative to #31845 and #31842. Same as #31831 but considered as a bug fix (at the Contracts level), thus for 4.3. I think we're early enough since 4.3/1.1 to do it. That will save us some headaches in the short term. Commits ------- c402418723 [HttpClient] add $response->cancel()
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #11658. Needs symfony/symfony#31850