/default/serverDefault/g

Author: delvedor

docs/modeling-guide.md

@@ -316,15 +316,15 @@ class Foo {
 }
 ```
 
-#### `@default`
+#### `@server_default`
 
-The default value if the property is not specified.
+The server side default value if the property is not specified.
 Default values can only be specified on optional properties.
 
 ```ts
 class Foo {
   bar: string
-  /** @default hello */
+  /** @server_default hello */
   baz?: string
   faz: string
 }

output/schema/schema.json

@@ -106074,9 +106074,9 @@
       ],
       "query": [
         {
-          "default": true,
           "name": "allow_no_indices",
           "required": false,
+          "serverDefault": true,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -106086,9 +106086,9 @@
           }
         },
         {
-          "default": false,
           "name": "ccs_minimize_roundtrips",
           "required": false,
+          "serverDefault": false,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -106120,9 +106120,9 @@
           }
         },
         {
-          "default": true,
           "name": "ignore_throttled",
           "required": false,
+          "serverDefault": true,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -106132,9 +106132,9 @@
           }
         },
         {
-          "default": false,
           "name": "ignore_unavailable",
           "required": false,
+          "serverDefault": false,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -106155,9 +106155,9 @@
           }
         },
         {
-          "default": false,
           "name": "profile",
           "required": false,
+          "serverDefault": false,
           "type": {
             "kind": "instance_of",
             "type": {
@@ -106200,9 +106200,9 @@
           }
         },
         {
-          "default": false,
           "name": "total_hits_as_integer",
           "required": false,
+          "serverDefault": false,
           "since": "7.0.0",
           "type": {
             "kind": "instance_of",
@@ -106213,9 +106213,9 @@
           }
         },
         {
-          "default": false,
           "name": "typed_keys",
           "required": false,
+          "serverDefault": false,
           "type": {
             "kind": "instance_of",
             "type": {

specification/compiler/model/metamodel.ts

@@ -131,7 +131,7 @@ export class Property {
   description?: string
   docUrl?: string
   since?: string
-  default?: boolean | string | number
+  serverDefault?: boolean | string | number
   deprecation?: Deprecation
   /**
    * If specified takes precedence over `name` when generating code. `name` is always the value

specification/compiler/model/utils.ts

@@ -527,7 +527,7 @@ export function hoistTypeAnnotations (type: model.TypeDefinition, jsDocs: JSDoc[
 
 /** Lifts jsDoc type annotations to fixed properties on Property */
 function hoistPropertyAnnotations (property: model.Property, jsDocs: JSDoc[]): void {
-  const validTags = ['stability', 'prop_serializer', 'doc_url', 'aliases', 'identifier', 'since', 'description', 'default']
+  const validTags = ['stability', 'prop_serializer', 'doc_url', 'aliases', 'identifier', 'since', 'description', 'server_default']
   const tags = parseJsDocTags(jsDocs)
   setTags(jsDocs, property, tags, validTags, (tags, tag, value) => {
     if (tag.endsWith('_serializer')) {
@@ -542,20 +542,20 @@ function hoistPropertyAnnotations (property: model.Property, jsDocs: JSDoc[]): v
       property.since = value
     } else if (tag === 'description') {
       property.description = value
-    } else if (tag === 'default') {
+    } else if (tag === 'server_default') {
       assert(jsDocs, property.type.kind === 'instance_of', `Default values can only be configured for instance_of types, you are using ${property.type.kind}`)
       assert(jsDocs, !property.required, 'Default values can only be specified on optional properties')
       switch (property.type.type.name) {
         case 'boolean':
           assert(jsDocs, value === 'true' || value === 'false', `The default value for ${property.name} should be a boolean`)
-          property.default = value === 'true'
+          property.serverDefault = value === 'true'
           break
         case 'number':
           assert(jsDocs, !isNaN(Number(value)), `The default value for ${property.name} should be a number`)
-          property.default = Number(value)
+          property.serverDefault = Number(value)
           break
         default:
-          property.default = value
+          property.serverDefault = value
       }
     } else {
       assert(jsDocs, false, `Unhandled tag: '${tag}' with value: '${value}' on property ${property.name}`)

specification/specs/search/search_template/SearchTemplateRequest.ts

@@ -28,29 +28,29 @@ interface SearchTemplateRequest extends RequestBase {
     type?: Types // deprecated: 7.0
   }
   query_parameters?: {
-    /** @default true */
+    /** @server_default true */
     allow_no_indices?: boolean
-    /** @default false */
+    /** @server_default false */
     ccs_minimize_roundtrips?: boolean
     expand_wildcards?: ExpandWildcards
-    /** default false */
+    /** server_default false */
     explain?: boolean
-    /** @default true */
+    /** @server_default true */
     ignore_throttled?: boolean
-    /** @default false */
+    /** @server_default false */
     ignore_unavailable?: boolean
     preference?: string
-    /** @default false */
+    /** @server_default false */
     profile?: boolean
     routing?: Routing
     scroll?: Time
     search_type?: SearchType
     /**
      * @since 7.0.0
-     * @default false
+     * @server_default false
      */
     total_hits_as_integer?: boolean
-    /** @default false */
+    /** @server_default false */
     typed_keys?: boolean
   }
   body?: {