Skip to content

update examples with latest request-converter #5865

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
miguelgrinberg merged 2 commits into from
Jan 14, 2026
Merged

update examples with latest request-converter #5865

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
723b07a
update examples with latest request-converter
miguelgrinberg Dec 18, 2025
13fd964
add java examples
miguelgrinberg Jan 13, 2026
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
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ overlay-docs: ## Apply overlays to OpenAPI documents
rm output/openapi/elasticsearch-openapi-docs.tmp*.json

generate-language-examples:
@npm update --prefix docs/examples @elastic/request-converter
@node docs/examples/generate-language-examples.js
@npm run format:fix-examples --prefix compiler

Expand Down
2 changes: 1 addition & 1 deletion docs/examples/generate-language-examples.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ async function generateLanguages(example) {
const partialRequest = await parseRequest(request);
const java = new JavaCaller({
minimumJavaVersion: 21,
jar: "path/to/converter/jar/java-es-request-converter-1.0-SNAPSHOT.jar",
jar: process.env.JAVA_ES_REQUEST_CONVERTER_JAR,
Copy link
Copy Markdown
Contributor Author

@miguelgrinberg miguelgrinberg Jan 13, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once we merge the Java PR in the request converter we will be able to remove the JavaCaller code and run the Java conversions in the same way as the other languages.

});

let correctParams = getCodeGenParamNames(partialRequest.params, partialRequest.request);
Expand Down
394 changes: 382 additions & 12 deletions docs/examples/languageExamples.json
View file
Open in desktop

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/examples/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion specification/inference/put_azureopenai/examples/request/PutAzureOpenAiRequestExample3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
summary: A chat completion task
description: Run `PUT _inference/chat_completion/azure_openai_chat_completion` to create an inference endpoint that performs a `chat_completion` task.
description:
Run `PUT _inference/chat_completion/azure_openai_chat_completion` to create an inference endpoint that performs a
`chat_completion` task.
method_request: 'PUT _inference/chat_completion/azure_openai_chat_completion'
# type: "request"
value: |-
Expand Down
4 changes: 1 addition & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
summary: A text embedding task
description:
Run `PUT _inference/text_embedding/nvidia-text-embedding` to create an inference endpoint
that performs a `text_embedding` task.
description: Run `PUT _inference/text_embedding/nvidia-text-embedding` to create an inference endpoint that performs a `text_embedding` task.
method_request: 'PUT _inference/text_embedding/nvidia-text-embedding'
# type: "request"
value: |-
Expand Down
6 changes: 3 additions & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
summary: A text embedding task with custom `task_settings` and no `url` parameter
description:
Run `PUT _inference/text_embedding/nvidia-text-embedding` to create an inference endpoint
that performs a `text_embedding` task, specifying custom `task_settings` and omitting the `url` parameter
if model is accessible via default NVIDIA endpoint.
Run `PUT _inference/text_embedding/nvidia-text-embedding` to create an inference endpoint that performs a
`text_embedding` task, specifying custom `task_settings` and omitting the `url` parameter if model is accessible via default
NVIDIA endpoint.
method_request: 'PUT _inference/text_embedding/nvidia-text-embedding'
# type: "request"
value: |-
Expand Down
4 changes: 1 addition & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample3.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
summary: A completion task
description:
Run `PUT _inference/completion/nvidia-completion` to create an inference endpoint
that performs a `completion` task.
description: Run `PUT _inference/completion/nvidia-completion` to create an inference endpoint that performs a `completion` task.
method_request: 'PUT _inference/completion/nvidia-completion'
# type: "request"
value: |-
Expand Down
5 changes: 2 additions & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample4.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
summary: A completion task without `url` parameter
description:
Run `PUT _inference/completion/nvidia-completion` to create an inference endpoint
that performs a `completion` task, omitting the `url` parameter
if model is accessible via default NVIDIA endpoint.
Run `PUT _inference/completion/nvidia-completion` to create an inference endpoint that performs a `completion` task,
omitting the `url` parameter if model is accessible via default NVIDIA endpoint.
method_request: 'PUT _inference/completion/nvidia-completion'
# type: "request"
value: |-
Expand Down
4 changes: 1 addition & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample5.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
summary: A chat completion task
description:
Run `PUT _inference/chat_completion/nvidia-chat-completion` to create an inference endpoint
that performs a `chat_completion` task.
description: Run `PUT _inference/chat_completion/nvidia-chat-completion` to create an inference endpoint that performs a `chat_completion` task.
method_request: 'PUT _inference/chat_completion/nvidia-chat-completion'
# type: "request"
value: |-
Expand Down
5 changes: 2 additions & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample6.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
summary: A chat completion task without `url` parameter
description:
Run `PUT _inference/chat_completion/nvidia-chat-completion` to create an inference endpoint
that performs a `chat_completion` task, omitting the `url` parameter
if model is accessible via default NVIDIA endpoint.
Run `PUT _inference/chat_completion/nvidia-chat-completion` to create an inference endpoint that performs a
`chat_completion` task, omitting the `url` parameter if model is accessible via default NVIDIA endpoint.
method_request: 'PUT _inference/chat_completion/nvidia-chat-completion'
# type: "request"
value: |-
Expand Down
4 changes: 1 addition & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample7.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
summary: A rerank task
description:
Run `PUT _inference/rerank/nvidia-rerank` to create an inference endpoint
that performs a `rerank` task.
description: Run `PUT _inference/rerank/nvidia-rerank` to create an inference endpoint that performs a `rerank` task.
method_request: 'PUT _inference/rerank/nvidia-rerank'
# type: "request"
value: |-
Expand Down
5 changes: 2 additions & 3 deletions specification/inference/put_nvidia/examples/request/PutNvidiaRequestExample8.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
summary: A rerank task without `url` parameter
description:
Run `PUT _inference/rerank/nvidia-rerank` to create an inference endpoint
that performs a `rerank` task, omitting the `url` parameter
if model is accessible via default NVIDIA endpoint.
Run `PUT _inference/rerank/nvidia-rerank` to create an inference endpoint that performs a `rerank` task, omitting the
`url` parameter if model is accessible via default NVIDIA endpoint.
method_request: 'PUT _inference/rerank/nvidia-rerank'
# type: "request"
value: |-
Expand Down
Loading