Function toOpenAPIParameters

packages/openapi/src/openapi-utils.ts:103–138

(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie')

 * @internal
 */
export function toOpenAPIParameters(schema: ObjectSchema, parameterIn: 'path' | 'query' | 'header' | 'cookie'): OpenAPI.ParameterObject[] {
  const parameters: OpenAPI.ParameterObject[] = []

  for (const key in schema.properties) {
    const keySchema = schema.properties[key]!

    let isDeepObjectStyle = true

    if (parameterIn !== 'query') {
      isDeepObjectStyle = false
    }
    else if (isPrimitiveSchema(keySchema)) {
      isDeepObjectStyle = false
    }
    else {
      const [item] = expandArrayableSchema(keySchema) ?? []

      if (item !== undefined && isPrimitiveSchema(item)) {
        isDeepObjectStyle = false
      }
    }

    parameters.push({
      name: key,
      in: parameterIn,
      required: schema.required?.includes(key),
      schema: toOpenAPISchema(keySchema) as any,
      style: isDeepObjectStyle ? 'deepObject' : undefined,
      explode: isDeepObjectStyle ? true : undefined,
      allowEmptyValue: parameterIn === 'query' ? true : undefined,
      allowReserved: parameterIn === 'query' ? true : undefined,
    })
  }

  return parameters
}

/**
 * @internal