Schema added using fastify.addSchema is resulted as "def-#" in Swagger Models section

[velopert]

🐛 Bug Report

When I add schema by fastify.addSchema, the Model name is shown as def-# where # is index.

To Reproduce

Steps to reproduce the behavior:

const fastify = require('fastify')();

fastify.register(require('fastify-swagger'), {
  swagger: {
    info: {
      title: 'Test swagger',
      description: 'testing the fastify swagger api',
      version: '0.1.0',
    },
    host: 'localhost',
    schemes: ['http'],
    consumes: ['application/json'],
    produces: ['application/json'],
  },
  exposeRoute: true,
});

fastify.addSchema({
  $id: 'greetings',
  type: 'object',
  properties: {
    hello: { type: 'string' },
  },
});

fastify.put(
  '/some-route/:id',
  {
    schema: {
      description: 'post some data',
      tags: ['user'],
      summary: 'qwerty',
      params: {
        type: 'object',
        properties: {
          id: {
            type: 'string',
            description: 'user id',
          },
        },
      },
      response: {
        201: {
          description: 'Succesful response',
          type: 'object',
          properties: {
            greetings: { $ref: 'greetings#' },
          },
        },
      },
    },
  },
  (req, reply) => {}
);

fastify.listen(5000, (err) => {
  if (err) throw err;
  console.log('listening');
});

Expected behavior

The model names should be shown properly like following screenshot:

Your Environment

• node version: v12.15.0
• fastify version: ^3.2.1
• os: Mac
• "fastify-swagger": "^3.3.0"
• any other relevant information

[fox1t]

Would you mind to send a PR to address this issue?

[velopert]

I tried to fix the issue, however, my solution breaks the test code 😂.
I will send a PR when I get to fix the issue properly.

Thanks!

[ghost]

@velopert Are you making progress? I would be interested in this and I'd be willing to give a hand.

[ghost]

Upon further looking, I saw that this is caused by https://github.com/Eomm/json-schema-resolver (the example in the readme demonstrates this)

I think this issue should be closed and another one opened there.

@velopert @fox1t thoughts?

[IOsonoTAN]

Upon further looking, I saw that this is caused by https://github.com/Eomm/json-schema-resolver (the example in the readme demonstrates this)

I think this issue should be closed and another one opened there.

@velopert @fox1t thoughts?

I have already created PR there Eomm/json-schema-resolver#4

[Eomm]

As reviewed in the PR the issuer is more complex, I will support @IOsonoTAN to get a good solution.

I agree that we should cover this use case that should be 99% of the cases (not a fact, just an opinion)

[yantrab]

any news with this issue? when @IOsonoTAN PR's will be merged?

[CloudPower97]

As a temporary solution I managed to get everything to work as intended by forking fastify-swagger using the patched json-schema-resolver package, including the needed option showSchemaId set to true in fastify-swagger code itself.

For anyone who is not willing to wait for @IOsonoTAN PR to get merged by json-schema-resolver mantainer you can just

npm install git+https://github.com/CloudPower97/fastify-swagger.git\#feature/schema-id

[vglkannan]

Any news with this issue?

[mcollina]

cc @Eomm

[Eomm]

I know it but I didn't get the chance to work on it: it is on my todo list but I have other things to push forward before this one 😞

[Eomm]

Closing as superseded by #337