microsoft / typespec

https://typespec.io/
MIT License
4.53k stars 220 forks source link

tsp-openapi3 - warn when encountering unsupported OpenAPI features #3834

Open Arithmomaniac opened 4 months ago

Arithmomaniac commented 4 months ago

Clear and concise description of the problem

When an OpenAPI file has a field that is unsupported by TypeSpec (as indicated in the docs), warn during the compilation process.

For example, the examples field is used extensively in the Sefaria API. Running tsp-openapi3 should log a warning message for each examples field encountered (until, of course, #2700 is implemented.)

Checklist

Arithmomaniac commented 4 months ago

On the flop side, it should also warn when OpenAPI features are missing too, like operationId, but perhaps that should be addressed in a separate issue.

markcowl commented 4 months ago

est: 3