Merge branch 'main' into ip-location-apis

Author: joegallo

.github/workflows/update-rest-api-json.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        branch: ['main', '8.x', '8.16', '8.17', 7.17']
+        branch: ['main', '8.x', '8.16', '8.17', '7.17']
 
     steps:
       - uses: actions/checkout@v4

compiler/src/model/utils.ts

@@ -667,7 +667,7 @@ export function hoistRequestAnnotations (
     } else if (tag === 'cluster_privileges') {
       const privileges = [
         'all', 'cancel_task', 'create_snapshot', 'grant_api_key', 'manage', 'manage_api_key', 'manage_ccr',
-        'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_ingest_pipelines', 'manage_logstash_pipelines',
+        'manage_enrich', 'manage_ilm', 'manage_index_templates', 'manage_inference', 'manage_ingest_pipelines', 'manage_logstash_pipelines',
         'manage_ml', 'manage_oidc', 'manage_own_api_key', 'manage_pipeline', 'manage_rollup', 'manage_saml',
         'manage_security', 'manage_service_account', 'manage_slm', 'manage_token', 'manage_transform', 'manage_user_profile',
         'manage_watcher', 'monitor', 'monitor_ml', 'monitor_rollup', 'monitor_snapshot', 'monitor_text_structure',

compiler/src/steps/validate-model.ts

@@ -149,7 +149,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
 
   // Register builtin types
   for (const name of [
-    'string', 'boolean', 'number', 'null'
+    'string', 'boolean', 'number', 'null', 'void', 'binary'
   ]) {
     const typeName = {
       namespace: '_builtins',
@@ -397,11 +397,6 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
     context.pop()
 
     context.push('body')
-    if (typeDef.inherits != null && typeDef.body.kind !== 'properties') {
-      if (fqn(typeDef.inherits.type) !== '_types:RequestBase') {
-        modelError('A request with inherited properties must have a PropertyBody')
-      }
-    }
     switch (typeDef.body.kind) {
       case 'properties':
         validateProperties(typeDef.body.properties, openGenerics, inheritedProps)
@@ -546,33 +541,29 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
   }
 
   function validateTypeAlias (typeDef: model.TypeAlias): void {
-    const openGenerics = new Set(typeDef.generics?.map(t => t.name))
+    const openGenerics = openGenericSet(typeDef)
 
     if (typeDef.variants != null) {
-      if (typeDef.generics != null && typeDef.generics.length !== 0) {
-        modelError('A tagged union should not have generic parameters')
-      }
-
       if (typeDef.type.kind !== 'union_of') {
         modelError('The "variants" tag only applies to unions')
       } else {
-        validateTaggedUnion(typeDef.name, typeDef.type, typeDef.variants)
+        validateTaggedUnion(typeDef.name, typeDef.type, typeDef.variants, openGenerics)
       }
     } else {
       validateValueOf(typeDef.type, openGenerics)
     }
   }
 
-  function validateTaggedUnion (parentName: TypeName, valueOf: model.UnionOf, variants: model.InternalTag | model.ExternalTag | model.Untagged): void {
+  function validateTaggedUnion (parentName: TypeName, valueOf: model.UnionOf, variants: model.InternalTag | model.ExternalTag | model.Untagged, openGenerics: Set<string>): void {
     if (variants.kind === 'external_tag') {
       // All items must have a 'variant' attribute
-      const items = flattenUnionMembers(valueOf)
+      const items = flattenUnionMembers(valueOf, openGenerics)
 
       for (const item of items) {
         if (item.kind !== 'instance_of') {
           modelError('Items of externally tagged unions must be types with a "variant_tag" annotation')
         } else {
-          validateTypeRef(item.type, undefined, new Set<string>())
+          validateTypeRef(item.type, item.generics, openGenerics)
           const type = getTypeDef(item.type)
           if (type == null) {
             modelError(`Type ${fqn(item.type)} not found`)
@@ -587,13 +578,13 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
       }
     } else if (variants.kind === 'internal_tag') {
       const tagName = variants.tag
-      const items = flattenUnionMembers(valueOf)
+      const items = flattenUnionMembers(valueOf, openGenerics)
 
       for (const item of items) {
         if (item.kind !== 'instance_of') {
           modelError('Items of internally tagged unions must be type references')
         } else {
-          validateTypeRef(item.type, undefined, new Set<string>())
+          validateTypeRef(item.type, item.generics, openGenerics)
           const type = getTypeDef(item.type)
           if (type == null) {
             modelError(`Type ${fqn(item.type)} not found`)
@@ -606,7 +597,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
         }
       }
 
-      validateValueOf(valueOf, new Set())
+      validateValueOf(valueOf, openGenerics)
     } else if (variants.kind === 'untagged') {
       if (fqn(parentName) !== '_types.query_dsl:DecayFunction' &&
           fqn(parentName) !== '_types.query_dsl:DistanceFeatureQuery' &&
@@ -619,15 +610,15 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
         modelError(`Type ${fqn(variants.untypedVariant)} not found`)
       }
 
-      const items = flattenUnionMembers(valueOf)
+      const items = flattenUnionMembers(valueOf, openGenerics)
       const baseTypes = new Set<string>()
       let foundUntyped = false
 
       for (const item of items) {
         if (item.kind !== 'instance_of') {
           modelError('Items of type untagged unions must be type references')
         } else {
-          validateTypeRef(item.type, undefined, new Set<string>())
+          validateTypeRef(item.type, item.generics, openGenerics)
           const type = getTypeDef(item.type)
           if (type == null) {
             modelError(`Type ${fqn(item.type)} not found`)
@@ -679,7 +670,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
   // -----------------------------------------------------------------------------------------------
   // Constituents of type definitions
 
-  function openGenericSet (typeDef: model.Request | model.Response | model.Interface): Set<string> {
+  function openGenericSet (typeDef: model.Request | model.Response | model.Interface | model.TypeAlias): Set<string> {
     return new Set((typeDef.generics ?? []).map(name => fqn(name)))
   }
 
@@ -884,7 +875,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
         } else {
           // tagged union: the discriminant tells us what to look for, check each member in isolation
           assert(typeDef.type.kind === 'union_of', 'Variants are only allowed on union_of type aliases')
-          for (const item of flattenUnionMembers(typeDef.type)) {
+          for (const item of flattenUnionMembers(typeDef.type, new Set())) {
             validateValueOfJsonEvents(item)
           }
 
@@ -899,13 +890,13 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
   }
 
   /** Build the flattened item list of potentially nested unions (this is used for large unions) */
-  function flattenUnionMembers (union: model.UnionOf): model.ValueOf[] {
+  function flattenUnionMembers (union: model.UnionOf, openGenerics: Set<string>): model.ValueOf[] {
     const allItems = new Array<model.ValueOf>()
 
     function collectItems (items: model.ValueOf[]): void {
       for (const item of items) {
         if (item.kind !== 'instance_of') {
-          validateValueOf(item, new Set<string>())
+          validateValueOf(item, openGenerics)
           allItems.push(item)
         } else {
           const itemType = getTypeDef(item.type)
@@ -915,7 +906,7 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
             // Recurse in nested union
             collectItems(itemType.type.items)
           } else {
-            validateValueOf(item, new Set<string>())
+            validateValueOf(item, openGenerics)
             allItems.push(item)
           }
         }

compiler/src/steps/validate-rest-spec.ts

@@ -161,30 +161,30 @@ export default async function validateRestSpec (model: model.Model, jsonSpec: Ma
       if (definition.body.kind !== 'no_body') {
         body = Body.yesBody
       }
+
+      if (definition.attachedBehaviors != null) {
+        for (const attachedBehavior of definition.attachedBehaviors) {
+          const type_ = getDefinition({
+            namespace: '_spec_utils',
+            name: attachedBehavior
+          })
+          if (
+            type_.kind === 'interface' &&
+            // allowing CommonQueryParameters too generates many errors
+            attachedBehavior === 'CommonCatQueryParameters'
+          ) {
+            for (const prop of type_.properties) {
+              query.push(prop)
+            }
+          }
+        }
+      }
     } else {
       if (definition.properties.length > 0) {
         query.push(...definition.properties)
       }
     }
 
-    if (Array.isArray(definition.inherits)) {
-      const inherits = definition.inherits.map(inherit => getDefinition(inherit.type))
-      for (const inherit of inherits) {
-        const properties = getProperties(inherit)
-        if (properties.path.length > 0) {
-          path.push(...properties.path)
-        }
-
-        if (properties.query.length > 0) {
-          query.push(...properties.query)
-        }
-
-        if (properties.body === Body.yesBody) {
-          body = properties.body
-        }
-      }
-    }
-
     return { path, query, body }
   }
 }

docs/overlays/elasticsearch-openapi-overlays.yaml

@@ -163,7 +163,6 @@ actions:
   - target: "$.paths['/_ilm/policy/{policy}']['put']"
     description: "Add examples for create a lifecycle operation"
     update:
-      update: 
       requestBody: 
         content: 
           application/json: 
@@ -188,7 +187,6 @@ actions:
   - target: "$.paths['/_ilm/migrate_to_data_tiers']['post']"
     description: "Add examples for migrate to data tiers routing operation"
     update:
-      update: 
       requestBody: 
         content: 
           application/json: 
@@ -205,7 +203,6 @@ actions:
   - target: "$.paths['/_ilm/move/{index}']['post']"
     description: "Add examples for move to lifecycle step operation"
     update:
-      update: 
       requestBody: 
         content: 
           application/json: 
@@ -338,7 +335,6 @@ actions:
   - target: "$.paths['/_autoscaling/policy/{name}']['put']"
     description: "Add examples for create autoscaling policy operation"
     update:
-      update: 
       requestBody: 
         content: 
           application/json: 
@@ -353,4 +349,46 @@ actions:
             application/json:
               examples:
                 createAutoscalingPolicyResponseExample1:
-                  $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml"
+                  $ref: "../../specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.yaml"
+  - target: "$.components['responses']['indices.recovery#200']"
+    description: "Add example for get index recovery response"
+    update: 
+      content:
+        application/json:
+          examples:
+            getIndicesRecoveryResponseExample1:
+                  $ref: "../../specification/indices/recovery/indicesRecoveryResponseExample1.yaml"
+  - target: "$.paths['/_resolve/cluster/{name}']['get']"
+    description: "Add examples for resolve cluster operation"
+    update: 
+      responses:
+        200:
+          content:
+            application/json:
+              examples:
+                resolveClusterResponseExample1:
+                  $ref: "../../specification/indices/resolve_cluster/ResolveClusterResponseExample1.yaml"
+  - target: "$.components['requestBodies']['indices.shrink']"
+    description: "Add example for shrink index request"
+    update: 
+      content:
+        application/json:
+          examples:
+            indicesShrinkRequestExample1:
+              $ref: "../../specification/indices/shrink/indicesShrinkRequestExample1.yaml"
+  - target: "$.components['requestBodies']['indices.split']"
+    description: "Add example for split index request"
+    update: 
+      content:
+        application/json:
+          examples:
+            indicesSplitRequestExample1:
+              $ref: "../../specification/indices/split/indicesSplitRequestExample1.yaml"
+  - target: "$.components['requestBodies']['indices.put_template']"
+    description: "Add example for legacy create template request"
+    update: 
+      content:
+        application/json:
+          examples:
+            indicesLegacyPutTemplateRequestExample1:
+              $ref: "../../specification/indices/put_template/indicesPutTemplateRequestExample1.yaml"

docs/overlays/elasticsearch-serverless-openapi-overlays.yaml

@@ -23,23 +23,23 @@ actions:
   - target: '$.components'
     description: Add securitySchemes
     update:
-        securitySchemes:
-          apiKeyAuth:
-            description: |
-              Elasticsearch APIs use key-based authentication.
-              You must create an API key and use the encoded value in the request header.
-              For example:
-              
-              
-              ```
-              curl -X GET "${ES_URL}/_cat/indices?v=true" \
-                -H "Authorization: ApiKey ${API_KEY}"
-              ```
-              
-              To get API keys for the Elasticsearch endpoint (${ES_URL}) for a project, refer to [Connect to your Elasticsearch Serverless endpoint](https://www.elastic.co/guide/en/serverless/current/elasticsearch-connecting-to-es-serverless-endpoint.html).
-            in: header
-            name: Authorization
-            type: apiKey
+      securitySchemes:
+        apiKeyAuth:
+          description: |
+            Elasticsearch APIs use key-based authentication.
+            You must create an API key and use the encoded value in the request header.
+            For example:
+            
+            
+            ```
+            curl -X GET "${ES_URL}/_cat/indices?v=true" \
+              -H "Authorization: ApiKey ${API_KEY}"
+            ```
+            
+            To get API keys for the Elasticsearch endpoint (${ES_URL}) for a project, refer to [Connect to your Elasticsearch Serverless endpoint](https://www.elastic.co/guide/en/serverless/current/elasticsearch-connecting-to-es-serverless-endpoint.html).
+          in: header
+          name: Authorization
+          type: apiKey
   - target: '$'
     description: Add document security
     update: