Followed the example and failed

Hi. I followed the example and got the following error:

UnknownZodTypeError {
  message: 'Unknown zod object type, please specify `type` and other OpenAPI props using `ZodSchema.openapi`.',
  data: {
    currentSchema: {
      shape: [Function: shape],
      unknownKeys: 'strip',
      catchall: [ZodNever],
      typeName: 'ZodObject',
      openapi: [Object]
    },
    schemaName: 'User'
  }
}

when trying to use registry.registerParameter, registry.register, registry.registerPath in NextJS api route.

My package.json:

"dependencies": {
    "@asteasolutions/zod-to-openapi": "^1.2.1",
}

My code:

import { extendZodWithOpenApi, OpenAPIGenerator, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
import { NextApiRequest, NextApiResponse } from 'next';
import { z } from 'zod';

function getOpenApiDocumentation() {
  extendZodWithOpenApi(z);
  const registry = new OpenAPIRegistry();

  const UserIdSchema = registry.registerParameter(
    "UserId",
    z.string().openapi({
      param: {
        name: "id",
        in: "path",
      },
      example: "1212121",
    })
  );
  const UserSchema = registry.register(
    "User",
    z.object({
      id: z.string().openapi({
        example: "1212121",
      }),
      name: z.string().openapi({
        example: "John Doe",
      }),
      age: z.number().openapi({
        example: 42,
      }),
    })
  );

  registry.registerPath({
    method: "get",
    path: "/users/{id}",
    description: "Get user data by its id",
    summary: "Get a single user",
    request: {
      params: z.object({ id: UserIdSchema }),
    },
    responses: {
      200: {
        mediaType: "application/json",
        schema: UserSchema.openapi({
          description: "Object with user data.",
        }),
      },
      204: z
        .void()
        .openapi({ description: "No content - successful operation" }),
    },
  });

  const generator = new OpenAPIGenerator(registry.definitions);

  return generator.generateDocument({
    openapi: "3.0.0",
    info: {
      version: "1.0.0",
      title: "My API",
      description: "This is the API",
    },
    servers: [{ url: "localhost:3000/api" }],
  });
}

export default (req: NextApiRequest, res: NextApiResponse) => {
  return new Promise<void>((resolve, reject) => {
    try {
      const openApiDocumentation = getOpenApiDocumentation();
      res.status(200).json(openApiDocumentation);
      resolve();
    } catch (e) {
      console.error(e);
      reject();
    }
    resolve();
  });
};

What am I doing wrong?

[georgyangelov]

@AGalabov If I don’t find a config change that helps this case the fallback fix would be to use error.constructor.name === 'ZodSomething' instead of error instanceof ZodSomething, which is a shame, but … well, JS…

[georgyangelov]

@nazarEnzo Should be fixed in v1.2.2, can you please confirm? Thank you for the report and the reproduction steps