Skip to content

OpenAPI resolve-schema-reference searches #/definitions/, not #/components/schemas #836

@steveatkoan

Description

@steveatkoan

Prerequisites

  • I have written a descriptive issue title
  • I have searched existing issues to ensure the bug has not already been reported

Fastify version

5

Plugin version

5.1.0

Node.js version

22

Operating system

macOS

Operating system version (i.e. 20.04, 11.3, 10)

latest

Description

I see an error TypeError: Cannot read properties of undefined (reading 'Success') at resolveSchemaReference (.../node_modules/@fastify/swagger/lib/util/resolve-schema-reference.js:13:39)

The error occurs because https://github.com/fastify/fastify-swagger/blob/master/lib/util/resolve-schema-reference.js#L7 which assumes that a $ref will have format '#/definitions/SchemaName'.
But all my $refs are '#/components/schemas/SchemaName', so this line always fails with the above error. I could not see how to register '#/definitions'

May I suggest the following change?

  // const schemaId = resolvedReference?.$ref?.split('/', 3)[2]
  if (!resolvedReference) return undefined;
  const $ref = resolvedReference.$ref;
  const schemaId = $ref.startsWith('#/components') ? $ref.split('/', 3)[3] : $ref.split('/', 3)[2]

which fixes the problem for me. It may also fix #799

Expected Behavior

No error when rendering openapi 3 with zod and a custom transformer

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions