tornado-swagger icon indicating copy to clipboard operation
tornado-swagger copied to clipboard

remove schemes and basePath for OAS3.0 and use servers instead

Open GassnerMichael opened this issue 1 year ago • 2 comments

As OpenAPI Specification 3.0 does not support schemes and basePath any longer, I removed them from the generate_doc function and instead added the supported servers.

GassnerMichael avatar May 05 '23 10:05 GassnerMichael

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

sonarqubecloud[bot] avatar May 05 '23 13:05 sonarqubecloud[bot]

That PR makes sense. basePath and schemes are not supported anymore and replaced by the server-object: https://swagger.io/specification/#server-object

Currently you can't upgrade to OAS 3.0 if you use basePath. Additionally the swagger-validator (https://validator.swagger.io/) will fail with the generated 3.0 files.

Jan-Brugger avatar May 11 '23 08:05 Jan-Brugger