Swagger plugin does not render example for response of array

[itsyoboieltr]

Is this the intended behaviour? Arrays can be rendered as examples for the request body, however, for the response it always displays "no example available".

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

const arraySchema = t.Array(t.String());

const app = new Elysia()
  .use(swagger())
  .get('/', () => ['Hello Elysia'], {
    body: arraySchema,
    response: arraySchema,
  })
  .listen(3000);

console.log(
  `🦊 Elysia is running at ${app.server?.hostname}:${app.server?.port}`
);

The example response of an object is rendered correctly:

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

const arraySchema = t.Array(t.String());

const app = new Elysia()
  .use(swagger())
  .get('/', () => ({ test: 'Hello Elysia' }), {
    body: arraySchema,
    response: t.Object({ test: t.String() }),
  })
  .listen(3000);

console.log(
  `🦊 Elysia is running at ${app.server?.hostname}:${app.server?.port}`
);

[david-plugge]

Same issue here, it seems like the schema gets messed up.

{
    "/posts": {
        "get": {
            "responses": {
                "200": {
                    "items": {
                        "type": "object",
                        "properties": {
                            "id": {
                                "format": "uuid",
                                "type": "string"
                            }
                        },
                        "required": ["id"]
                    },
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "array"
                            }
                        }
                    }
                }
            },
            "operationId": "getPosts",
            "description": "Get all posts"
        }
    }
}

I think /posts.get.responses.200.items should live inside /posts.get.responses.200.content.application/json.schema:

{
    "/posts": {
        "get": {
            "responses": {
                "200": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "type": "array",
                                "items": {
                                    "type": "object",
                                    "properties": {
                                        "id": {
                                            "format": "uuid",
                                            "type": "string"
                                        }
                                    },
                                    "required": ["id"]
                                }
                            }
                        }
                    }
                }
            },
            "operationId": "getPosts",
            "description": "Get all posts"
        }
    }
}

[fecony]

You can add example of response like this:

const app = new Elysia()
  .use(swagger({}))
  .get('/', () => [1, 2, 3], {
    detail: {
      responses: {
        200: {
          description: 'get numbers',
          content: {
            'application/json': {
              example: [1, 2, 3],
            },
          },
        },
      },
    },
  })

[david-plugge]

Yeah, but the generated schema is still incorrect. Some clients depend on that schema for type generation or other stuff.

*Edit: my bad, it works. But it requires some additional work which i´d rather not do myself

[david-plugge]

elysiajs/elysia-swagger#8 (comment)

[SaltyAom]

Sorry for a late response, this is fixed on the latest version.

Thanks for your contribution.