Skip to content

[Feedback]: API doc for elasticsearch #1249

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

Open
laraMorenoIgle opened this issue Apr 24, 2025 · 0 comments
Open

[Feedback]: API doc for elasticsearch #1249

laraMorenoIgle opened this issue Apr 24, 2025 · 0 comments
Labels
api-feedback needs-team Issues pending triage by the Docs Team

Comments

@laraMorenoIgle
Copy link

Was the documentation helpful?

Yes

What documentation page is affected

https://www.elastic.co/docs/api/doc/elasticsearch/

Description

When consulting the usage of a particular API, it is easy to scroll up or down so you jump into the explanation of the previous or following api.

In my opinion, It would be better that clicking on a particular API only displays the info of such an API on the right side panel and that by scrolling you couldn't jump into a different api.

Apart from that current text format, makes it difficult to, for instance, quickly spot the allowed parameters. I would change the format, for instance, instead of using black, use blue color to be able to see them at a glance.

As an example, in the following screenshot, I would change the refresh, requests_per_second, scroll, etc color (the same for light mode)

Image
@github-actions github-actions bot added the needs-team Issues pending triage by the Docs Team label Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-feedback needs-team Issues pending triage by the Docs Team
Projects
None yet
Development

No branches or pull requests

2 participants