search

Nexmo / nexmo-oas-renderer

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

Always render a collection's description and example. #48

Closed fabianrbz closed 4 years ago

fabianrbz commented 4 years ago

This removes the need of the x-nexmo-developer-collection-description-shown property in the api specifications, and treats collections as any other type.

Doesn't break backward compatibility and renders arrays for all the oas

mheap commented 4 years ago

Are there any existing OAS docs that don’t render collection descriptions and rely on this behaviour?

fabianrbz commented 4 years ago

I'm going through all of them, I should have opened a Draft PR

fabianrbz commented 4 years ago

@mheap should be ready now

mheap commented 4 years ago

@fabianrbz To confirm, this won't have any impact on existing OAS docs that previously didn't show the description?

mheap commented 4 years ago

@fabianrbz Ping

fabianrbz commented 4 years ago

Unfortunately we can't merge this. we have some docs that have a dummy description in them.

lornajane commented 4 years ago

Do you have examples of things in our specs that we shouldn't render? Should we fix the specs and then merge this?