Breaking Changes:
This is our third release in the (currently beta) v3 branch of tsoa. All of the v3 releases so far have included breaking changes, so please read the v3.0.1 and v3.0.0 release notes as well.
1) Improve nested object validation
2) Change default behavior when no host is defined:
Explicitly set your host in case you want to have absolute urls. This is a breaking change for those who were using OpenAPI 3, but it actually brings tsoa into parity with how we were handling the host property in Swagger 2. Previously OpenAPI 3 users had to result to passing null which we all felt was strange. Now omitting host will cause tsoa to assume the url should be relative.
3) Remove .. in fieldErrors (145222a):
When detecting illegal additional properties (if you are using tsoa setting additionalProperties: 'throw-on-extras'), the key on the error would contain an additional dot.
{
"TestModel..additionalProp: : {
...
}
}This is now fixed and the key is TestModel.additionalProp.
4) Change naming (| from %7C -> ~OR~, & from ~AND to ~AND~)
SwaggerUI has troubles parsing percent encoded URLs that confirm to the OpenAPI standard.
In order to mitigate issues, we changed some of the names.
Example: Pick<Model, 'one' | 'two'> not generates this name in the Spec: Pick_Model.one~OR~two_
We hope this avoids issues and conveniently improves legibility.
Features:
- Unknown type, ported to 3.x: #559
Bugfix:
- Fix OpenAPI3 QueryArrays, ported to 3.x #564