Merge remote-tracking branch 'origin/main' into azure-open-ai-chat-completion-integration

Author: Jan-Kazlouski-elastic

.github/workflows/code-format.yml

@@ -21,5 +21,6 @@ jobs:
 
     - name: Code style check
       run: |
+        npm run compile:specification --prefix compiler
         npm run format:check --prefix compiler
 

compiler/src/index.ts

@@ -25,7 +25,6 @@ import validateRestSpec from './steps/validate-rest-spec'
 import addInfo from './steps/add-info'
 import addDescription from './steps/add-description'
 import validateModel from './steps/validate-model'
-import addContentType from './steps/add-content-type'
 import readDefinitionValidation from './steps/read-definition-validation'
 import addDeprecation from './steps/add-deprecation'
 import ExamplesProcessor from './steps/add-examples'
@@ -73,7 +72,6 @@ compiler
   .generateModel()
   .step(addInfo)
   .step(addDeprecation)
-  .step(addContentType)
   .step(readDefinitionValidation)
   .step(validateRestSpec)
   .step(addDescription)

compiler/src/model/build-model.ts

@@ -53,7 +53,8 @@ import {
   verifyUniqueness,
   parseJsDocTags,
   deepEqual,
-  sourceLocation, sortTypeDefinitions, parseDeprecation
+  sourceLocation, sortTypeDefinitions, parseDeprecation,
+  mediaTypeToStringArray
 } from './utils'
 
 const jsonSpec = buildJsonSpec()
@@ -156,11 +157,11 @@ export function compileSpecification (endpointMappings: Record<string, model.End
 
   // Visit all class, interface, enum and type alias definitions
   for (const declaration of declarations.classes) {
-    model.types.push(compileClassOrInterfaceDeclaration(declaration, endpointMappings, declarations.classes))
+    model.types.push(compileClassOrInterfaceDeclaration(declaration, endpointMappings, declarations.classes, declarations.enums))
   }
 
   for (const declaration of declarations.interfaces) {
-    model.types.push(compileClassOrInterfaceDeclaration(declaration, endpointMappings, declarations.classes))
+    model.types.push(compileClassOrInterfaceDeclaration(declaration, endpointMappings, declarations.classes, declarations.enums))
   }
 
   for (const declaration of declarations.enums) {
@@ -177,7 +178,7 @@ export function compileSpecification (endpointMappings: Record<string, model.End
   return model
 }
 
-function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | InterfaceDeclaration, mappings: Record<string, model.Endpoint>, allClasses: ClassDeclaration[]): model.Request | model.Response | model.Interface {
+function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | InterfaceDeclaration, mappings: Record<string, model.Endpoint>, allClasses: ClassDeclaration[], allEnums: EnumDeclaration[]): model.Request | model.Response | model.Interface | model.Enum {
   const name = declaration.getName()
   assert(declaration, name != null, 'Anonymous definitions should not exists')
 
@@ -247,6 +248,14 @@ function compileClassOrInterfaceDeclaration (declaration: ClassDeclaration | Int
           assert(member, property.properties.length > 0, 'There is no need to declare an empty object path_parts, just remove the path_parts declaration.')
           pathMember = member
           type.path = property.properties
+        } else if (name === 'request_media_type' || name === 'response_media_type') {
+          // add those property to requestMediaType and responseMediaType of the endpoint
+          const mediaType = (member as PropertySignature).getStructure().type as string
+          if (name === 'request_media_type') {
+            mapping.requestMediaType = mediaTypeToStringArray(mediaType, allEnums)
+          } else if (name === 'response_media_type') {
+            mapping.responseMediaType = mediaTypeToStringArray(mediaType, allEnums)
+          }
         } else if (name === 'query_parameters') {
           const property = visitRequestOrResponseProperty(member)
           assert(member, property.properties.length > 0, 'There is no need to declare an empty object query_parameters, just remove the query_parameters declaration.')

compiler/src/model/metamodel.ts

@@ -469,6 +469,8 @@ export class Endpoint {
     index?: string[]
     cluster?: string[]
   }
+
+  codegenExclude?: boolean
 }
 
 export class UrlTemplate {

compiler/src/model/utils.ts

@@ -634,7 +634,7 @@ export function hoistRequestAnnotations (
   request: model.Request, jsDocs: JSDoc[], mappings: Record<string, model.Endpoint>, response: model.TypeName | null
 ): void {
   const knownRequestAnnotations = [
-    'rest_spec_name', 'behavior', 'class_serializer', 'index_privileges', 'cluster_privileges', 'doc_id', 'availability', 'doc_tag', 'ext_doc_id'
+    'rest_spec_name', 'behavior', 'class_serializer', 'index_privileges', 'cluster_privileges', 'doc_id', 'availability', 'doc_tag', 'ext_doc_id', 'codegen_exclude'
   ]
   // in most of the cases the jsDocs comes in a single block,
   // but it can happen that the user defines multiple single line jsDoc.
@@ -720,6 +720,9 @@ export function hoistRequestAnnotations (
     } else if (tag === 'doc_tag') {
       assert(jsDocs, value.trim() !== '', `Request ${request.name.name}'s @doc_tag cannot be empty`)
       endpoint.docTag = value.trim()
+    } else if (tag === 'codegen_exclude') {
+      // Mark this endpoint to be excluded from client code generation
+      endpoint.codegenExclude = true
     } else {
       assert(jsDocs, false, `Unhandled tag: '${tag}' with value: '${value}' on request ${request.name.name}`)
     }
@@ -1506,3 +1509,24 @@ export function sortTypeDefinitions (types: model.TypeDefinition[]): void {
     return 0
   })
 }
+
+export function mediaTypeToStringArray (mediaType: string, allEnums: EnumDeclaration[]): string[] {
+  const mediaTypeEnumName = 'MediaType'
+  const mediaTypeEnum = allEnums.find(e => e.getName() === mediaTypeEnumName)
+
+  // Handle strings separated by a pipe and return multiple media types
+  let enumTypeList: string[]
+  if (mediaType.includes('|')) {
+    enumTypeList = mediaType.split('|').map(mt => mt.trim())
+  } else {
+    enumTypeList = [mediaType.trim()]
+  }
+
+  const mediaTypeList: string[] = []
+  for (const enumType of enumTypeList) {
+    const memberName = enumType.split('.').pop()
+    const value = mediaTypeEnum?.getMembers().find(m => m.getName() === memberName)?.getValue() as string
+    mediaTypeList.push(value)
+  }
+  return mediaTypeList
+}

compiler/src/steps/add-content-type.ts

@@ -32,28 +32,6 @@ export default async function addDescription (model: model.Model, jsonSpec: Map<
     const spec = jsonSpec.get(endpoint.name)
     assert(spec, `Can't find the json spec for ${endpoint.name}`)
 
-    for (const property of requestDefinition.path) {
-      const definition = spec.url.paths.find(path => {
-        if (path.parts == null) return false
-        return path.parts[property.name] != null
-      })
-      if (definition?.parts != null) {
-        const { description } = definition.parts[property.name]
-        if (typeof description === 'string') {
-          property.description = property.description ?? description
-        }
-      }
-    }
-
-    if (spec.params != null) {
-      for (const property of requestDefinition.query) {
-        const param = spec.params[property.name]
-        if (param != null && typeof param.description === 'string') {
-          property.description = property.description ?? param.description
-        }
-      }
-    }
-
     if (spec.documentation.description != null) {
       requestDefinition.description = requestDefinition.description ?? spec.documentation.description
     }