[Reporting/Docs] Update Developer API docs#179723
Merged
tsullivan merged 2 commits intoelastic:mainfrom Apr 1, 2024
Merged
Conversation
Contributor
|
A documentation preview will be available soon. Request a new doc build by commenting
If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here. |
tsullivan
commented
Mar 29, 2024
| [float] | ||
| === Generate job URL | ||
| To generate a new reporting job, different export types require different `jobParams` that are Rison encoded into a URL | ||
| that abide by the following convention: `/api/reporting/generate?jobParams=${rison.encode(jobParams)}`. If you use the |
Member
Author
There was a problem hiding this comment.
The stated URL convention isn't completely accurate:
- There is now an
internalversion of the path. - When generating a report in the Kibana UI, the jobParams are given in the POST payload, not the query string
sebelga
approved these changes
Apr 1, 2024
| The `export-config` directive will use the browser's current URL and timezone when generating the job | ||
| parameters automatically. The `export-config` directive will also grab the height/width of the element | ||
| with the `data-shared-items-container` attribute and use this as the dimensions. | ||
| <1> The available `layout.id` options for PDF exports are `preserve_layout`, `print`, and `canvas`. These control how dashboard |
Contributor
There was a problem hiding this comment.
Could we then write the interface like this?
...
layout: {
id: 'preserve_layout' | 'print' | 'canvas";
...
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Summary
Part of documentation updates required for https://github.com/elastic/kibana-team/issues/720