Skip to content

Fix SQL explain API rejecting ?format=json parameter #5607

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

Open
gingeekrishna wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −1
Open

Fix SQL explain API rejecting ?format=json parameter #5607

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
6 changes: 5 additions & 1 deletion sql/src/main/java/org/opensearch/sql/sql/domain/SQLQueryRequest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,11 @@ private boolean isSupportedFormat() {
}

private boolean isSupportedExplainFormat() {
return Stream.of("simple", "standard", "extended", "cost").anyMatch(format::equalsIgnoreCase);
// "json" is accepted for backward compatibility: the explain endpoint always returns JSON
// regardless of this parameter, so treating it as valid avoids the 400 regression
// introduced in OpenSearch 3.0. See https://github.com/opensearch-project/sql/issues/4373
return Stream.of("simple", "standard", "extended", "cost", "json")
.anyMatch(format::equalsIgnoreCase);
}

private String getFormat(Map<String, String> params) {
Expand Down
16 changes: 16 additions & 0 deletions sql/src/test/java/org/opensearch/sql/sql/domain/SQLQueryRequestTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,22 @@ public void should_support_explain_format() {
() -> assertTrue(explainRequest.isSupported()));
}

@Test
public void should_support_explain_with_json_format() {
// Regression test for https://github.com/opensearch-project/sql/issues/4373.
// ?format=json was accepted before OpenSearch 3.0 and should continue to be valid.
// The explain endpoint always returns JSON regardless of this parameter.
SQLQueryRequest explainRequest =
SQLQueryRequestBuilder.request("SELECT 1")
.path("_plugins/_sql/_explain")
.params(Map.of("format", "json"))
.build();

assertAll(
() -> assertTrue(explainRequest.isExplainRequest()),
() -> assertTrue(explainRequest.isSupported()));
}

@Test
public void should_not_support_explain_with_unsupported_explain_format() {
SQLQueryRequest explainRequest =
Expand Down
Loading