Nexmo / nexmo-oas-renderer

Render your API references, Nexmo-style!
https://developer.nexmo.com/api
MIT License
45 stars 4 forks source link

Show which fields are deprecated #87

Closed lornajane closed 3 years ago

lornajane commented 3 years ago

In OpenAPI, parameters can be marked as deprecated (http://spec.openapis.org/oas/v3.0.3.html#fixed-fields-9).

We have this in a few places (such as https://github.com/Nexmo/api-specification/blob/master/definitions/numbers.yml#L502) but the documentation renderer doesn't show that the field is deprecated, we just have it in the copy. See screenshots for an example, and for how other tools (this one is redoc) might show it. Can we add support for showing which parameters are deprecated in this tool too?

numbers-redoc numbers-nexmo