proposal: package name change to elysiajs/openapi

[marclave]

Swagger is version 2.0 of OpenAPI, we should promote the OpenAPI standard :) especially since OpenAPI 4.0 is being released this year!

Wanted to open a discussion about renaming or potentially having a new package release with the OpenAPI name?

Thoughts? 🤔 @SaltyAom

[SaltyAom]

I support this change since Elysia the name Swagger is originally for plugin with Swagger, but now we are using Scalar and provide Swagger support as well which doesn't really reflect the name.

However, I have some other name in mind as well:

• elysia/doc
• elysia/documentation

I'm afraid that some people using swagger are not familiar with what OpenAPI is since many are new to backend and using Elysia as one of their first framework.

But I support moving out from Swagger name to reflect that as well, what do you think?

[marclave]

I support this change since Elysia the name Swagger is originally for plugin with Swagger, but now we are using Scalar and provide Swagger support as well which doesn't really reflect the name.

However, I have some other name in mind as well:

• elysia/doc
• elysia/documentation

I'm afraid that some people using swagger are not familiar with what OpenAPI is since many are new to backend and using Elysia as one of their first framework.

But I support moving out from Swagger name to reflect that as well, what do you think?

awesome! I saw your twitter poll too so im excited to see what the community has to say ✨

https://twitter.com/saltyAom/status/1783024458435092593

I think if we went for "doc" or "documentation" it might be thought as documentation for ElysiaJS vs documentation for the API youre building 🤔

OpenAPI covers both the scenario of docs + the spec generation. could do scalar also 🤔 but i think OpenAPI would be my first pick.

LiteStar conveys docs from OAS like so:
Litestar serves the documentation from the generated OpenAPI schema

what do you think @SaltyAom ? :-)