feat(swagger): skip websocket routes

[rozzilla]

Skip routes when websocket: true

[mcollina]

There are a lot of spurious changes - I think from prettier.

[mcollina]

lgtm

[gurgunday]

lgtm

[Uzlopak]

I somehow wonder, why the websocket Attribute is so special. Are you setting it manually? Or is it because a Plugin is setting it?

[rozzilla]

I somehow wonder, why the websocket Attribute is so special. Are you setting it manually? Or is it because a Plugin is setting it?

@Uzlopak it comes from fastify-websocket

[Uzlopak]

Can we consider implementing it differently?

Maybe creating a Symbol. Like Symbol.for("@fastify/swagger-hideRoute")?

And in fastify websocket we set the route additionally to websocket true also that Symbol to true. And then we have a generic way to hide Routes. Without implementing for every possible plugin an exception. Also with that Symbol.for we loosely "bind" the plugins.

I would prefer this tbh..

[Uzlopak]

@mcollina

What do you think about my proposal?

[mcollina]

We already have the known hide: true property as documented in the README. If you prefer that could be automatically added in https://github.com/fastify/fastify-websocket/blob/d6348f0c04a73fb27c932d842168a894ea075cca/index.js#L155.

[rozzilla]

We already have the known hide: true property as documented in the README. If you prefer that could be automatically added in https://github.com/fastify/fastify-websocket/blob/d6348f0c04a73fb27c932d842168a894ea075cca/index.js#L155.

@mcollina @Uzlopak here is the PR

[rozzilla]

Since this has been merged, should I close the current PR? cc @mcollina @Uzlopak