Skip to content
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

Jump to bottom

Create a REST API to describe basic scripting context information #47411

Closed
jdconrad opened this issue Oct 1, 2019 · 1 comment · Fixed by #48319
Closed

Create a REST API to describe basic scripting context information #47411

jdconrad opened this issue Oct 1, 2019 · 1 comment · Fixed by #48319
Assignees
@stu-elastic
Labels
:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >enhancement v7.6.0 v8.0.0-alpha1

Comments

@jdconrad
Copy link
Contributor

jdconrad commented Oct 1, 2019

Create an internal REST API that will do the following calls:

  1. GET a list of available script context names
  2. GET information about a specific script context taking in the script context name as a url parameter; this information should include the signature of the execute method, and information about the get* methods

The goal of this API is to be available to pull basic information for creating an auto-complete engine for a Painless editor. A future extension of this API will likely include more information about individual variables available within the script context that will be used to construct automated documentation.
@jdconrad jdconrad added >enhancement :Core/Infra/Scripting Scripting abstractions, Painless, and Mustache v8.0.0 v7.5.0 labels Oct 1, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-infra (:Core/Infra/Scripting)

stu-elastic added a commit to stu-elastic/elasticsearch that referenced this issue Oct 7, 2019
@stu-elastic
SCRIPTING rest get api - script context names
ed05f8a 
GET _script_context fetches the names of script contexts.
This API will support the auto-complete engine for a painless editor.

Refs: elastic#47411
stu-elastic added a commit to stu-elastic/elasticsearch that referenced this issue Oct 14, 2019
@stu-elastic
Scripting: get context names REST API
065bade 
Adds `GET /_script_context`, returning a `contexts` object with each
available context as a key whose value is an empty object. eg.
```
{
  "contexts": {
    "aggregation_selector": {},
    "aggs": {},
    "aggs_combine": {},
...
  }
}
```

refs: elastic#47411
@stu-elastic stu-elastic mentioned this issue Oct 14, 2019
Merged
stu-elastic added a commit that referenced this issue Oct 16, 2019
@stu-elastic
Scripting: get context names REST API (#48026)
c6037dc 
Adds `GET /_script_context`, returning a `contexts` object with each
available context as a key whose value is an empty object. eg.
```
{
  "contexts": {
    "aggregation_selector": {},
    "aggs": {},
    "aggs_combine": {},
...
  }
}
```

refs: #47411
stu-elastic added a commit to stu-elastic/elasticsearch that referenced this issue Oct 16, 2019
@stu-elastic
Scripting: get context names REST API (elastic#48026)
1311835 
Adds `GET /_script_context`, returning a `contexts` object with each
available context as a key whose value is an empty object. eg.
```
{
  "contexts": {
    "aggregation_selector": {},
    "aggs": {},
    "aggs_combine": {},
...
  }
}
```

refs: elastic#47411
@stu-elastic stu-elastic mentioned this issue Oct 16, 2019
Merged
stu-elastic added a commit that referenced this issue Oct 17, 2019
@stu-elastic
Scripting: get context names REST API (#48026) (#48168)
356eef0 
Adds `GET /_script_context`, returning a `contexts` object with each
available context as a key whose value is an empty object. eg.
```
{
  "contexts": {
    "aggregation_selector": {},
    "aggs": {},
    "aggs_combine": {},
...
  }
}
```

refs: #47411
stu-elastic added a commit to stu-elastic/elasticsearch that referenced this issue Oct 21, 2019
@stu-elastic
Scripting: fill in get contexts REST API
990e65e 
Updates response for `GET /_script_context`, returning a `contexts`
object with a list of context description objects.  The description
includes the context name and a list of methods available.  The
methods list has the signature for the `execute` mathod and any
getters. eg.
```
{
  "contexts": [
     {
       "name" : "moving-function",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [
             {
               "type" : "java.util.Map",
               "name" : "params"
             },
             {
               "type" : "double[]",
               "name" : "values"
             }
           ]
         }
       ]
     },
     {
       "name" : "number_sort",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [ ]
         },
         {
           "name" : "getDoc",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "getParams",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "get_score",
           "return_type" : "double",
           "params" : [ ]
         }
       ]
     },
...
  ]
}
```

fixes: elastic#47411
stu-elastic added a commit to stu-elastic/elasticsearch that referenced this issue Oct 21, 2019
@stu-elastic
Scripting: fill in get contexts REST API
e6574dc 
Updates response for `GET /_script_context`, returning a `contexts`
object with a list of context description objects.  The description
includes the context name and a list of methods available.  The
methods list has the signature for the `execute` mathod and any
getters. eg.
```
{
  "contexts": [
     {
       "name" : "moving-function",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [
             {
               "type" : "java.util.Map",
               "name" : "params"
             },
             {
               "type" : "double[]",
               "name" : "values"
             }
           ]
         }
       ]
     },
     {
       "name" : "number_sort",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [ ]
         },
         {
           "name" : "getDoc",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "getParams",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "get_score",
           "return_type" : "double",
           "params" : [ ]
         }
       ]
     },
...
  ]
}
```

fixes: elastic#47411
@stu-elastic stu-elastic mentioned this issue Oct 21, 2019
Merged
stu-elastic added a commit that referenced this issue Oct 28, 2019
@stu-elastic
Scripting: fill in get contexts REST API (#48319)
0f1b076 
* Scripting: fill in get contexts REST API

Updates response for `GET /_script_context`, returning a `contexts`
object with a list of context description objects.  The description
includes the context name and a list of methods available.  The
methods list has the signature for the `execute` mathod and any
getters. eg.
```
{
  "contexts": [
     {
       "name" : "moving-function",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [
             {
               "type" : "java.util.Map",
               "name" : "params"
             },
             {
               "type" : "double[]",
               "name" : "values"
             }
           ]
         }
       ]
     },
     {
       "name" : "number_sort",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [ ]
         },
         {
           "name" : "getDoc",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "getParams",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "get_score",
           "return_type" : "double",
           "params" : [ ]
         }
       ]
     },
...
  ]
}
```

fixes: #47411
stu-elastic added a commit to stu-elastic/elasticsearch that referenced this issue Oct 28, 2019
@stu-elastic
Scripting: fill in get contexts REST API (elastic#48319)
fed7463 
* Scripting: fill in get contexts REST API

Updates response for `GET /_script_context`, returning a `contexts`
object with a list of context description objects.  The description
includes the context name and a list of methods available.  The
methods list has the signature for the `execute` mathod and any
getters. eg.
```
{
  "contexts": [
     {
       "name" : "moving-function",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [
             {
               "type" : "java.util.Map",
               "name" : "params"
             },
             {
               "type" : "double[]",
               "name" : "values"
             }
           ]
         }
       ]
     },
     {
       "name" : "number_sort",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [ ]
         },
         {
           "name" : "getDoc",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "getParams",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "get_score",
           "return_type" : "double",
           "params" : [ ]
         }
       ]
     },
...
  ]
}
```

fixes: elastic#47411
@stu-elastic stu-elastic mentioned this issue Oct 28, 2019
Merged
stu-elastic added a commit that referenced this issue Oct 29, 2019
@stu-elastic
Scripting: fill in get contexts REST API (#48319) (#48602)
55d00cf 
Updates response for `GET /_script_context`, returning a `contexts`
object with a list of context description objects.  The description
includes the context name and a list of methods available.  The
methods list has the signature for the `execute` mathod and any
getters. eg.
```
{
  "contexts": [
     {
       "name" : "moving-function",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [
             {
               "type" : "java.util.Map",
               "name" : "params"
             },
             {
               "type" : "double[]",
               "name" : "values"
             }
           ]
         }
       ]
     },
     {
       "name" : "number_sort",
       "methods" : [
         {
           "name" : "execute",
           "return_type" : "double",
           "params" : [ ]
         },
         {
           "name" : "getDoc",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "getParams",
           "return_type" : "java.util.Map",
           "params" : [ ]
         },
         {
           "name" : "get_score",
           "return_type" : "double",
           "params" : [ ]
         }
       ]
     },
...
  ]
}
```

fixes: #47411
@jimczi jimczi removed the v7.5.0 label Nov 12, 2019
@jimczi jimczi added the v7.6.0 label Nov 12, 2019
This was referenced Dec 5, 2019
Open
Open
This was referenced Feb 3, 2020
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stu-elastic stu-elastic

Labels
:Core/Infra/Scripting Scripting abstractions, Painless, and Mustache >enhancement v7.6.0 v8.0.0-alpha1
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Scripting: fill in get contexts REST API stu-elastic/elasticsearch
5 participants
@jakelandis @jdconrad @elasticmachine @jimczi @stu-elastic