Support OpenAPI 3.1 (#25710)

Author: rachmari

lib/rest/static/decorated/api.github.com.json

@@ -171,19 +171,15 @@ function getExampleParamValue(name, schema) {
   if (schema.anyOf && schema.anyOf[0].type) return getExampleParamValue(name, schema.anyOf[0])
   if (!schema.type) return 'any'
 
-  switch (schema.type) {
-    case 'string':
-      return name
-    case 'boolean':
-      return true
-    case 'integer':
-      return 42
-    case 'object':
-      return mapValues(schema.properties, (propSchema, propName) =>
-        getExampleParamValue(propName, propSchema)
-      )
-    case 'array':
-      return [getExampleParamValue(name, schema.items)]
+  if (schema.type.includes('string')) return name
+  else if (schema.type.includes('boolean')) return true
+  else if (schema.type.includes('integer')) return 42
+  else if (schema.type.includes('object')) {
+    return mapValues(schema.properties, (propSchema, propName) =>
+      getExampleParamValue(propName, propSchema)
+    )
+  } else if (schema.type.includes('array')) {
+    return [getExampleParamValue(name, schema.items)]
   }
 
   throw new Error(`Unknown data type in schema:, ${JSON.stringify(schema, null, 2)}`)

lib/rest/static/decorated/ghes-3.0.json

@@ -293,6 +293,12 @@ async function getBodyParams(paramsObject, requiredParams) {
       param.name = paramKey
       param.in = 'body'
       param.rawType = param.type
+      // OpenAPI 3.0 only had a single value for `type`. OpenAPI 3.1
+      // will either be a single value or an array of values.
+      // This makes type an array regardless of how many values the array
+      // includes. This allows us to support 3.1 while remaining backwards
+      // compatible with 3.0.
+      if (!Array.isArray(param.type)) param.type = [param.type]
       param.rawDescription = param.description
 
       // Stores the types listed under the `Type` column in the `Parameters`
@@ -328,16 +334,24 @@ async function getBodyParams(paramsObject, requiredParams) {
       }
 
       // Arrays require modifying the displayed type (e.g., array of strings)
-      if (param.type === 'array') {
+      if (param.type.includes('array')) {
         if (param.items.type) paramArray.push(`array of ${param.items.type}s`)
         if (param.items.oneOf) {
           paramArray.push(param.items.oneOf.map((elem) => `array of ${elem.type}s`))
         }
+        // push the remaining types in the param.type array
+        // that aren't type array
+        const remainingItems = param.type
+        const indexOfArrayType = remainingItems.indexOf('array')
+        remainingItems.splice(indexOfArrayType, 1)
+        paramArray.push(...remainingItems)
       } else if (param.type) {
-        paramArray.push(param.type)
+        paramArray.push(...param.type)
       }
-
-      if (param.nullable) paramArray.push('nullable')
+      // Supports backwards compatibility for OpenAPI 3.0
+      // In 3.1 a nullable type is part of the param.type array and
+      // the property param.nullable does not exist.
+      if (param.nullable) paramArray.push('null')
 
       param.type = paramArray.flat().join(' or ')
       param.description = param.description || ''