Incorrect `$ref` for "referenced model"s

[mirismaili]

Consider the following example:

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

const app = new Elysia()
  .use(swagger())
  .model({score: t.Number()})
  .get('/scores', () => [5, 4, 9], {response: t.Array(t.Ref('score'))})

await app
  .handle(new Request('http://localhost/swagger/json'))
  .then(async (res) => console.log(res.status, JSON.stringify(await res.json(), null, 2)))

Then we'll see this output:

{
  "openapi": "3.0.3",
  "info": {
    "title": "Elysia Documentation",
    "description": "Development documentation",
    "version": "0.0.0"
  },
  "paths": {
    "/scores": {
      "get": {
        "responses": {
          "200": {
            "items": {
              "$ref": "score" // <<<---- THE BUG
            },
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/score"
                  }
                }
              },
              "multipart/form-data": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/score"
                  }
                }
              },
              "text/plain": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/score"
                  }
                }
              }
            }
          }
        },
        "operationId": "getScores"
      }
    }
  },
  "components": {
    "schemas": {
      "score": {
        "type": "number",
        "$id": "#/components/schemas/score"
      }
    }
  }
}

"$ref": "score" is an invalid $ref.

---

Additionally, I don't know why items property exists there? It seems it's unnecessary and can be omitted:

        "responses": {
          "200": {
-            "items": {
-              "$ref": "score"
-            },
            "content": {
               // ...
            }

Versions:

"elysia": "1.3.20"
"@elysiajs/swagger": "1.3.1"

Bun v1.2.20

[recanman]

Didn't look into your issue in-depth, but likely similar to #226. A PR is linked to it, you can apply that patch, and that may fix the issue.

[mirismaili]

The issue is a little different in @elysiajs/openapi v1.3.12:

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

const app = new Elysia()
  .use(openapi())
  .model({score: t.Number()})
  .get('/scores', () => [5, 4, 9], {response: t.Array(t.Ref('score'))})

await app
  .handle(new Request('http://localhost/openapi/json'))
  .then(async (res) => console.log(res.status, JSON.stringify(await res.json(), null, 2)))

And you'll see "$ref": "score" again:

 {
  "openapi": "3.0.3",
  "info": {
    "title": "Elysia Documentation",
    "description": "Development documentation",
    "version": "0.0.0"
  },
  "paths": {
    "/scores": {
      "get": {
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "score" // <<<---- THE BUG
                  }
                }
              }
            }
          }
        },
        "operationId": "getScores"
      }
    }
  },
  "components": {
    "schemas": {
      "score": {
        "type": "number",
        "$id": "#/components/schemas/score"
      }
    }
  }
}

[mirismaili]

Temporary patch:

import {OpenAPIV3} from 'openapi-types'

/** @see https://github.com/elysiajs/elysia-openapi/issues/232#issuecomment-3276227427 */
function patchInvalidRefs(spec: OpenAPIV3.Document) {
  return JSON.parse(
    JSON.stringify(spec)
      .replaceAll(/"\$ref":"[^"]+?",(?="content":)/g, '') // Remove misplaced `$ref`s
      .replaceAll(/(?<="\$ref":")(?!#)/g, '#/components/schemas/'), // Fix invalid `$ref`s
  )
}