As a opendatahub api developer i want to show deprecated info metadata to our customers

[RudiThoeni]

Different possibilities

Add to openapi specification, openapi 3 allows to add deprecated attributes to methods and properties
This way Swagger shows it in the output. The information when at example the property is removed could be added as description parameter. It would look like this:

deprecated info is not shown in the example value

• standard openapi

• no api consumer will have a look at the swagger schema ;)

Show in each json Response which fields will be deprecated in future and add also additional information.
At example by adding an object "deprecatedInfo"

• every consumer sees it immediately in the response

• non standard solution

Add a Deprecated Endpoint to the api.
This Endpoint shows all info about which methods/properties are deprecated and additional info.
Maybe it could be easily done by parsing the openapi specification and showing it trough an api

• This solution could stand well in combination with 1