Invalid spec is generated using Elysia.Ref

[Zakhar2093]

The generator adds $id and $ref to the spec which are not allowed there. There is a similar issue. I hoped 1.3.0 would fix this, but the issue is still present no matter what I use for reference t.Ref() or Elysia.Ref()

the code:

import swagger from '@elysiajs/swagger'
import { Elysia, t } from 'elysia'

export const User = new Elysia()
  .model('user', t.Object({
    id: t.String(),
    firstName: t.String(),
    lastName: t.String(),
  }))

export const GetUserSchema = {
  response: {
    200: { ...User.Ref('user'), description: 'ok' },
    404: t.String({ description: 'User not found' }),
  },
}

new Elysia()
  .use(swagger())
  .use(User)
  .get('user/', () => {
    return { id: '1', firstName: 'John', lastName: 'Doe' }
  }, { ...GetUserSchema, parse: ['application/json'] })
  .listen(3001)

The generated invalid schema:

{
  "openapi": "3.0.3",
  "info": {
    "title": "Elysia Documentation",
    "description": "Development documentation",
    "version": "0.0.0"
  },
  "paths": {
    "/user/": {
      "get": {
        "responses": {
          "200": {
            "$ref": "user", // this should not be here. When I try to generate a client, the client ignores the response types 
            "description": "ok",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/user",
                  "description": "ok"
                }
              }
            }
          },
          "404": {
            "description": "User not found",
            "content": {
              "application/json": {
                "schema": {
                  "description": "User not found",
                  "type": "string"
                }
              }
            }
          }
        },
        "operationId": "getUser"
      }
    }
  },
  "components": {
    "schemas": {
      "user": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "firstName": {
            "type": "string"
          },
          "lastName": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "firstName",
          "lastName"
        ],
        "$id": "#/components/schemas/user"  // this is couse error. It should not be here 
      }
    }
  }
}

You could use swagger validator to check if there is no errors

[Zakhar2093]

workaround which I don't proud of

export const swaggerConfig = new Elysia()
  .use(swagger({ exclude: ['/swagger/spec'] }))
  .get('/swagger/spec', async () => {
    const response = await fetch(`http://localhost:${ENV.PORT}/swagger/json`)
    const data = await response.json()
    return cleanOpenApiRefs(data)
  })

export function cleanOpenApiRefs(openApi) {
  const cloned = structuredClone(openApi)

  for (const pathKey in cloned.paths) {
    const path = cloned.paths[pathKey]
    for (const methodKey in path) {
      const method = path[methodKey]
      const responses = method.responses

      if (responses) {
        for (const statusCode in responses) {
          const response = responses[statusCode]
          delete response.$ref
        }
      }
    }
  }
  for (const schemaKey in cloned.components.schemas) {
    const schema = cloned.components.schemas[schemaKey]
    delete schema.$id
  }

  return cloned
}

[mikkelam]

Generating spec compliant openapi.json is really crucial for a lot of people.

@SaltyAom would you review/accept PRs to help bridge this gap?