Skip to content

Add ref to java examples in api docs #1157

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.

Sign up for GitHub

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

Merged
l-trotta merged 1 commit into from
Feb 4, 2026
Merged

Add ref to java examples in api docs #1157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/reference/images/create-api-java-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 7 additions & 0 deletions docs/reference/usage/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ mapped_pages:

# Using the Java API client [usage]

## Code Examples

The Elasticsearch [API reference](https://www.elastic.co/docs/api/doc/elasticsearch/) provides examples of requests in various languages, including Java, available in the dropdown menu on the right.

![Create API java example](../images/create-api-java-example.png)

## General Usage
The sections below provide tutorials on the most frequently used and some less obvious features of {{es}}.

For a full reference, see the [Elasticsearch documentation](docs-content://get-started/index.md) and in particular the [REST APIs](elasticsearch://reference/elasticsearch/rest-apis/index.md) section. The Java API Client follows closely the JSON structures described there, using the [Java API conventions](/reference/api-conventions/index.md).
Expand Down
Loading