Tsoa: OpenAPI 3.1 support

[letmaik]

Sorting

• I'm submitting a ...

  • [ ] bug report
  • [x] feature request
  • [ ] support request

• I confirm that I

  • [x] used the search to make sure that a similar issue hasn't already been submit

Description

OpenAPI 3.1 is not released yet, but will be soon. It would be nice if tsoa gets 3.1 support eventually. This ticket should track any discussion and issues related to that.

[Tajnymag]

This issue should be kept indefinitely until OpenApi 3.1 is implemented. There's no reason to close it.

[WoH]

I'll reopen it, but the spec tsoa generates is OpenAPI 3.1 compatible.

[Tajnymag]

@WoH Yes, that's correct, the issue might be only tied to the config typing. At least that's why I came here.

What features are you missing, @letmaik?

[letmaik]

@Tajnymag I'm not missing features, but since there are breaking changes with OpenAPI 3.1 I thought it would be worth explicitly checking that tsoa is compatible. See https://github.com/OAI/OpenAPI-Specification/releases/tag/3.1.0-rc0.

An example is nullable which has been removed, and a quick search in tsoa turned up this:
https://github.com/lukeautry/tsoa/blob/c19d15d9cad1790544c4d5ace23c46bbad678548/packages/runtime/src/swagger/swagger.ts#L239-L241

[WoH]

Seems like this was changed, my last info was deprecated, not removed. I should revisit this, as it seems like OpenAPI decided drop SemVer to push out this as a 3.1.

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[Tajnymag]

(commenting to keep the issue open)

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[Tajnymag]

Shush, StaleBot! 😀

[github-actions[bot]]

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days

[mitar]

I would also love it tsoa could generate a 3.1 version without using anything deprecated. Having proper JSON schema is great. Ideally, those JSON schema definitions could be extracted out into a separate document to be used stand-alone as well.

[WoH]

Feel free to submit a PR :)