prefixItems is unsupported (OpenAPI 3.1)

[syniex]

What are the steps to reproduce this issue?

1. use prefixItems in the openapi (version 3.1)

What happens?

Orval will crash saying ovt - Error: All arrays must have an items key define

What were you expecting to happen?

Client will be generated

Any logs, error output, etc?

Swagger Example

Any other comments?

{
    "openapi": "3.1.0",
    "info": {
        "title": "Fail Example",
        "version": "0.1.0"
    },
    "paths": {
        "/api/v1/building/": {
            "get": {
                "tags": [
                    "Version 1",
                    "Building"
                ],
                "summary": "Get Buildings",
                "operationId": "get_buildings",
                "responses": {
                    "200": {
                        "description": "Successful Response",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "$ref": "#/components/schemas/Polygon"
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "components": {
        "schemas": {
            "Polygon": {
                "properties": {
                    "type": {
                        "const": "Polygon",
                        "title": "Type",
                        "default": "Polygon"
                    },
                    "coordinates": {
                        "items": {
                            "items": {
                                "prefixItems": [
                                    {
                                        "type": "number"
                                    },
                                    {
                                        "type": "number"
                                    }
                                ],
                                "type": "array",
                                "maxItems": 2,
                                "minItems": 2
                            },
                            "type": "array"
                        },
                        "type": "array",
                        "title": "Coordinates"
                    }
                },
                "type": "object",
                "required": [
                    "coordinates"
                ],
                "title": "Polygon",
                "description": "Polygon Model."
            }
        }
    }
}

[dan-garden]

Having the same issue, everywhere else my spec is valid. Can't find any info online for this specific issue either.

[GuillaumeQuenneville]

I can confirm this issue. Using python and pydantic, defining a type with a tuple_positional_schema generates a prefixItems key. Changing the type's json schema to a List instead of a Tuple works as a temporary (less robust ) fix.

[guy032]

I narrowed this error to a change in my swagger.json from this (works):

{
	"description": "List of connectors",
	"content": {
		"application/json": {
			"schema": {
				"$ref": "#/components/schemas/ConnectorDto"
			}
		}
	}
}

to this (raise the Error: All arrays must have an items key define):

{
	"description": "List of connectors",
	"content": {
		"application/json": {
			"schema": {
				"allOf": [{
					"$ref": "#/components/schemas/PageDto"
				}, {
					"properties": {
						"results": {
							"type": "array",
							"items": {
								"$ref": "#/components/schemas/ConnectorDto"
							}
						}
					}
				}]
			}
		}
	}
}

And this is the code that generates this schema for me:

import type { Type } from '@nestjs/common';
import { applyDecorators } from '@nestjs/common';
import { ApiExtraModels, ApiOkResponse, getSchemaPath } from '@nestjs/swagger';

import { PageDto } from '../common/dto/page.dto';

export function ApiPageOkResponse<T extends Type>(options: {
  type: T;
  description?: string;
}): MethodDecorator {
  return applyDecorators(
    ApiExtraModels(PageDto),
    ApiExtraModels(options.type),
    ApiOkResponse({
      description: options.description,
      schema: {
        allOf: [
          { $ref: getSchemaPath(PageDto) },
          {
            properties: {
              results: {
                type: 'array',
                items: { $ref: getSchemaPath(options.type) },
              },
            },
          },
        ],
      },
    }),
  );
}

[rauldeheer]

Any news on this?

[Pierstoval]

Just encountered the same error, as well as countless must have required property '$ref' or must match exactly one schema in oneOf errors alongside the Error: All arrays must have an ``items`` key define error 😕

Is there any workaround so far?

[rauldeheer]

@Pierstoval I was able to fix it. My Swagger doc is auto-generated by NestJS Swagger. The problem was that arrays of a 'simple type' such as a number or a string didn't have a type in the Swagger JSON. So at first I had:

@ApiProperty({ required: false, isArray: true })
@Expose()
numberArray?: number[];

Once I changed all those arrays to the following:

@ApiProperty({ required: false, isArray: true, type: Number })
@Expose()
numberArray?: number[];

The schema added the correct type and it was instantly fixed. So all I had to do was add the correct type property to the ApiProperty decorator. Hope this helps!

[jrozbicki]

I get the same error, would be very helpful if error was correlated with schema line number - that would help to narrow down the issue.