script api documentation #1094

ariamarble · 2022-09-02T21:10:07Z

Description

new pull request replacing #1016

Issues Resolved

Partially resolves #424

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Signed-off-by: Steve Murphy <[email protected]>

…mentation-website into Steve-O-Murphy-script-documentation

…us corrections Signed-off-by: ariamarble <[email protected]>

ariamarble · 2022-09-02T21:13:48Z

tech review has been completed. api endpoints and scripts verified working

kolchfa-aws · 2022-09-02T21:38:56Z

_opensearch/rest-api/_script-apis/index.md

+The script APIs allow you to work with stored scripts. Stored scripts are part of the cluster state and reduce compilation time and enhance search speed. The default scripting language is Painless. 
+
+You perform the following operations on stored scripts:
+* [create]({{site.url}}{{site.baseurl}}/opensearch/rest-api/script-apis/../../../../create-stored-script/)


Please delete the ../../../..

kolchfa-aws

LGTM with a minor comment

Signed-off-by: ariamarble <[email protected]>

cwillum · 2022-09-02T21:51:15Z

_opensearch/rest-api/_script-apis/create-stored-script.md

+| Parameter | Data Type | Description | 
+:--- | :--- | :---
+| context | String | Context in which the script or search template is to run. To prevent errors, the API immediately compiles the script or template in this context. |
+| cluster_manager_timeout | Time | Amount of time to wait for a connection to the master node. Defaults to 30 seconds. |


We need to decide what term to use to replace "master node" (in running text). Primary node? We use "primary" and secondary shard.

oh, actually the new node name for previous "master" node is "cluster manager" node now.
see https://opensearch.org/docs/latest/opensearch/cluster/

yeah primary and secondary are best I think. I'll go ahead and update

alicejw1

Looks good!

cwillum · 2022-09-02T21:52:35Z

_opensearch/rest-api/_script-apis/create-stored-script.md

+| Field | Data Type | Description | 
+:--- | :--- | :---
+| lang | String | Scripting language. Required. |
+| source | String or Object | Required. <br />  <br /> For scripts, a string with the contents of the script. <br />  <br /> For search templates, an object that defines the search template. Supports the same parameters as the [Search API]({{site.url}}{{site.baseurl}}/opensearch/rest-api/search)'s request body. request body. Search templates also support Mustache variables. |


"request body" repeated in this line?

cwillum · 2022-09-02T21:55:03Z

_opensearch/rest-api/_script-apis/create-stored-script.md

+
+#### Sample response
+
+The `PUT _scripts/my-first-script` request returns the following fields:


a single field or plural?

singular. corrected

cwillum · 2022-09-02T21:58:06Z

_opensearch/rest-api/_script-apis/delete-script.md

+| Parameter | Data Type | Description | 
+:--- | :--- | :---
+| cluster_manager_timeout | Time | Amount of time to wait for a connection to the master node. Optional, defaults to `30s`. |
+| timeout | Time | The period of time to wait for a response. If a response is not received before the timeout value, the requ


Is this last sentence clipped?

cwillum · 2022-09-02T22:01:27Z

_opensearch/rest-api/_script-apis/get-stored-script.md

+
+| Parameter | Data Type | Description | 
+:--- | :--- | :---
+| cluster_manager_timeout | Time | Amount of time to wait for a connection to the master node. Optional, defaults to `30s`. |


"master node" issue again.

updating these all to "cluster manager"

Signed-off-by: ariamarble <[email protected]>

* Add script documentation. Signed-off-by: Steve Murphy <[email protected]> * Use my own example script insteady of Elastic's. Signed-off-by: Steve Murphy <[email protected]> * edditing and format changes. verified API requests and scripts. various corrections Signed-off-by: ariamarble <[email protected]> * made a couple of suggested changes Signed-off-by: ariamarble <[email protected]> * made further corrections Signed-off-by: ariamarble <[email protected]> Signed-off-by: Steve Murphy <[email protected]> Signed-off-by: ariamarble <[email protected]> Co-authored-by: Steve Murphy <[email protected]> (cherry picked from commit 21386b0)

cwillum

Looks great.

* Add script documentation. Signed-off-by: Steve Murphy <[email protected]> * Use my own example script insteady of Elastic's. Signed-off-by: Steve Murphy <[email protected]> * edditing and format changes. verified API requests and scripts. various corrections Signed-off-by: ariamarble <[email protected]> * made a couple of suggested changes Signed-off-by: ariamarble <[email protected]> * made further corrections Signed-off-by: ariamarble <[email protected]> Signed-off-by: Steve Murphy <[email protected]> Signed-off-by: ariamarble <[email protected]> Co-authored-by: Steve Murphy <[email protected]> (cherry picked from commit 21386b0) Co-authored-by: Aria Marble <[email protected]>

* Add script documentation. Signed-off-by: Steve Murphy <[email protected]> * Use my own example script insteady of Elastic's. Signed-off-by: Steve Murphy <[email protected]> * edditing and format changes. verified API requests and scripts. various corrections Signed-off-by: ariamarble <[email protected]> * made a couple of suggested changes Signed-off-by: ariamarble <[email protected]> * made further corrections Signed-off-by: ariamarble <[email protected]> Signed-off-by: Steve Murphy <[email protected]> Signed-off-by: ariamarble <[email protected]> Co-authored-by: Steve Murphy <[email protected]>

Steve Murphy and others added 4 commits August 29, 2022 08:42

Add script documentation.

0a643e4

Signed-off-by: Steve Murphy <[email protected]>

Use my own example script insteady of Elastic's.

e240391

Signed-off-by: Steve Murphy <[email protected]>

Merge branch 'script-documentation' of github.com:Steve-O-Murphy/docu…

d68552c

…mentation-website into Steve-O-Murphy-script-documentation

edditing and format changes. verified API requests and scripts. vario…

d7f2c06

…us corrections Signed-off-by: ariamarble <[email protected]>

ariamarble requested a review from a team as a code owner September 2, 2022 21:10

ariamarble self-assigned this Sep 2, 2022

ariamarble added backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x v2.3.0 backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 labels Sep 2, 2022

ariamarble mentioned this pull request Sep 2, 2022

Add script documentation. #1016

Closed

kolchfa-aws reviewed Sep 2, 2022

View reviewed changes

kolchfa-aws approved these changes Sep 2, 2022

View reviewed changes

made a couple of suggested changes

14e1aad

Signed-off-by: ariamarble <[email protected]>

cwillum reviewed Sep 2, 2022

View reviewed changes

alicejw1 approved these changes Sep 2, 2022

View reviewed changes

cwillum reviewed Sep 2, 2022

View reviewed changes

made further corrections

bd332eb

Signed-off-by: ariamarble <[email protected]>

ariamarble merged commit 21386b0 into main Sep 2, 2022

opensearch-trigger-bot bot mentioned this pull request Sep 2, 2022

[Backport 1.3] script api documentation #1095

Merged

opensearch-trigger-bot bot mentioned this pull request Sep 2, 2022

[Backport 2.0] script api documentation #1096

Merged

opensearch-trigger-bot bot mentioned this pull request Sep 2, 2022

[Backport 2.1] script api documentation #1097

Merged

opensearch-trigger-bot bot mentioned this pull request Sep 2, 2022

[Backport 2.2] script api documentation #1098

Merged

cwillum reviewed Sep 2, 2022

View reviewed changes

Naarcha-AWS deleted the Steve-O-Murphy-script-documentation branch September 14, 2022 17:50

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

script api documentation #1094

script api documentation #1094

ariamarble commented Sep 2, 2022

ariamarble commented Sep 2, 2022

kolchfa-aws Sep 2, 2022

ariamarble Sep 2, 2022

kolchfa-aws left a comment

cwillum Sep 2, 2022

alicejw1 Sep 2, 2022 •

edited

Loading

ariamarble Sep 2, 2022

alicejw1 left a comment

cwillum Sep 2, 2022

ariamarble Sep 2, 2022

cwillum Sep 2, 2022

ariamarble Sep 2, 2022

cwillum Sep 2, 2022

ariamarble Sep 2, 2022

cwillum Sep 2, 2022

ariamarble Sep 2, 2022

cwillum left a comment


		#### Sample response

		The `PUT _scripts/my-first-script` request returns the following fields:

script api documentation #1094

script api documentation #1094

Conversation

ariamarble commented Sep 2, 2022

Description

Issues Resolved

ariamarble commented Sep 2, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kolchfa-aws left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alicejw1 Sep 2, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alicejw1 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cwillum left a comment

Choose a reason for hiding this comment

alicejw1 Sep 2, 2022 •

edited

Loading