Skip to content

[Feedback]: API doc for elasticsearch #1249

Open
@laraMorenoIgle

Description

@laraMorenoIgle

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions