rest-api-spec.api.put_script.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

OpenSearch subproject :rest-api-spec

The newest version!

{
  "put_script":{
    "documentation":{
      "url":"https://opensearch.org/docs/latest/api-reference/nodes-apis/nodes-usage/",
      "description":"Creates or updates a script."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/_scripts/{id}",
          "methods":[
            "PUT",
            "POST"
          ],
          "parts":{
            "id":{
              "type":"string",
              "description":"Script ID"
            }
          }
        },
        {
          "path":"/_scripts/{id}/{context}",
          "methods":[
            "PUT",
            "POST"
          ],
          "parts":{
            "id":{
              "type":"string",
              "description":"Script ID"
            },
            "context":{
              "type":"string",
              "description":"Script context"
            }
          }
        }
      ]
    },
    "params":{
      "timeout":{
        "type":"time",
        "description":"Explicit operation timeout"
      },
      "master_timeout":{
        "type":"time",
        "description":"Specify timeout for connection to master",
        "deprecated":{
          "version":"2.0.0",
          "description":"To support inclusive language, use 'cluster_manager_timeout' instead."
        }
      },
      "cluster_manager_timeout":{
        "type":"time",
        "description":"Specify timeout for connection to cluster-manager node"
      },
      "context":{
        "type":"string",
        "description":"Context name to compile script against"
      }
    },
    "body":{
      "description":"The document",
      "required":true
    }
  }
}