Validate the 'update' API

Author: sethmlarson

output/schema/schema.json

@@ -12253,7 +12253,7 @@
         "namespace": "_global.update"
       },
       "since": "0.0.0",
-      "stability": "TODO",
+      "stability": "stable",
       "urls": [
         {
           "methods": [
@@ -28231,8 +28231,10 @@
         "kind": "properties",
         "properties": [
           {
+            "description": "Set to false to disable setting 'result' in the response to 'noop' if no change to the document occurred.",
             "name": "detect_noop",
             "required": false,
+            "serverDefault": true,
             "type": {
               "kind": "instance_of",
               "type": {
@@ -28242,6 +28244,7 @@
             }
           },
           {
+            "description": "A partial update to an existing document.",
             "name": "doc",
             "required": false,
             "type": {
@@ -28253,8 +28256,10 @@
             }
           },
           {
+            "description": "Set to true to use the contents of 'doc' as the value of 'upsert'",
             "name": "doc_as_upsert",
             "required": false,
+            "serverDefault": false,
             "type": {
               "kind": "instance_of",
               "type": {
@@ -28264,6 +28269,7 @@
             }
           },
           {
+            "description": "Script to execute to update the document.",
             "name": "script",
             "required": false,
             "type": {
@@ -28275,8 +28281,10 @@
             }
           },
           {
+            "description": "Set to true to execute the script whether or not the document exists.",
             "name": "scripted_upsert",
             "required": false,
+            "serverDefault": false,
             "type": {
               "kind": "instance_of",
               "type": {
@@ -28286,8 +28294,10 @@
             }
           },
           {
+            "description": "Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.",
             "name": "_source",
             "required": false,
+            "serverDefault": "true",
             "type": {
               "items": [
                 {
@@ -28309,6 +28319,7 @@
             }
           },
           {
+            "description": "If the document does not already exist, the contents of 'upsert' are inserted as a new document. If the document exists, the 'script' is executed.",
             "name": "upsert",
             "required": false,
             "type": {
@@ -28379,6 +28390,7 @@
       ],
       "query": [
         {
+          "description": "Only perform the operation if the document has this primary term.",
           "name": "if_primary_term",
           "required": false,
           "type": {
@@ -28390,6 +28402,7 @@
           }
         },
         {
+          "description": "Only perform the operation if the document has this sequence number.",
           "name": "if_seq_no",
           "required": false,
           "type": {
@@ -28401,8 +28414,10 @@
           }
         },
         {
+          "description": "The script language.",
           "name": "lang",
           "required": false,
+          "serverDefault": "painless",
           "type": {
             "kind": "instance_of",
             "type": {
@@ -28412,8 +28427,10 @@
           }
         },
         {
+          "description": "If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search, if 'wait_for' then wait for a refresh to make this operation visible to search, if 'false' do nothing with refreshes.",
           "name": "refresh",
           "required": false,
+          "serverDefault": "false",
           "type": {
             "kind": "instance_of",
             "type": {
@@ -28423,8 +28440,10 @@
           }
         },
         {
+          "description": "If true, the destination must be an index alias.",
           "name": "require_alias",
           "required": false,
+          "serverDefault": false,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -28434,8 +28453,10 @@
           }
         },
         {
+          "description": "Specify how many times should the operation be retried when a conflict occurs.",
           "name": "retry_on_conflict",
           "required": false,
+          "serverDefault": 0,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -28445,6 +28466,7 @@
           }
         },
         {
+          "description": "Custom value used to route operations to a specific shard.",
           "name": "routing",
           "required": false,
           "type": {
@@ -28456,19 +28478,10 @@
           }
         },
         {
-          "name": "source_enabled",
-          "required": false,
-          "type": {
-            "kind": "instance_of",
-            "type": {
-              "name": "boolean",
-              "namespace": "internal"
-            }
-          }
-        },
-        {
+          "description": "Period to wait for dynamic mapping updates and active shards. This guarantees Elasticsearch waits for at least the timeout before failing. The actual wait time could be longer, particularly when multiple waits occur.",
           "name": "timeout",
           "required": false,
+          "serverDefault": "1m",
           "type": {
             "kind": "instance_of",
             "type": {
@@ -28478,8 +28491,10 @@
           }
         },
         {
+          "description": "The number of shard copies that must be active before proceeding with the operations. Set to 'all' or any positive integer up to the total number of shards in the index (number_of_replicas+1). Defaults to 1 meaning the primary shard.",
           "name": "wait_for_active_shards",
           "required": false,
+          "serverDefault": "1",
           "type": {
             "kind": "instance_of",
             "type": {
@@ -28489,8 +28504,10 @@
           }
         },
         {
+          "description": "Set to false to disable source retrieval. You can also specify a comma-separated list of the fields you want to retrieve.",
           "name": "_source",
           "required": false,
+          "serverDefault": "true",
           "type": {
             "items": [
               {
@@ -28512,6 +28529,7 @@
           }
         },
         {
+          "description": "Specify the source fields you want to exclude.",
           "name": "_source_excludes",
           "required": false,
           "type": {
@@ -28523,6 +28541,7 @@
           }
         },
         {
+          "description": "Specify the source fields you want to retrieve.",
           "name": "_source_includes",
           "required": false,
           "type": {

output/schema/validation-errors.json

@@ -1819,12 +1819,6 @@
       ],
       "response": []
     },
-    "update": {
-      "request": [
-        "Endpoint has \"@stability: TODO"
-      ],
-      "response": []
-    },
     "update_by_query": {
       "request": [
         "Endpoint has \"@stability: TODO"

output/typescript/types.ts

@@ -1665,7 +1665,6 @@ export interface UpdateRequest<TDocument = unknown, TPartialDocument = unknown>
   require_alias?: boolean
   retry_on_conflict?: long
   routing?: Routing
-  source_enabled?: boolean
   timeout?: Time
   wait_for_active_shards?: WaitForActiveShards
   _source?: boolean | Fields

specification/_global/update/UpdateRequest.ts

@@ -36,7 +36,7 @@ import { Time } from '@_types/Time'
 /**
  * @rest_spec_name update
  * @since 0.0.0
- * @stability TODO
+ * @stability stable
  */
 export interface Request<TDocument, TPartialDocument> extends RequestBase {
   path_parts?: {
@@ -45,29 +45,106 @@ export interface Request<TDocument, TPartialDocument> extends RequestBase {
     type?: Type
   }
   query_parameters?: {
+    /**
+     * Only perform the operation if the document has this primary term.
+     */
     if_primary_term?: long
+    /**
+     * Only perform the operation if the document has this sequence number.
+     */
     if_seq_no?: SequenceNumber
+    /**
+     * The script language.
+     * @server_default painless
+     */
     lang?: string
+    /**
+     * If 'true', Elasticsearch refreshes the affected shards to make this operation
+     * visible to search, if 'wait_for' then wait for a refresh to make this operation
+     * visible to search, if 'false' do nothing with refreshes.
+     * @server_default false
+     */
     refresh?: Refresh
+    /**
+     * If true, the destination must be an index alias.
+     * @server_default false
+     */
     require_alias?: boolean
+    /**
+     * Specify how many times should the operation be retried when a conflict occurs.
+     * @server_default 0
+     */
     retry_on_conflict?: long
+    /**
+     * Custom value used to route operations to a specific shard.
+     */
     routing?: Routing
-    source_enabled?: boolean
+    /**
+     * Period to wait for dynamic mapping updates and active shards.
+     * This guarantees Elasticsearch waits for at least the timeout before failing.
+     * The actual wait time could be longer, particularly when multiple waits occur.
+     * @server_default 1m
+     */
     timeout?: Time
+    /**
+     * The number of shard copies that must be active before proceeding with the operations.
+     * Set to 'all' or any positive integer up to the total number of shards in the index
+     * (number_of_replicas+1). Defaults to 1 meaning the primary shard.
+     * @server_default 1
+     */
     wait_for_active_shards?: WaitForActiveShards
+    /**
+     * Set to false to disable source retrieval. You can also specify a comma-separated
+     * list of the fields you want to retrieve.
+     * @server_default true
+     */
     _source?: boolean | Fields
+    /**
+     * Specify the source fields you want to exclude.
+     */
     _source_excludes?: Fields
+    /**
+     * Specify the source fields you want to retrieve.
+     */
     _source_includes?: Fields
   }
   body?: {
+    /**
+     * Set to false to disable setting 'result' in the response
+     * to 'noop' if no change to the document occurred.
+     * @server_default true
+     */
     detect_noop?: boolean
-    /** @prop_serializer SourceFormatter`1 */
+    /**
+     * A partial update to an existing document.
+     * @prop_serializer SourceFormatter`1
+     */
     doc?: TPartialDocument
+    /**
+     * Set to true to use the contents of 'doc' as the value of 'upsert'
+     * @server_default false
+     */
     doc_as_upsert?: boolean
+    /**
+     * Script to execute to update the document.
+     */
     script?: Script
+    /**
+     * Set to true to execute the script whether or not the document exists.
+     * @server_default false
+     */
     scripted_upsert?: boolean
+    /**
+     * Set to false to disable source retrieval. You can also specify a comma-separated
+     * list of the fields you want to retrieve.
+     * @server_default true
+     */
     _source?: boolean | SourceFilter
-    /** @prop_serializer SourceFormatter`1 */
+    /**
+     * If the document does not already exist, the contents of 'upsert' are inserted as a
+     * new document. If the document exists, the 'script' is executed.
+     * @prop_serializer SourceFormatter`1
+     */
     upsert?: TDocument
   }
 }