Match new Webhooks OpenAPI Feature

Nexmo / nexmo-oas-renderer

Render your API references, Nexmo-style!

https://developer.nexmo.com/api

MIT License

45 stars 4 forks source link

Match new Webhooks OpenAPI Feature #46

Closed lornajane closed 4 years ago

lornajane commented 4 years ago

We use x-webhooks at the top level of our specs (see SMS spec), but the new feature that has been accepted into OpenAPI has a slightly different structure with webhooks at the top level and no URL entry. An example is here: https://github.com/OAI/OpenAPI-Specification/blob/61f9d7e2398dfb1c1211ca30af3a5331cd3863d2/examples/v3.1/webhook-example.yaml

lornajane commented 4 years ago

Ping @fabianrbz @mheap I know everyone is busy but is this something we could take a look at and figure out how much time we'd need to make this change? I think only the SMS spec actually uses this at the moment although I'd love to get other webhooks documented once we're updated. It looks like a simple syntax change (I can open the draft PR for SMS if that helps) but I don't know the internals so I don't want to assume it's as simple as it looks!!

mheap commented 4 years ago

Resolved in #65