[Docs/Reporting] More information about HTTP / script stuff #41200
Conversation
This file contains 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
tsullivan
added
review
Team:Docs
(Deprecated) Feature:Reporting
|
Pinging @elastic/kibana-docs |
|
Pinging @elastic/kibana-app |
tsullivan
commented
Jul 15, 2019
tsullivan
commented
Jul 15, 2019
|
|
||
| - **`200` (OK)**: As expected, Kibana returns `200` status in the response for | ||
| successful requests to queue or download reports. | ||
| + |
There was a problem hiding this comment.
note: easy-to-miss soft line break here
tsullivan
commented
Jul 15, 2019
tsullivan
commented
Jul 15, 2019
|
|
||
| If there was an error in generating the report, the download URL will return a 500 | ||
| (Internal Server Error) response. More information is available in the | ||
| Reporting management page in Kibana: *Management > Kibana > Reporting* |
There was a problem hiding this comment.
All this is moved to a standalone section, because it grew pretty large
💚 Build Succeeded |
💔 Build Failed |
gchaps
reviewed
Jul 18, 2019
|
|
||
| - **`503` (Service Unavailable)**: When using the `path` to request the download, you will get | ||
| a `503` status response if report generation hasn't completed yet. In that case, | ||
| retry after the number of seconds in the `Retry-After` header in the download API |
There was a problem hiding this comment.
This sentence is confusing:
In that case, retry after the number of seconds in the Retry-After header in the download API response until the report is complete.
There was a problem hiding this comment.
I see what you mean. How about:
When using the
pathto request the download, you will get a503status response if report generation hasn't completed yet. A503response comes with aRetry-Afterheader. Before trying again to download the report, you can have your script wait the suggested number of seconds found in theRetry-Afterheader until the report is complete.
Co-Authored-By: gchaps <[email protected]>
… into docs/reporting-post-url
💚 Build Succeeded |
💚 Build Succeeded |
tsullivan
added a commit
to tsullivan/kibana
that referenced
this pull request
Jul 18, 2019
…41200) * [Docs/Reporting] More information about HTTP / script stuff * "post url" formatting consistency * consistent wording from 1 paragraph to another * Update docs/reporting/response-codes.asciidoc Co-Authored-By: gchaps <[email protected]> * pr feedback * subs=attributes, version in command example * "Retry-After" content * another feedback
tsullivan
added a commit
to tsullivan/kibana
that referenced
this pull request
Jul 18, 2019
…41200) * [Docs/Reporting] More information about HTTP / script stuff * "post url" formatting consistency * consistent wording from 1 paragraph to another * Update docs/reporting/response-codes.asciidoc Co-Authored-By: gchaps <[email protected]> * pr feedback * subs=attributes, version in command example * "Retry-After" content * another feedback
tsullivan
added a commit
to tsullivan/kibana
that referenced
this pull request
Jul 18, 2019
…41200) * [Docs/Reporting] More information about HTTP / script stuff * "post url" formatting consistency * consistent wording from 1 paragraph to another * Update docs/reporting/response-codes.asciidoc Co-Authored-By: gchaps <[email protected]> * pr feedback * subs=attributes, version in command example * "Retry-After" content * another feedback
tsullivan
added a commit
that referenced
this pull request
Jul 18, 2019
…41523) * [Docs/Reporting] More information about HTTP / script stuff * "post url" formatting consistency * consistent wording from 1 paragraph to another * Update docs/reporting/response-codes.asciidoc Co-Authored-By: gchaps <[email protected]> * pr feedback * subs=attributes, version in command example * "Retry-After" content * another feedback
tsullivan
added a commit
that referenced
this pull request
Jul 18, 2019
…41524) * [Docs/Reporting] More information about HTTP / script stuff * "post url" formatting consistency * consistent wording from 1 paragraph to another * Update docs/reporting/response-codes.asciidoc Co-Authored-By: gchaps <[email protected]> * pr feedback * subs=attributes, version in command example * "Retry-After" content * another feedback
tsullivan
added a commit
that referenced
this pull request
Jul 18, 2019
…41525) * [Docs/Reporting] More information about HTTP / script stuff * "post url" formatting consistency * consistent wording from 1 paragraph to another * Update docs/reporting/response-codes.asciidoc Co-Authored-By: gchaps <[email protected]> * pr feedback * subs=attributes, version in command example * "Retry-After" content * another feedback
💚 Build Succeeded |
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.
Follows #40931
This moves text from an
importantnote to its own section:HTTP Response Codes: