Add media types (#5779)

* Add media types to specification

They come from the rest-api-spec.

* Support mediaType

* Fix lint

* Fix compiler lint

* Use string values for enums

* Take advantage of the AST and use enums text values

* Fix linter

* Run make spec-format-fix

* Add recursive enum parsing to handle meta members

* Add const to highlight enum target name

* Remove support for composite enums

* Add more media types

---------

Co-authored-by: Laurent Saint-Félix <[email protected]>

Author: pquentin

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/utils.ts

@@ -1509,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
+}