Add metadata to flask_restx.Api call
larsnaesbye opened this issue · comments
Most of the metadata fields applicable to a Swagger definition can be set in the flask_restx.Api call. This would facilitate removal of step 6i from the conversion to OpenAPI as mentioned under release instructions.
The information could for example be loaded from a JSON file.
Which fields are relevant to fill out?
These (and maybe more) are used in the Swagger documentation and carry over to OpenAPI:
description ([str](https://docs.python.org/3/library/stdtypes.html#str)) – The API description (used in Swagger documentation)
terms_url ([str](https://docs.python.org/3/library/stdtypes.html#str)) – The API terms page URL (used in Swagger documentation)
contact ([str](https://docs.python.org/3/library/stdtypes.html#str)) – A contact email for the API (used in Swagger documentation)
license ([str](https://docs.python.org/3/library/stdtypes.html#str)) – The license associated to the API (used in Swagger documentation)
license_url ([str](https://docs.python.org/3/library/stdtypes.html#str)) – The license page URL (used in Swagger documentation)
Closed with #46