Scripting: add available languages & contexts API #49652
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds `GET /_script_language` to support Kibana dynamic scripting
language selection.
Response contains whether `inline` and/or `stored` scripts are
enabled as determined by the `script.allowed_types` settings.
For each scripting language registered, such as `painless`,
`expression`, `mustache` or custom, available contexts for the language
are included as determined by the `script.allowed_contexts` setting.
Response format:
```
{
"types_allowed": [
"inline",
"stored"
],
"language_contexts": [
{
"language": "expression",
"contexts": [
"aggregation_selector",
"aggs"
...
]
},
{
"language": "painless",
"contexts": [
"aggregation_selector",
"aggs",
"aggs_combine",
...
]
}
...
]
}
```
Fixes: elastic#49463
stu-elastic
added
>enhancement
:Core/Infra/Scripting
Collaborator
|
Pinging @elastic/es-core-infra (:Core/Infra/Scripting) |
jdconrad
approved these changes
Dec 2, 2019
Contributor
jdconrad
left a comment
jdconrad
left a comment
There was a problem hiding this comment.
This looks great! Thanks for adding this. Just one minor note.
|
|
||
| @Override | ||
| public List<ScriptContext<?>> getSupportedContexts() { | ||
| return List.of(TemplateScript.CONTEXT); |
Contributor
There was a problem hiding this comment.
Note that if we backport this to a version requiring Java 8, List.of wasn't introduced yet.
Contributor
Author
There was a problem hiding this comment.
I intend to address that in the backport. No reason to avoid using it here.
|
|
||
| @Override | ||
| public List<ScriptContext<?>> getSupportedContexts() { | ||
| return List.of(ScoreScript.CONTEXT); |
Contributor
There was a problem hiding this comment.
Same as the comment above.
rjernst
reviewed
Dec 4, 2019
Member
rjernst
left a comment
rjernst
left a comment
There was a problem hiding this comment.
A couple minor comments. Can we please have a javdoc or docs or something with an example of the response structure?
| /** | ||
| * Script contexts supported by this engine. | ||
| */ | ||
| List<ScriptContext<?>> getSupportedContexts(); |
Member
There was a problem hiding this comment.
Why a List when we have the info in Set form already?
|
|
||
| public ScriptLanguagesInfo(StreamInput in) throws IOException { | ||
| typesAllowed = readStringSet(in); | ||
| languageContexts = readStringMapSet(in); |
Member
There was a problem hiding this comment.
this can be readMap(StreamInput::readString, in -> in.readSet(StreamInput::readString)). Similar for the write side. None of the utility read/write methods here should be necessary.
… use readMap(StreamInput::readString
Contributor
Author
Added to |
stu-elastic
added a commit
to stu-elastic/elasticsearch
that referenced
this pull request
Dec 4, 2019
Adds `GET /_script_language` to support Kibana dynamic scripting
language selection.
Response contains whether `inline` and/or `stored` scripts are
enabled as determined by the `script.allowed_types` settings.
For each scripting language registered, such as `painless`,
`expression`, `mustache` or custom, available contexts for the language
are included as determined by the `script.allowed_contexts` setting.
Response format:
```
{
"types_allowed": [
"inline",
"stored"
],
"language_contexts": [
{
"language": "expression",
"contexts": [
"aggregation_selector",
"aggs"
...
]
},
{
"language": "painless",
"contexts": [
"aggregation_selector",
"aggs",
"aggs_combine",
...
]
}
...
]
}
```
Fixes: elastic#49463
stu-elastic
added a commit
that referenced
this pull request
Dec 4, 2019
Adds `GET /_script_language` to support Kibana dynamic scripting
language selection.
Response contains whether `inline` and/or `stored` scripts are
enabled as determined by the `script.allowed_types` settings.
For each scripting language registered, such as `painless`,
`expression`, `mustache` or custom, available contexts for the language
are included as determined by the `script.allowed_contexts` setting.
Response format:
```
{
"types_allowed": [
"inline",
"stored"
],
"language_contexts": [
{
"language": "expression",
"contexts": [
"aggregation_selector",
"aggs"
...
]
},
{
"language": "painless",
"contexts": [
"aggregation_selector",
"aggs",
"aggs_combine",
...
]
}
...
]
}
```
Fixes: #49463
**Backport**
SivagurunathanV
pushed a commit
to SivagurunathanV/elasticsearch
that referenced
this pull request
Jan 23, 2020
Adds `GET /_script_language` to support Kibana dynamic scripting
language selection.
Response contains whether `inline` and/or `stored` scripts are
enabled as determined by the `script.allowed_types` settings.
For each scripting language registered, such as `painless`,
`expression`, `mustache` or custom, available contexts for the language
are included as determined by the `script.allowed_contexts` setting.
Response format:
```
{
"types_allowed": [
"inline",
"stored"
],
"language_contexts": [
{
"language": "expression",
"contexts": [
"aggregation_selector",
"aggs"
...
]
},
{
"language": "painless",
"contexts": [
"aggregation_selector",
"aggs",
"aggs_combine",
...
]
}
...
]
}
```
Fixes: elastic#49463
This was referenced Feb 3, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds
GET /_script_languageto support Kibana dynamic scriptinglanguage selection.
Response contains whether
inlineand/orstoredscripts areenabled as determined by the
script.allowed_typessettings.For each scripting language registered, such as
painless,expression,mustacheor custom, available contexts for the languageare included as determined by the
script.allowed_contextssetting.Response format:
Fixes: #49463